Configuration¶

services:
  core:
    image: ghcr.io/holomush/holomush:latest
    command: ["core", "--grpc-addr=0.0.0.0:9000"]
    environment:
      DATABASE_URL: postgres://holomush:${POSTGRES_PASSWORD}@postgres:5432/holomush?sslmode=disable
      HOME: /home/holomush

volumes:
  - holomush_config:/home/holomush/.config/holomush
  - postgres_data:/var/lib/postgresql/data

# Core process configuration.
# Equivalent to flags on: holomush core
core:
  # gRPC listen address — gateway connects here.
  # Flag: --grpc-addr
  # Default: "localhost:9000"
  grpc_addr: "localhost:9000"

  # Control plane mTLS address for admin operations.
  # Flag: --control-addr
  # Default: "127.0.0.1:9001"
  control_addr: "127.0.0.1:9001"

  # Metrics and health HTTP endpoint.
  # Set to empty string to disable.
  # Flag: --metrics-addr
  # Default: "127.0.0.1:9100"
  metrics_addr: "127.0.0.1:9100"

  # Data directory for persistent runtime files.
  # Empty string uses XDG_DATA_HOME/holomush (~/.local/share/holomush).
  # Flag: --data-dir
  # Default: "" (XDG_DATA_HOME/holomush)
  data_dir: ""

  # Unique identifier for this game instance.
  # Empty string triggers auto-generation on first start.
  # Flag: --game-id
  # Default: "" (auto-generated)
  game_id: ""

  # Log output format.
  # "json" for production/log aggregation, "text" for human-readable output.
  # Flag: --log-format
  # Default: "json"
  log_format: "json"

  # Disable automatic seed policy upgrades on startup.
  # Flag: --skip-seed-migrations
  # Default: false
  skip_seed_migrations: false

# Gateway process configuration.
# Equivalent to flags on: holomush gateway
gateway:
  # Telnet server listen address.
  # Flag: --telnet-addr
  # Default: ":4201"
  telnet_addr: ":4201"

  # Core gRPC server address to connect to.
  # Flag: --core-addr
  # Default: "localhost:9000"
  core_addr: "localhost:9000"

  # Control plane mTLS address for admin operations.
  # Flag: --control-addr
  # Default: "127.0.0.1:9002"
  control_addr: "127.0.0.1:9002"

  # Metrics and health HTTP endpoint.
  # Set to empty string to disable.
  # Flag: --metrics-addr
  # Default: "127.0.0.1:9101"
  metrics_addr: "127.0.0.1:9101"

  # Log output format.
  # "json" for production/log aggregation, "text" for human-readable output.
  # Flag: --log-format
  # Default: "json"
  log_format: "json"

  # Web client HTTP server listen address.
  # Serves the ConnectRPC API and embedded SvelteKit static files.
  # Flag: --web-addr
  # Default: ":8080"
  web_addr: ":8080"

  # Override embedded static files with a filesystem directory.
  # When set, serves files from this directory instead of the embedded
  # SvelteKit build. Useful for deploying custom builds without
  # recompiling the binary.
  # Flag: --web-dir
  # Default: "" (use embedded files)
  web_dir: ""

  # Allowed CORS origins for cross-origin requests.
  # Required for development when the Vite dev server (localhost:5173)
  # makes requests to the gateway (localhost:8080).
  # Default: [] (same-origin only — no CORS headers added)
  # Flag: --cors-origins
  cors_origins: []
  # Example for development:
  # cors_origins:
  #   - "http://localhost:5173"

# Game world configuration.
game:
  # ULID of the starting location assigned to guest connections.
  # Config file only — no CLI flag equivalent.
  # Default: "01HK153X0006AFVGQT61FPQX3S" (The Nexus seed location)
  guest_start_location: "01JMHZ5H3ZSBVTGARX4MSS1MBH"

# Status command configuration.
# Equivalent to flags on: holomush status
status:
  # Core control address to query for health information.
  # Flag: --core-addr
  # Default: "127.0.0.1:9001"
  core_addr: "127.0.0.1:9001"

  # Gateway control address to query for health information.
  # Flag: --gateway-addr
  # Default: "127.0.0.1:9002"
  gateway_addr: "127.0.0.1:9002"

  # Output status as JSON instead of human-readable text.
  # Flag: --json
  # Default: false
  json: false