Configuring Docker services

Deployment files

Create a deployment directory and save both of the following files in it. The files work together: Docker Compose reads the environment values from .env when it starts the services.

`docker-compose.yml`

services:
  db:
    image: mysql:8.0
    env_file:
      - .env
    environment:
      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
      MYSQL_DATABASE: ${DB_NAME}
      MYSQL_TCP_PORT: ${DB_PORT}
      MYSQL_USER: ${DB_USER}
      MYSQL_PASSWORD: ${DB_PASSWORD}
    ports:
      - ${DB_PORT}:${DB_PORT}
    volumes:
      - mysql_data:/var/lib/mysql

  redis:
    image: redis:7
    command:
      - redis-server
      - --port
      - "${REDIS_PORT}"
      - --protected-mode
      - "no"
    ports:
      - ${REDIS_PORT}:${REDIS_PORT}
    restart: unless-stopped

  app-migrations:
    image: docker.io/relaiai/backend:${RELAI_BACKEND_SERVICE_VERSION}
    pull_policy: missing
    restart: on-failure
    env_file:
      - .env
    command: sh -c "/project/.venv/bin/python manage.py migrate"
    depends_on:
      db:
        condition: service_started

  init-commands:
    image: docker.io/relaiai/backend:${RELAI_BACKEND_SERVICE_VERSION}
    pull_policy: missing
    restart: on-failure
    env_file:
      - .env
    command: sh -c "/project/.venv/bin/python manage.py init_commands"
    depends_on:
      db:
        condition: service_started
      app-migrations:
        condition: service_completed_successfully

  app:
    image: docker.io/relaiai/backend:${RELAI_BACKEND_SERVICE_VERSION}
    pull_policy: missing
    restart: unless-stopped
    env_file:
      - .env
    environment:
      UVICORN_WORKERS: ${ONPREM_WEB_WORKERS:-3}
      UVICORN_LOG_LEVEL: ${UVICORN_LOG_LEVEL:-info}
    command: sh -c "/project/.venv/bin/python manage.py collectstatic --noinput && exec /project/.venv/bin/uvicorn goatweb.asgi:application --host 0.0.0.0 --port 8889 --workers $${UVICORN_WORKERS} --log-level $${UVICORN_LOG_LEVEL} --timeout-keep-alive 300 --proxy-headers"
    ports:
      - 8889:8889
    volumes:
      - onprem_local_storage:${LOCAL_STORAGE_ROOT:-/var/lib/relai/local_storage}
      - ${GCP_VERTEX_KEY_PATH:-/dev/null}:/run/secrets/gcp-vertex.json:ro
    depends_on:
      db:
        condition: service_started
      redis:
        condition: service_started
      app-migrations:
        condition: service_completed_successfully
      init-commands:
        condition: service_completed_successfully

  celery-worker:
    image: docker.io/relaiai/backend:${RELAI_BACKEND_SERVICE_VERSION}
    pull_policy: missing
    restart: unless-stopped
    env_file:
      - .env
    environment:
      HOME: /var/lib/relai/celery-home
      CELERY_HOME: /var/lib/relai/celery-home
      XDG_CACHE_HOME: /var/lib/relai/celery-home/.cache
      XDG_CONFIG_HOME: /var/lib/relai/celery-home/.config
      XDG_DATA_HOME: /var/lib/relai/celery-home/.local/share
      LOCAL_STORAGE_ROOT: ${LOCAL_STORAGE_ROOT:-/var/lib/relai/local_storage}
      MEDIA_ROOT: ${MEDIA_ROOT:-/var/lib/relai/local_storage/media}
    command:
      - sh
      - -c
      - |
        mkdir -p "$${HOME}" "$${XDG_CACHE_HOME}" "$${XDG_CONFIG_HOME}" "$${XDG_DATA_HOME}" "$${LOCAL_STORAGE_ROOT}" "$${MEDIA_ROOT}"
        chown -R "$${CELERY_UID:-nobody}:$${CELERY_GID:-nogroup}" "$${HOME}"
        chown "$${CELERY_UID:-nobody}:$${CELERY_GID:-nogroup}" "$${LOCAL_STORAGE_ROOT}" "$${MEDIA_ROOT}"
        exec /project/.venv/bin/celery -A goatweb.goatweb_celery worker --loglevel=info --concurrency 32 --uid="$${CELERY_UID:-nobody}" --gid="$${CELERY_GID:-nogroup}"
    depends_on:
      app:
        condition: service_started
      db:
        condition: service_started
      redis:
        condition: service_started
    extra_hosts:
      - "host.docker.internal:host-gateway"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - onprem_local_storage:${LOCAL_STORAGE_ROOT:-/var/lib/relai/local_storage}
      - ${GCP_VERTEX_KEY_PATH:-/dev/null}:/run/secrets/gcp-vertex.json:ro

  dashboard:
    image: relaiai/dashboard:${RELAI_DASHBOARD_VERSION}
    pull_policy: missing
    ports:
      - "5173:80"
    environment:
      SERVER_BASE_URL: ${SERVER_BASE_URL}
    depends_on:
      app:
        condition: service_started
    restart: unless-stopped

volumes:
  mysql_data:
  onprem_local_storage:

`.env.template`

# Core backend settings
RELAI_DEPLOYMENT_MODE="ON_PREM"
LANDING_PAGE_URL="http://localhost:5173"

# Service versions
RELAI_BACKEND_SERVICE_VERSION="..."  # Required
RELAI_DASHBOARD_VERSION="..."  # Required

