Note
This project is in early development. Some links (website, documentation, demo, repositories) are not yet active and will come online as infrastructure is set up.
Note
Grimmory is the successor of booklore.
Grimmory is a self-hosted application for managing your entire book collection in one place. Organize, read, annotate, sync across devices, and share without relying on third-party services.
Website | Documentation | Quick Start | Discord
| Feature | Description |
|---|---|
| Smart Shelves | Custom and dynamic shelves with rule-based filtering, tagging, and full-text search |
| Metadata Lookup | Covers, descriptions, reviews, and ratings pulled from Google Books, Open Library, and Amazon, all editable |
| Built-in Reader | Read PDFs, EPUBs, and comics in the browser with annotations, highlights, and reading progress tracking |
| Device Sync | Connect a Kobo, use any OPDS-compatible app, or sync progress with KOReader |
| Multi-User | Separate shelves, progress, and preferences per user with local or OIDC authentication |
| BookDrop | Drop files into a watched folder and Grimmory detects, enriches, and queues them for import automatically |
| One-Click Sharing | Send any book to a Kindle, an email address, or another user directly from the interface |
| Category | Formats |
|---|---|
| eBooks | EPUB, MOBI, AZW, AZW3 |
| Documents | |
| Comics | CBZ, CBR, CB7 |
Tip
For OIDC setup, advanced configuration, or upgrade guides, see the full documentation.
Requirements: Docker and Docker Compose.
Image Repositories
| Registry | Image |
|---|---|
| Docker Hub | grimmory/grimmory |
| GitHub Container Registry | ghcr.io/grimmory-tools/grimmory |
Create a .env file:
# Application
APP_USER_ID=1000
APP_GROUP_ID=1000
TZ=Etc/UTC
# Database
DATABASE_URL=jdbc:mariadb://mariadb:3306/grimmory
DB_USER=grimmory
DB_PASSWORD=ChangeMe_Grimmory_2025!
# Storage: LOCAL (default) or NETWORK (disables file operations; see Network Storage section)
DISK_TYPE=LOCAL
# MariaDB
DB_USER_ID=1000
DB_GROUP_ID=1000
MYSQL_ROOT_PASSWORD=ChangeMe_MariaDBRoot_2025!
MYSQL_DATABASE=grimmoryCreate a docker-compose.yml:
services:
grimmory:
image: grimmory/grimmory:latest
# Alternative: ghcr.io/grimmory-tools/grimmory:latest
# To build from source instead: comment out 'image' and uncomment below
# build: .
container_name: grimmory
environment:
- USER_ID=${APP_USER_ID}
- GROUP_ID=${APP_GROUP_ID}
- TZ=${TZ}
- DATABASE_URL=${DATABASE_URL}
- DATABASE_USERNAME=${DB_USER}
- DATABASE_PASSWORD=${DB_PASSWORD}
depends_on:
mariadb:
condition: service_healthy
ports:
- "6060:6060"
volumes:
- ./data:/app/data
- ./books:/books
- ./bookdrop:/bookdrop
healthcheck:
test: wget -q -O - http://localhost:6060/api/v1/healthcheck
interval: 60s
retries: 5
start_period: 60s
timeout: 10s
restart: unless-stopped
mariadb:
image: lscr.io/linuxserver/mariadb:11.4.5
container_name: mariadb
environment:
- PUID=${DB_USER_ID}
- PGID=${DB_GROUP_ID}
- TZ=${TZ}
- MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
- MYSQL_DATABASE=${MYSQL_DATABASE}
- MYSQL_USER=${DB_USER}
- MYSQL_PASSWORD=${DB_PASSWORD}
volumes:
- ./mariadb/config:/config
restart: unless-stopped
healthcheck:
test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
interval: 5s
timeout: 5s
retries: 10docker compose up -dOpen http://localhost:6060, create your admin account, and start building your library.
Drop book files into a watched folder. Grimmory picks them up, pulls metadata, and queues them for your review.
graph LR
A[Drop Files] --> B[Auto-Detect]
B --> C[Extract Metadata]
C --> D[Review and Import]
| Step | What Happens |
|---|---|
| 1. Watch | Grimmory monitors the BookDrop folder continuously |
| 2. Detect | New files are picked up and parsed automatically |
| 3. Enrich | Metadata is fetched from Google Books and Open Library |
| 4. Import | You review, adjust if needed, and add to your library |
Mount the volume in docker-compose.yml:
volumes:
- ./bookdrop:/bookdropSet DISK_TYPE=NETWORK in your .env to run Grimmory against a network-mounted file system (NFS, SMB, etc.).
In this mode, direct file operations (delete, move, rename from the UI) are disabled to avoid destructive changes on shared mounts.
All other features — reading, metadata, sync — remain fully functional.
| Channel | |
|---|---|
| Report a bug | Open an issue |
| Request a feature | Open an issue |
| Contribute | Contributing Guide |
| Join the discussion | Discord Server |
Warning
Before opening a pull request, open an issue first and get maintainer approval. Pull requests without a linked issue, without screenshots or video proof, or without pasted test output will be closed. All code must follow the project backend and frontend conventions. AI-assisted contributions are welcome, but you must run, test, and understand every line you submit. See the Contributing Guide for full details.
Distributed under the terms of the LICENSE file in this repository.