For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.
Docker
Verified Code examples on this page have been automatically tested and verified.Run agentgateway as a Docker container
Run agentgateway as a Docker container for local development or small deployments.
Quick start
Get started in under a minute with your preferred LLM provider.
# Set your API key
export OPENAI_API_KEY=your-api-key
# Create config for OpenAI
cat <<'EOF' > config.yaml
# yaml-language-server: $schema=https://agentgateway.dev/schema/config
llm:
models:
- name: "*"
provider: openAI
params:
apiKey: $OPENAI_API_KEY
EOF
# Run agentgateway
docker run -v "$PWD/config.yaml:/config.yaml" -p 3000:3000 \
-e OPENAI_API_KEY=$OPENAI_API_KEY \
cr.agentgateway.dev/agentgateway:v0.0.0-latest-dev -f /config.yaml
# Test with a chat completion
curl http://localhost:3000/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"Hello!"}]}'Access the Admin UI
By default, the agentgateway admin UI listens on localhost. To access it from your host machine:
docker run -v "$PWD/config.yaml:/config.yaml" -p 3000:3000 \
-p 127.0.0.1:15000:15000 -e ADMIN_ADDR=0.0.0.0:15000 \
-e OPENAI_API_KEY=$OPENAI_API_KEY \
cr.agentgateway.dev/agentgateway:v0.0.0-latest-dev -f /config.yamlThen open http://localhost:15000/ui/ in your browser.
Docker Compose
For more complex setups, use Docker Compose:
services:
agentgateway:
container_name: agentgateway
restart: unless-stopped
image: cr.agentgateway.dev/agentgateway:v0.0.0-latest-dev
ports:
- "3000:3000"
- "127.0.0.1:15000:15000"
volumes:
- ./config.yaml:/config.yaml
environment:
- ADMIN_ADDR=0.0.0.0:15000
- OPENAI_API_KEY=${OPENAI_API_KEY}
command: ["-f", "/config.yaml"]Run with:
docker compose up -d