Warp/deploy/compose/docker-compose.yml

# Warp with PostgreSQL, and optionally Prometheus, Grafana and Jaeger.
#
#   cd deploy/compose
#   WARP_SERVER_NAME=matrix.example.org docker compose up -d
#   docker compose --profile observability up -d     # with the dashboards
#
# The homeserver listens on http://localhost:8008. Put a TLS-terminating
# reverse proxy in front of it before pointing a domain at it; see
# docs/deployment.md. With the observability profile, Grafana is on
# http://localhost:3000 (admin / admin, change it), Prometheus on :9090 and
# the Jaeger UI on :16686. With the admin profile, the admin panel is on
# http://localhost:8009.
#
# Create the first administrator once the server is up:
#
#   docker compose exec warp warp create-account --username admin --admin

name: warp

services:
  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_USER: warp
      POSTGRES_PASSWORD: ${WARP_POSTGRES_PASSWORD:-warp}
      POSTGRES_DB: warp
      # The encoding and collation a Matrix server's text wants: C sorts by
      # byte, which is what room and event IDs are compared by.
      POSTGRES_INITDB_ARGS: --encoding=UTF8 --lc-collate=C --lc-ctype=C
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U warp -d warp"]
      interval: 5s
      timeout: 5s
      retries: 20

  warp:
    build:
      context: ../..
      dockerfile: Dockerfile
    image: warp:latest
    restart: unless-stopped
    depends_on:
      postgres:
        condition: service_healthy
    # The signing key is created on first start and kept in the volume:
    # losing it means other servers no longer recognise this one.
    entrypoint: ["/bin/sh", "-c"]
    command:
      - test -f /data/signing.key || warp generate-keys --output /data/signing.key; exec warp serve
    environment:
      WARP_SERVER_NAME: ${WARP_SERVER_NAME:-localhost}
      WARP_WELL_KNOWN_CLIENT_BASE_URL: ${WARP_PUBLIC_BASEURL:-http://localhost:8008}
      WARP_DB_DRIVER: postgres
      WARP_DB_CONNECTION_STRING: postgres://warp:${WARP_POSTGRES_PASSWORD:-warp}@postgres:5432/warp?sslmode=disable
      WARP_REGISTRATION_ENABLED: ${WARP_REGISTRATION_ENABLED:-false}
      WARP_FEDERATION_ENABLED: ${WARP_FEDERATION_ENABLED:-false}
      WARP_TRACING_ENABLED: ${WARP_TRACING_ENABLED:-false}
      WARP_TRACING_ENDPOINT: http://jaeger:4318
    volumes:
      - warp-data:/data
    ports:
      - "8008:8008"

  # The admin panel is optional. Start it with the admin profile:
  #   docker compose --profile admin up -d
  # It is on http://localhost:8009 and reaches the homeserver over the
  # compose network, so /_warp/admin never has to be public.
  admin:
    build:
      context: ../..
      dockerfile: apps/admin/Dockerfile
    image: warp-admin:latest
    profiles: [admin]
    restart: unless-stopped
    depends_on:
      - warp
    environment:
      WARP_ADMIN_HOMESERVER: http://warp:8008
    ports:
      - "${WARP_ADMIN_PORT:-8009}:8009"

  prometheus:
    image: prom/prometheus:v3.5.0
    profiles: [observability]
    restart: unless-stopped
    command:
      - --config.file=/etc/prometheus/prometheus.yml
      - --storage.tsdb.retention.time=15d
    volumes:
      - ./prometheus.yml:/etc/prometheus/prometheus.yml:ro
      - prometheus-data:/prometheus
    ports:
      - "9090:9090"

  grafana:
    image: grafana/grafana:12.1.0
    profiles: [observability]
    restart: unless-stopped
    environment:
      GF_SECURITY_ADMIN_PASSWORD: ${GRAFANA_ADMIN_PASSWORD:-admin}
      GF_AUTH_ANONYMOUS_ENABLED: "false"
    volumes:
      - ./grafana/provisioning:/etc/grafana/provisioning:ro
      - ../grafana:/var/lib/grafana/dashboards/warp:ro
      - grafana-data:/var/lib/grafana
    ports:
      - "3000:3000"

  # Turn on WARP_TRACING_ENABLED=true to send traces here.
  jaeger:
    image: jaegertracing/jaeger:2.8.0
    profiles: [observability]
    restart: unless-stopped
    ports:
      - "16686:16686"

volumes:
  postgres-data:
  warp-data:
  prometheus-data:
  grafana-data: