Self-host Grimmory with Levelrail
Organize, read, annotate, and sync your entire book collection from one place.
- Authorgrimmory-tools
- LicenceAGPL-3.0
- Memory512 MiB
- Archarm64
- Services2
How to self-host Grimmory
-
Pull the images
2 images are pulled on your server.
Show images
mariadb:11grimmory/grimmory:nightly-20260403-3a371f7
-
Create the app
2 services start in a single Compose app, with 3 named volume mounts for your data, on port 80.
-
Fill in the secrets
5 secrets are generated and stored encrypted, 2 settings are preset, you do not have to fill in anything.
-
Open it
Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.
Grimmory requirements
- Memory
- About 512 MiB
- Architectures
- amd64 image published, arm64 image published
- Ports
- 80
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- AGPL-3.0, network copyleft (agpl) license
- Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
- Host ports. It publishes port 80 on the host, so open them in the VPS firewall only if you want that.
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Grimmory. New to Levelrail? Install it on a fresh VPS first.
docker pull ghcr.io/glincker/levelrail:latest Then levelrail-cli login --device. See Getting started and the Grimmory docs page.
Deploy Grimmory your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy Grimmory from the CLI
levelrail-cli templates deploy grimmory --name my-grimmory Deploy Grimmory with the API
curl -X POST -H "Authorization: Bearer $TOKEN" \
https://levelrail.example.com/api/v1/service-templates/grimmory/deploy Grimmory configuration
Grimmory services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| db | mariadb:11 | none | grimmory_db_data -> /var/lib/mysql |
| grimmory | grimmory/grimmory:nightly-20260403-3a371f7 | 80 | grimmory_data -> /app/datagrimmory_books -> /books |
Grimmory environment variables
| Variable | Service | Value |
|---|---|---|
| MARIADB_DATABASE | db | Preset by the template |
| MARIADB_PASSWORD | db | Generated at deploy |
| MARIADB_ROOT_PASSWORD | db | Generated at deploy |
| MARIADB_USER | db | Generated at deploy |
| DATABASE_PASSWORD | grimmory | Generated at deploy |
| DATABASE_URL | grimmory | Preset by the template |
| DATABASE_USERNAME | grimmory | Generated at deploy |
Ports and volumes
- Ports
- 80
- Volumes
- 3 named mounts: grimmory_db_data -> /var/lib/mysql, grimmory_data -> /app/data, grimmory_books -> /books
Grimmory FAQ
How much memory does Grimmory need?
The catalog lists about 512 MiB of memory for Grimmory across its 2 services.
Does Grimmory run on arm64?
For Grimmory, an arm64 image is published; amd64 is image published.
What licence is Grimmory under?
Grimmory is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.
Does Grimmory need configuration before it starts?
No. The template fills in its own defaults and generates secrets at deploy time.
Which database does Grimmory bundle?
The template includes MySQL, running as its own service.
Which ports does Grimmory use?
Grimmory listens on port 80 inside the stack.
Where does Grimmory keep its data?
In named volumes: grimmory_db_data mounted at /var/lib/mysql, grimmory_data mounted at /app/data and grimmory_books mounted at /books.
Can I deploy Grimmory on Dokploy or Dokku?
The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Grimmory, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image mariadb:11, grimmory/grimmory:nightly-20260403-3a371f7 is what you deploy there.