Grimmory

Self-hosted multi-user digital library with OIDC auth, OPDS catalog, Kobo/KOReader sync, and BookDrop auto-import. Docs: grimmory.org

• URL: https://{subdomain}.{domain}
• Port: 6060 (internal)
• Data: /srv/books (library, grimmory_library_path), /srv/grimmory (covers, thumbnails, BookDrop staging), /srv/bookdrop (auto-import drop)

Deploy

auberge deploy grimmory

Tip

The JAR is built by this repo, not upstream. Before deploying a new version.value in grimmory.meta.yml, add the upstream tarball’s sha256 to .github/grimmory-tarballs.sha256, then run gh workflow run build-grimmory.yml -f version=<version>. CI and auberge deploy grimmory both refuse a pin whose grimmory/v<version> release lacks a non-empty grimmory-api.jar. Renovate does not bump grimmory, so once the release exists run .github/scripts/recompute-checksums.sh origin/master to rewrite grimmory_jar_sha256; the deploy refuses a jar that does not match it.

Required config

Key	Purpose
grimmory_db_password	MariaDB password

Notes

Backed up by default (book library + app data + metadata database). See Backup & Restore.

Grimmory stores the library root as a row in its own database, not in a config file ansible writes, so the role’s grimmory_library_path is a declaration nothing on the host enforces. The Backup Recipe’s attests: query reads that row back on every backup create and fails when it names a path no declared path holds — see ADR-0033. Re-pointing the library in the UI therefore requires the same edit in defaults/main.yml and grimmory.meta.yml.