Compose Generator

Configure your deployment below and download a ready-to-use compose file. All logic runs in your browser; nothing is sent to a server.

Container runtime

Docker Composedocker-compose.ymlPodman Composepodman-compose.yml (compatible with docker compose)Podman QuadletsSystemd .container unit files (recommended for rootless Podman)

Grimoire image

Image tag

Host port

Workers

Slim image (smaller, no Tesseract / OCR — uses the -slim tag)

Resolved image: hunterreadca/grimoire:latest

Volume paths

Library path (host path to your TTRPG library folder)

Data path (host path for database, thumbnails, cache)

Secret key

Used to sign JWT tokens. Must be a long random string; keep it private.

Optional settings

Base URL (set this when running behind a reverse proxy; used for OPDS and OIDC redirect URIs)

Log level

Enable OPDS catalogValkey page cache (recommended for large libraries)

Authentication (optional)

These pin auth behaviour via environment variables, overriding the in-app toggles (which then show read-only). Leave them alone to manage everything from Settings → Authentication in the app.

Enable guest access (per-campaign invite codes for players without accounts)

Password authentication

OCR (scanned / image-only PDFs)

Scanned PDFs with no text layer are run through OCR in the background so they become searchable. Bundled with the default image; omitted from -slim tags.

DefaultOCR on with built-in defaults (English, 1 book at a time, 150 DPI)Customize…Set languages, parallelism, and render resolutionDisabledTurn OCR off (scanned PDFs stay unindexed)

Library access

A writable library mount lets admins upload, move, rename, and delete files from inside Grimoire, and lets it export metadata sidecars. Uncheck it to mount the library :ro — everything else works the same, and those two features are hidden.

Writable library (in-app file management and sidecar export)

Companion tools (optional)

Grimoire manages library files itself. Add Calibre alongside it for ebook conversion and bulk metadata editing.

NoneGrimoire only — manage files in-app or from your OSCalibreFull Calibre desktop via noVNC: metadata editing + OPF export (port 8080)Calibre-WebLightweight browser UI for an existing Calibre library (port 8083)

docker-compose.yml

services:
  grimoire:
    image: hunterreadca/grimoire:latest
    container_name: grimoire
    restart: unless-stopped
    ports:
      - "9481:9481"
    environment:
      - LIBRARY_PATH=/library
      - DATA_PATH=/data
      - WORKERS=2
      - SECRET_KEY=change-me
    volumes:
      - /path/to/your/library:/library
      - /path/to/grimoire/data:/data

Compose Generator ​