# Self-host Grimmory

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

- Page: https://levelrail.com/templates/grimmory/
- JSON: https://levelrail.com/templates/grimmory.json
- Category: Media
- Licence: AGPL-3.0 (Network copyleft (AGPL) license)
- Source: https://github.com/grimmory-tools/grimmory
- Upstream docs: https://github.com/grimmory-tools/grimmory

## Requirements
- Memory: about 512 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 11

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| db | mariadb | 11 | none | grimmory_db_data -> /var/lib/mysql |
| grimmory | grimmory/grimmory | nightly-20260403-3a371f7 | 80 | grimmory_data -> /app/data; grimmory_books -> /books |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| db | MARIADB_DATABASE | preset |
| db | MARIADB_PASSWORD | generated |
| db | MARIADB_ROOT_PASSWORD | generated |
| db | MARIADB_USER | generated |
| grimmory | DATABASE_PASSWORD | generated |
| grimmory | DATABASE_URL | preset |
| grimmory | DATABASE_USERNAME | generated |

## Deploy

### CLI

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

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/grimmory/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### 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.

Self-host Grimmory, Grimmory docker compose file, deploy Grimmory on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
