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

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)

Enable OPDS catalogValkey page cache (recommended for large libraries)

File manager (optional)

Grimoire mounts your library read-only. Add a companion tool to upload and manage files.

NoneManage files manually via SSH, SFTP, or your OSFilebrowser QuantumLightweight browser-based file manager (port 8080)CalibreFull 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:ro
      - /path/to/grimoire/data:/data

Compose Generator ​