grimoire/docs/docker/docker-compose.calibre.yml at main · hunter-read/grimoire · 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
# Grimoire + Calibre (full desktop)
#
# Runs the full Calibre desktop application via a browser-accessible noVNC
# interface (LinuxServer.io image). Use it to manage your book collection,
# edit metadata, and export OPF sidecar files that Grimoire reads on rescan.
#
# Ports:
#   8080 — Calibre desktop (noVNC, browser-based GUI)
#   8081 — Calibre Content Server (lightweight web book browser)
#   9481 — Grimoire
#
# Usage:
#   docker compose -f docs/docker/docker-compose.calibre.yml up -d
#
# First run: open http://localhost:8080, set Calibre's library path to
#   /library/books (or a system subfolder). Calibre will write metadata.opf
#   and cover.jpg alongside each book. After editing metadata, trigger a
#   rescan in Grimoire to pick up the changes.
#
# See docs/file-management.md for OPF metadata details.

services:
  grimoire:
    image: hunterreadca/grimoire:latest
    container_name: grimoire
    restart: unless-stopped
    ports:
      - "9481:9481"
    environment:
      - LIBRARY_PATH=/library
      - DATA_PATH=/data
      - WORKERS=1
      # Optional — JWT signing key. Leave unset and Grimoire generates one and
      # persists it under DATA_PATH. Set it explicitly (openssl rand -hex 32)
      # if you run multiple replicas that do not share DATA_PATH.
      # - SECRET_KEY=
    volumes:
      # Writable so you can manage files from inside Grimoire. Append ":ro" to
      # keep the library read-only (in-app file management and sidecar export
      # are then unavailable; everything else works the same).
      - /path/to/your/library:/library
      - /path/to/grimoire/data:/data
    networks:
      - grimoire

  calibre:
    image: lscr.io/linuxserver/calibre:latest
    container_name: grimoire-calibre
    restart: unless-stopped
    environment:
      - PUID=1000
      - PGID=1000
      # Set to your local timezone — see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
      - TZ=America/New_York
    ports:
      - "8080:8080"   # Calibre desktop (noVNC)
      - "8081:8081"   # Calibre Content Server
    volumes:
      # Read-write so Calibre can write metadata.opf and cover.jpg files
      - /path/to/your/library:/library
      - calibre_config:/config
    networks:
      - grimoire

volumes:
  calibre_config:

networks:
  grimoire: