OpenScanner/docker-compose.yml at main · revtex/OpenScanner · 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
services:
  openscanner:
    image: ghcr.io/revtex/openscanner:dev
    # build: .  # uncomment to build locally instead
    ports:
      - "3022:3022"
      # - "3443:3443"  # HTTPS — uncomment with SSL_LISTEN below
    volumes:
      - ./data:/data
    environment:
      ## Core
      - OPENSCANNER_DB_FILE=/data/openscanner.db
      - OPENSCANNER_RECORDINGS_DIR=/data/recordings
      - OPENSCANNER_LISTEN=0.0.0.0:3022
      - TZ=America/New_York
      # - OPENSCANNER_TIMEZONE=America/New_York  # overrides TZ for OpenScanner only

      ## TLS / HTTPS (pick one option)
      # Option A — your own certificate:
      # - OPENSCANNER_SSL_LISTEN=0.0.0.0:3443
      # - OPENSCANNER_SSL_CERT=/data/tls/cert.pem
      # - OPENSCANNER_SSL_KEY=/data/tls/key.pem
      # Option B — automatic Let's Encrypt:
      # - OPENSCANNER_SSL_AUTO_CERT=scanner.example.com

      ## Secrets encryption (AES-256-GCM) — recommended
      # Put the key in a .env file next to this docker-compose.yml:
      #   echo "OPENSCANNER_ENCRYPTION_KEY=$(openssl rand -hex 32)" > .env
      #   chmod 600 .env
      # Compose auto-loads .env and substitutes ${OPENSCANNER_ENCRYPTION_KEY}.
      # Remember to add .env to .gitignore.
      - OPENSCANNER_ENCRYPTION_KEY=${OPENSCANNER_ENCRYPTION_KEY:-}

      ## Admin password reset (remove after first startup)
      # - OPENSCANNER_ADMIN_PASSWORD=new-password
    healthcheck:
      test: ["CMD", "wget", "-qO-", "http://localhost:3022/api/health"]
      interval: 30s
      timeout: 5s
      start_period: 10s
      retries: 3
    restart: unless-stopped

  # Transcription sidecar (go-whisper).
  # Set transcriptionEnabled=true and transcriptionUrl=http://whisper:8081
  # in OpenScanner admin settings.
  #
  # Default: CPU-only (most compatible). See GPU examples below.
  whisper:
    image: ghcr.io/mutablelogic/go-whisper
    volumes:
      - whisper-data:/data
    environment:
      - GOWHISPER_DIR=/data
      - GOWHISPER_ADDR=0.0.0.0:8081
    command: ["run"]
    restart: unless-stopped

  # # --- Intel iGPU (UHD 630, Arc, etc.) — Vulkan/OpenCL via /dev/dri ---
  # # NOTE: Vulkan backend may crash with "vk::DeviceLostError" on some drivers.
  # # If you see repeated crashes, use the CPU-only config above instead.
  # # Verify GIDs on your host:  stat -c '%g' /dev/dri/render* /dev/dri/card*
  # whisper:
  #   image: ghcr.io/mutablelogic/go-whisper
  #   volumes:
  #     - whisper-data:/data
  #   devices:
  #     - /dev/dri:/dev/dri
  #   group_add:
  #     - "110"   # render — adjust to match your host GID
  #     - "44"    # video  — adjust to match your host GID
  #   environment:
  #     - GOWHISPER_DIR=/data
  #     - GOWHISPER_ADDR=0.0.0.0:8081
  #   command: ["run"]
  #   restart: unless-stopped

  # # --- NVIDIA GPU example ---
  # whisper:
  #   image: ghcr.io/mutablelogic/go-whisper-cuda
  #   volumes:
  #     - whisper-data:/data
  #   environment:
  #     - GOWHISPER_DIR=/data
  #     - GOWHISPER_ADDR=0.0.0.0:8081
  #   command: ["run"]
  #   deploy:
  #     resources:
  #       reservations:
  #         devices:
  #           - driver: nvidia
  #             count: 1
  #             capabilities: [gpu]
  #   restart: unless-stopped

  # # --- AMD GPU example (ROCm) ---
  # whisper:
  #   image: ghcr.io/mutablelogic/go-whisper
  #   volumes:
  #     - whisper-data:/data
  #   devices:
  #     - /dev/kfd:/dev/kfd
  #     - /dev/dri:/dev/dri
  #   group_add:
  #     - "render"
  #     - "video"
  #   environment:
  #     - GOWHISPER_DIR=/data
  #     - GOWHISPER_ADDR=0.0.0.0:8081
  #   command: ["run"]
  #   restart: unless-stopped

volumes:
  whisper-data: