OpenViking/docker-compose.yml at main · MDNDDD/OpenViking · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
version: "3.8"

# Set OPENVIKING_PUBLIC_BASE_URL in a `.env` file next to this compose file
# when you need public HTTPS (OAuth, MCP clients on the internet).
#
#   .env example for local-only (leave unset or empty):
#     # no .env needed — just `docker compose up -d`
#
#   .env example for public HTTPS:
#     OPENVIKING_PUBLIC_BASE_URL=https://ov.your-domain.com
#     OV_ACME_EMAIL=admin@your-domain.com
#
# See docs/en/guides/12-public-access.md for the full walkthrough.

services:
  openviking:
    image: ghcr.io/volcengine/openviking:latest
    container_name: openviking
    # Direct access (optional — caddy:1934 is the recommended single entry
    # point). Comment this out once Caddy is your only ingress.
    ports:
      - "1933:1933"
    volumes:
      - ~/.openviking:/app/.openviking
    environment:
      OPENVIKING_PUBLIC_BASE_URL: ${OPENVIKING_PUBLIC_BASE_URL:-}
    healthcheck:
      test: ["CMD-SHELL", "curl -fsS http://127.0.0.1:1933/health || exit 1"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 30s
    restart: unless-stopped

  # Aggregated reverse proxy — fronts OV (1933) on port 1934 under one stable
  # origin. Always enabled, plain HTTP by default.
  #
  # For public HTTPS: edit the Caddyfile to add a domain block, set
  # OPENVIKING_PUBLIC_BASE_URL in .env, uncomment the 80/443 port lines
  # below, and add the caddy volumes at the bottom.
  caddy:
    image: caddy:2
    container_name: openviking-caddy
    restart: unless-stopped
    ports:
      - "1934:1934"
      # Uncomment for public HTTPS (after adding a domain block to Caddyfile):
      # - "80:80"
      # - "443:443"
    volumes:
      - ./Caddyfile:/etc/caddy/Caddyfile:ro
      # Uncomment for public HTTPS (Caddy stores certs here):
      # - caddy_data:/data
      # - caddy_config:/config
    environment:
      OPENVIKING_PUBLIC_BASE_URL: ${OPENVIKING_PUBLIC_BASE_URL:-}
      OV_ACME_EMAIL: ${OV_ACME_EMAIL:-}
    depends_on:
      - openviking

# Uncomment for public HTTPS:
# volumes:
#   caddy_data:
#   caddy_config: