📖 Installation Guide

API Gateway Proxy
Installation Guide

Complete installation documentation for every deployment scenario. From local development to production Kubernetes clusters, we've got you covered with detailed setup instructions and troubleshooting guides.

🐳 Docker

☸️ Kubernetes

☁️ Cloud

🖥️ Bare Metal

View Methods Requirements

Installation Methods

Choose your preferred deployment method

Docker

Kubernetes

Cloud

Bare Metal

Docker Installation

The fastest way to get started with Docker. Pull the official image and run with a single command. Docker provides isolation and consistency across different environments, making it ideal for development and production deployments.

                        Pull & Run
                        Bash
                    

# Pull the latest image
docker pull ai-gateway/proxy:latest

# Run with basic configuration
docker run -d \
  --name ai-gateway \
  -p 3000:3000 \
  -e OPENAI_API_KEY=sk-your-key \
  -e ANTHROPIC_API_KEY=sk-ant-your-key \
  ai-gateway/proxy:latest

# Verify the container is running
docker ps | grep ai-gateway

# View logs
docker logs -f ai-gateway

                        Docker Compose
                        YAML
                    

version: '3.8'

services:
  gateway:
    image: ai-gateway/proxy:latest
    ports:
      - "3000:3000"
    environment:
      - OPENAI_API_KEY=${OPENAI_API_KEY}
      - ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY}
    volumes:
      - ./config:/app/config
    restart: unless-stopped

System Requirements

Minimum and recommended specifications

💻

CPU

2 cores minimum
4 cores recommended

🧠

Memory

4GB minimum
8GB recommended

💾

Storage

10GB minimum
50GB recommended

🌐

Network

Stable internet
HTTPS required

API Gateway ProxyInstallation Guide