Self-host Grimmory on a VPS

Organize, read, annotate, and sync your entire book collection from one place.

levelrail-cli templates deploy grimmory --name my-grimmory

Specification

Status
Listed
Category
Media
Services
db, grimmory
Ports
80
Volumes
3
Memory
about 512 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About Grimmory

Organize, read, annotate, and sync your entire book collection from one place. Runs 2 containers (db, grimmory), with grimmory listening on port 80; data is kept in named volumes.

What it deploys

Grimmory runs as 2 services in a single Compose app, listening on port 80, with 3 named volume mounts.

ServiceImageTagPortsVolumes
db mariadb 11 none grimmory_db_data -> /var/lib/mysql
grimmory grimmory/grimmory nightly-20260403-3a371f7 80 grimmory_data -> /app/datagrimmory_books -> /books

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 80 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 5 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbMARIADB_DATABASEPreset by the template
dbMARIADB_PASSWORDGenerated at deploy
dbMARIADB_ROOT_PASSWORDGenerated at deploy
dbMARIADB_USERGenerated at deploy
grimmoryDATABASE_PASSWORDGenerated at deploy
grimmoryDATABASE_URLPreset by the template
grimmoryDATABASE_USERNAMEGenerated at deploy

Install Grimmory on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get grimmory
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy grimmory --name my-grimmory

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Grimmory.

More in Media

All Media templates