Skip to main content
System requirements, prerequisites, and dependencies needed to run Guardway Gateway.

​
System Requirements

Development Environment

  • CPU: 2 cores minimum
  • RAM: 4GB minimum
  • Disk: 2GB available space
  • Network: Standard internet connection

Production Environment

  • CPU: 4 cores minimum (8+ recommended)
  • RAM: 8GB minimum (16GB+ recommended)
  • Disk: 100GB available space (for logs, Redis persistence)
  • Network: 1Gbps network interface recommended
  • Outbound HTTPS (443) access to LLM provider APIs
  • Inbound access on port 8000 (gateway) and 3000 (admin UI)

​
Software Requirements

​
Required

1

Install Node.js (Version 20.0.0 or higher)

node --version  # Should show v20.x.x or higher
2

Install pnpm (Version 9.0.0 or higher)

npm install -g pnpm@latest
pnpm --version  # Should show 9.x.x or higher
3

Install Docker (Version 24.0.0 or higher, with Compose v2)

docker --version
docker compose version

​
Optional

1

Install Redis (Version 7.0 or higher -- optional for development, required for production)

redis-cli --version
2

Install PostgreSQL (Version 15 or higher -- for persistent storage)

psql --version

​
API Keys

To use Guardway Gateway, you’ll need API keys for at least one LLM provider:

​
Network Requirements

​
Outbound Access

The gateway needs outbound HTTPS (port 443) access to:
  • LLM provider APIs (OpenAI, Anthropic, etc.)
  • Package registries (npm, Docker Hub) during build
  • Optional: External monitoring/logging services

​
Inbound Access

  • Port 8000: Gateway API endpoint
  • Port 3000: Admin UI (optional)
  • Internal network for Redis/PostgreSQL communication

​
Security Requirements

​
Container Runtime

Ensure your container runtime supports the following security features:
  • Docker with user namespace remapping support
  • Capability dropping support
  • Read-only filesystem support

​
Secrets Management

At minimum, you’ll need to securely store:
  • LLM provider API keys
  • Master key for gateway administration
  • Configuration encryption key
  • Database credentials (if using PostgreSQL)
Consider using a dedicated secrets management solution:
  • Docker secrets
  • Kubernetes secrets
  • Cloud provider secret managers (AWS Secrets Manager, Azure Key Vault, GCP Secret Manager)
  • HashiCorp Vault

​
Platform-Specific Requirements

  • Kubernetes 1.24+
  • kubectl configured
  • Cluster with at least 3 worker nodes (for HA)
  • Ingress controller (nginx, traefik, etc.)
  • Persistent volume support

​
Development Tools (Optional)

For contributing or advanced development:
  • Git: Version control
  • Make: Build automation
  • jq: JSON processing for scripts
  • curl: API testing
  • Postman/Insomnia: API client for testing