hunterreadca/grimoire repository overview

⁠Grimoire - Self-Hosted TTRPG Library Manager

Website⁠ · Documentation⁠ · Live Demo⁠ · Join our Discord⁠

A Docker-based web application for managing your tabletop RPG PDF collection. Browse, search, and read your entire library from any device with a clean, responsive UI.

⁠Docker Image Tags

Images are published to Docker Hub⁠. Pull with:

docker pull hunterreadca/grimoire:<tag>

Every release is published under several tags so you can choose how tightly to pin. Given a release v1.4.2, the same image is pushed as 1.4.2, 1.4, and 1, and latest is moved to point at it:

The version parts follow semantic versioning: the major (X) bumps for breaking changes, the minor (X.Y) for new features, and the patch (X.Y.Z) for bug fixes. Pick based on how much you want automatic updates: latest/X for "keep me current," X.Y for "new features are fine but no breaking changes," X.Y.Z to freeze exactly.

⁠Edge builds

The edge tag is built on demand from in-progress work, not on a schedule and not from a branch that has necessarily passed review. It exists to get a specific change onto a real deployment quickly.

What that means for you:

• No cadence. It may be rebuilt several times in a day, or sit untouched for weeks. A stale edge is not a signal that anything is wrong, and a fresh one is not a signal that anything is ready.
• No continuity between pulls. Two edge images days apart can contain unrelated work, and the newer one may not contain what the older one did. Features can appear, change shape, or disappear again.
• Expect breakage. It can carry half-finished features, debug output, schema changes still being iterated on, or bugs that never reach nightly.
• Unsupported. Bug reports against edge are hard to act on, since the exact image may no longer exist. Please reproduce on nightly or a release tag first.

⁠Slim variant (no OCR)

The default image bundles the Tesseract⁠ OCR engine so scanned/image-only PDFs become searchable. If you don't need OCR, the slim image drops it for a smaller download and footprint.

Each release tag above has a matching slim tag with a -slim suffix, plus a plain slim tag that tracks the latest stable slim release (the slim equivalent of latest):

docker pull hunterreadca/grimoire:slim

There are no nightly-slim or edge-slim tags - both are only published as the full (OCR) image. Dropping Tesseract saves only ~20 MB now, which isn't worth doubling those build times; the slim variant remains available on release tags.

⁠Supported Architectures

Docker automatically pulls the correct image for your platform.

⁠Quick Start

docker run -d \
 --name grimoire \
 -p 9481:9481 \
 -v /path/to/library:/library \
 -v /path/to/data:/data \
  hunterreadca/grimoire:latest

Then open http://localhost:9481⁠.

See the documentation⁠ for full configuration, environment variables, and docker-compose examples.

⁠License

GNU General Public License v3.0