Deploy with Docker

To run agentgateway as a Docker container, agentgateway publishes official Docker images at cr.agentgateway.dev/agentgateway.

Before you begin, create a configuration file for agentgateway. In this example, config.yaml is used. You might start with this simple example configuration file.

Docker

To run agentgateway with Docker, mount your configuration file into the container and expose any necessary ports.

docker run -v ./config.yaml:/config.yaml -p 3000:3000 \
  cr.agentgateway.dev/agentgateway:0.12.0 \
  -f /config.yaml

By default, the agentgateway admin UI listens on localhost, which is not exposed outside of the container. To access the UI, you can change the bind address and expose the port.

docker run -v ./config.yaml:/config.yaml -p 3000:3000 \
  -p 127.0.0.1:15000:15000 -e ADMIN_ADDR=0.0.0.0:15000 \
  cr.agentgateway.dev/agentgateway:0.12.0 \
  -f /config.yaml

Docker Compose

To run agentgateway in Docker Compose, follow a similar approach to mount the configuration file and expose the ports.

services:
  agentgateway:
    container_name: agentgateway
    restart: unless-stopped
    image: cr.agentgateway.dev/agentgateway::0.12.0
    ports:
      - "3000:3000"
      - "127.0.0.1:15000:15000"
    volumes:
      - ./config.yaml:/config.yaml
    environment:
      - ADMIN_ADDR=0.0.0.0:15000
    command: ["-f", "/config.yaml"]