abs-kosync-bridge/docker-compose.example.yml at main · Piste/abs-kosync-bridge · 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
# ABS-KoSync Enhanced - Example Docker Compose Configuration
#
# Copy this file to docker-compose.yml and fill in your values.
# See README.md for detailed configuration instructions.

services:
  abs-kosync:
    container_name: abs_kosync
    image: ghcr.io/cporcellijr/abs-kosync-bridge:latest

    # Optional: Build locally if you need specific modifications or GPU libraries included
    # build:
    #   context: .
    #   args:
    #     # Set to "true" to download NVIDIA CUDA libraries (adds ~800MB to image)
    #     INSTALL_GPU: "false"
    restart: unless-stopped

    ports:
      - "8080:5757"   # Admin Dashboard (keep private to LAN or reverse proxy)
      # - "5758:5758" # Optional: expose the sync-only port when using KOSYNC_PORT=5758

    environment:
      # ============================================
      # General Settings
      - TZ=America/New_York
      - LOG_LEVEL=INFO
      # - KOSYNC_PORT=5758 # Optional: enable split-port mode

      # === OPTIONAL: Initial Configuration ===
      # It is recommended to configure these in the Web UI, but you can bootstrap them here.

      # Audiobookshelf
      # - ABS_SERVER=http://your-abs-server:13378
      # - ABS_KEY=your-api-token
      # - ABS_LIBRARY_ID=your-library-id
      # - ABS_ONLY_SEARCH_IN_ABS_LIBRARY_ID=false # Or set this directly to a library ID

      # Integrations
      # - KOSYNC_SERVER=https://koreader.example.com
      # - BOOKLORE_SERVER=http://grimmory.example.com
      # - STORYTELLER_API_URL=http://storyteller.example.com
      # - STORYTELLER_ASSETS_DIR=/storyteller
      # Configure ABS, KOSync, Grimmory, Storyteller, and other services in the Web UI.

      # CWA (Calibre-Web Automated) - For syncing ebooks without local files
      # - CWA_ENABLED=true
      # - CWA_SERVER=http://calibre-web.example.com/opds
      # - CWA_USERNAME=user
      # - CWA_PASSWORD=pass

      # Authoritative ABS↔ebook mapping via Calibre identifiers (audiobookshelf_id).
      # When enabled, library suggestion scans bypass fuzzy matching for any Calibre
      # book whose audiobookshelf_id matches the ABS libraryItemId.
      # - CALIBRE_USE_ABS_IDENTIFIER=true
      # - CALIBRE_LIBRARY_PATH=/calibre-library

    volumes:
      # === REQUIRED ===
      - ./data:/data                    # App data (database, cache)
      - /path/to/ebooks:/books          # Your EPUB library (Required unless using CWA/Grimmory exclusively)

      # === OPTIONAL: Forge (Storyteller) ===
      # Forge uploads directly over the Storyteller API.
      # - /path/to/storyteller/library:/storyteller_library # Optional: local fallback/download access
      # - /path/to/storyteller/assets:/storyteller/assets   # Optional: transcript ingest

      # === OPTIONAL: Calibre library (for CALIBRE_USE_ABS_IDENTIFIER) ===
      # Mount read-only to allow direct metadata.db lookups.
      # - /path/to/calibre-library:/calibre-library:ro

    networks:
      - your-network
    # ============================================
    # GPU SUPPORT (OPTIONAL)
    # ============================================
    # Uncomment below to enable NVIDIA GPU acceleration for Whisper.
    # Requires: docker with nvidia-container-toolkit installed.
    # See: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html
    #
    # deploy:
    #   resources:
    #     reservations:
    #       devices:
    #         - driver: nvidia
    #           count: 1
    #           capabilities: [gpu]

networks:
  your-network:
    external: true