# Database
DB_NAME="relai"
DB_USER="relai"
DB_PASSWORD="..."  # Required
DB_HOST="db"
DB_PORT="3306"

# Redis
REDIS_HOST="redis"
REDIS_PORT="6379"

# Backend local storage
LOCAL_STORAGE_ROOT="/var/lib/relai/local_storage"
MEDIA_ROOT="/var/lib/relai/local_storage/media"
CHATS_BACKEND="local"
CHATS_LOCAL_DIR="/var/lib/relai/local_storage/chats"

# Backend runtime keys
OPENAI_API_KEY="..."    # Required to power the continual learning engine (default provider; see https://self-hosted-docs.relai.ai/configure-model-provider for alternatives)
SECRET_KEY = "..."  # Required

# Bootstrap admin user
SUPERUSER_EMAIL="..."  # Required
SUPERUSER_USERNAME="..."  # Required
SUPERUSER_PASSWORD="..."  # Required
ADMIN_DASHBOARD_URL_HASH="..."  # Required

# On-prem organization bootstrap
ON_PREM_ORGANIZATION_ID="..."  # Required
ON_PREM_ORGANIZATION_NAME="On-Prem Organization"

# Usage ingestion
RELAI_USAGE_INGEST_URL="..." # Optional (For sending usage data to Relai)
RELAI_USAGE_INGEST_TOKEN="..." # Optional (For sending usage data to Relai)

# Feature flags
SEND_TO_RELAI="False" # Optional (For sending usage data to Relai)
RELAI_ENABLE_TRACING="False"
RELAI_STORE_SFT_SAMPLES="False"
RELAI_ENABLE_FINETUNING="False"

# Backend server tuning
ONPREM_WEB_WORKERS="3" # Optional (Uvicorn worker count for the app server)
UVICORN_LOG_LEVEL="info" # Optional
CELERY_UID="nobody" # Optional (User the celery worker drops privileges to)
CELERY_GID="nogroup" # Optional

# Vertex AI Claude (only required if using Vertex AI as a model provider; see https://self-hosted-docs.relai.ai/configure-model-provider)
GCP_VERTEX_KEY_PATH="" # Optional (Host path to the GCP service-account JSON key)

# Dashboard
SERVER_BASE_URL="http://localhost:8889"

# Docker Hub credentials
DOCKER_HUB_USERNAME="relaiai"
DOCKER_HUB_TOKEN="..."

Create your `.env` file

Copy the template

Create your deployment-specific configuration file:

cp .env.template .env

Fill in the required values

Open .env and set every variable marked # Required below. Everything else has a sensible default and can be left as-is to start.

Do not edit .env.template after copying it; keep it as a reference and make all deployment-specific changes in .env.

Never commit .env, and never paste real values from it into a shared document, ticket, or chat. It holds live secrets for your deployment.

Required values

Variable	What it is
`RELAI_BACKEND_SERVICE_VERSION` / `RELAI_DASHBOARD_VERSION`	The exact backend and dashboard image versions to deploy. RELAI will tell you which versions to use — don’t guess, and don’t use `latest`. See Upgrading for how to move to a new version later.
`DB_PASSWORD`	Password for the MySQL user and root account. Choose a strong value.
`OPENAI_API_KEY`	Required only when OpenAI is the selected generation or optimizer provider. See Configure model provider for Azure OpenAI, Bedrock, Anthropic, Foundry, and Vertex configuration.
`SECRET_KEY`	Django’s cryptographic signing key. Generate one: `openssl rand -hex 32`
`SUPERUSER_EMAIL` / `SUPERUSER_USERNAME` / `SUPERUSER_PASSWORD`	Credentials for the admin account that’s bootstrapped on first startup.
`ADMIN_DASHBOARD_URL_HASH`	A random path segment that obscures the Django Admin URL. Generate one: `openssl rand -hex 16`
`ON_PREM_ORGANIZATION_ID`	A stable identifier for your organization. A UUID works well: `uuidgen`

Other settings you can leave at their defaults

.env.template groups the rest of the variables by area — adjust them if you need to, otherwise the defaults are fine for a first deployment:

Database / Redis — connection details for the bundled db and redis containers (DB_NAME, DB_USER, DB_HOST, DB_PORT, REDIS_HOST, REDIS_PORT).
Backend local storage — where uploaded media and chat data are stored inside the container (LOCAL_STORAGE_ROOT, MEDIA_ROOT, CHATS_BACKEND, CHATS_LOCAL_DIR).
On-prem organization bootstrap — ON_PREM_ORGANIZATION_NAME, the organization name your users will see.
Usage ingestion / feature flags — optional integrations (RELAI_USAGE_INGEST_URL, RELAI_USAGE_INGEST_TOKEN, SEND_TO_RELAI, RELAI_ENABLE_TRACING, RELAI_STORE_SFT_SAMPLES, RELAI_ENABLE_FINETUNING). Leave these off unless RELAI has instructed you to turn them on.
Backend server tuning — ONPREM_WEB_WORKERS (Uvicorn worker count), UVICORN_LOG_LEVEL.
Dashboard — SERVER_BASE_URL, the URL the dashboard uses to reach the backend. Update this if you put a reverse proxy or a different hostname in front of the backend.
Docker Hub credentials — DOCKER_HUB_USERNAME, DOCKER_HUB_TOKEN, see Pulling the images.

​Deployment files

​docker-compose.yml

​.env.template

​Create your .env file

​Required values

​Other settings you can leave at their defaults

Deployment files

`docker-compose.yml`

`.env.template`

Create your `.env` file

Required values

Other settings you can leave at their defaults