Open-Source DevOps · grimmory-tools

grimmory

Grimmory is a self-hosted digital library application for managing ebooks, PDFs, comics, and audiobooks with built-in reading, metadata enrichment, and multi-user support. Written in Java with Spring Boot and Angular, it supports EPUB, MOBI, AZW3, PDF, CBZ/CBR formats and integrates with Kobo devices and OPDS clients.

Talk to DEV.co Discuss Implementation

Source: GitHub — github.com/grimmory-tools/grimmory

3.7k

GitHub stars

258

Forks

Java

Primary language

AGPL-3.0

License (OSI-approved)

Key facts

Objective fields from the source. Values we can't verify are shown as “Unknown” rather than guessed.

Field	Value
Repository	grimmory-tools/grimmory
Owner	grimmory-tools
Primary language	Java
License	AGPL-3.0 — OSI-approved
Stars	3.7k
Forks	258
Open issues	161
Latest release	v3.2.4 (2026-07-01)
Last updated	2026-07-08
Source	https://github.com/grimmory-tools/grimmory

What grimmory is

Spring Boot backend with MariaDB persistence, Angular frontend, and Docker Compose deployment. Supports OIDC authentication, metadata APIs (Google Books, Open Library, Amazon), file watching (BookDrop), and OPDS protocol for device sync. Published as OCI container images on Docker Hub and GHCR.

Quickstart

Get the grimmory source

Clone the repository and explore it locally.

terminalbash

1git clone https://github.com/grimmory-tools/grimmory.git2cd grimmory3# follow the project's README for install & configuration

Need it deployed, integrated, or customized instead? DEV.co ships production installs.

Best use cases

Self-hosted personal and household digital library

Manage large collections of ebooks, comics, and documents with custom shelving, full-text search, and per-user progress tracking without cloud dependency.

Metadata enrichment and curation workflow

Automatically pull covers, descriptions, and ratings from multiple sources, then manually edit and refine before adding to library—useful for book clubs or curated collections.

Device sync and reader ecosystem

Bridge multiple reading devices (Kobo, KOReader, OPDS apps) and share books to Kindle or email directly from the interface with unified progress tracking.

Implementation considerations

Database setup: MariaDB 11.4+ required; use provided docker-compose.yml as starting point. Booklore users can migrate by retaining container name, database, and volumes, then swapping the image tag.
Storage: Default is local filesystem (LOCAL); NETWORK mode disables destructive file operations on NFS/SMB mounts but preserves reading and sync features.
Authentication: Supports local user creation or OIDC (details in docs). Separate shelves and progress per user; configure OIDC endpoint and credentials in environment.
Metadata sources: Google Books, Open Library, Amazon APIs called at runtime. Ensure outbound HTTPS access and handle rate limits or API changes.
File import: BookDrop folder monitoring requires read/write permissions; configure via volume mount. Auto-extraction and metadata enrichment happens in-process.

When to avoid it — and what to weigh

Licensing concern with AGPL-3.0 copyleft requirements — If you plan to distribute modified versions or run it as a network service without disclosing source or offering download rights, AGPL-3.0 requirements must be reviewed with legal counsel first.
Enterprise or proprietary integration requirements — Organizations requiring closed-source modifications, proprietary plugins, or commercial licensing terms should not proceed without explicit license negotiation (not offered in the data).
Large-scale commercial library or retail platform — Grimmory targets personal and small-group self-hosted use. Scaling to thousands of users or as a public service carries both technical (no horizontal scaling hints) and legal risk under AGPL.
Minimal dependency or offline-first requirements — Requires Docker, MariaDB, persistent storage, and network connectivity for metadata lookups. Not suitable for air-gapped or ultra-lightweight deployments.

License & commercial use

AGPL-3.0 (GNU Affero General Public License v3.0). Copyleft license requiring source disclosure and offer to provide source code to users when software is distributed or run as a network service. Modifications and derivative works must also be AGPL-3.0 licensed.

AGPL-3.0 does not prohibit commercial use per se, but imposes strict conditions: if run as a network service (SaaS) or distributed to customers, you must offer source code and license under AGPL-3.0. Internal-only deployment is permissible. Any proprietary modifications or closed-source resale require legal review and likely license negotiation with maintainers. No explicit commercial license, dual licensing, or enterprise exemption mentioned in provided data.

DEV.co evaluation signals

Editorial assessment — not user reviews. Directional, with an explicit confidence level.

Signal	Assessment
Maintenance	Active
Documentation	Adequate
License clarity	Clear
Deployment complexity	Moderate
DEV.co fit	Good
Assessment confidence	High

Security considerations

OIDC and local authentication both supported; multi-user isolation enforced per-shelf. No explicit mention of encryption at rest, TLS enforcement, or audit logging in provided data. Metadata fetched from external APIs (Google Books, Open Library, Amazon) over HTTPS. AGPL-3.0 source is public on GitHub; any custom deployment should review code before running in production. Secrets (DB password, MYSQL_ROOT_PASSWORD) passed via environment; use .env file and Docker secret management in production. API docs disabled by default (API_DOCS_ENABLED=false).

Alternatives to consider

Calibre + Calibre-web

Mature, permissive-licensed (GPLV3 backend, frontend varies), desktop and web UI for library management. No built-in reader; more manual setup. Lighter-weight than Grimmory.

BookStack (self-hosted wiki/documentation)

MIT-licensed, similar self-hosted ethos, but designed for documentation, not ebook library. No reader, no Kobo/OPDS sync, no metadata enrichment.

Readarr (Sonarr for books)

GPLv3, focused on automated book discovery and download from torrent/RSS sources. No UI reader, no OPDS sync. Complements but doesn't replace a library app.

Software development agency

Build on grimmory with DEV.co software developers

Review the full documentation, test the Docker Compose setup, and confirm AGPL-3.0 license fit with your team. Join the Discord community for deployment questions.

Talk to DEV.co

Related open-source tools

Surfaced by semantic similarity across the DEV.co open-source index.

Kavita openbooks audiobookshelf

Related on DEV.co

Explore the category and the services that help you build with it.

Open-Source DevOps Web App Development DevOps & Deployment API Development Talk to DEV.co

grimmory FAQ

Can I migrate from Booklore to Grimmory without losing data?

Yes. Grimmory is a community fork of Booklore. Retain the same container name, database name/user, mounted volumes, and port. Replace only the image tag (grimmory/grimmory:<tag>). Data persists via MariaDB and mounted volumes.

What file formats are supported for reading in the browser?

PDF, EPUB, and comics (CBZ, CBR, CB7). Audiobooks (M4B, M4A, MP3, OPUS) are imported but require external player. MOBI, AZW, AZW3, FB2 are ingested for metadata but not read in-browser (typically exported to Kindle).

Is there a way to sync books to my Kobo e-reader?

Yes. Grimmory supports OPDS protocol, which Kobo devices can connect to. Also supports KOReader sync for reading progress. Use OPDS-compatible apps on any device for read-only access.

Can I use Grimmory commercially or in a SaaS product?

Not without careful legal review. AGPL-3.0 requires that if you run it as a network service or distribute it, you must offer source code and license derivatives under AGPL-3.0. Proprietary use or closed-source distribution is not permitted. Internal-only deployment is permissible. Consult legal counsel before commercial use.

Software development & web development with DEV.co

DEV.co helps companies turn open-source tools like grimmory into production software. Our software development services cover the full lifecycle — architecture, web development, integration, and maintenance — delivered by software developers and web developers who ship. Engage our software development agency to implement or customize it for your open-source devops stack.

Ready to evaluate Grimmory for your library project?

Review the full documentation, test the Docker Compose setup, and confirm AGPL-3.0 license fit with your team. Join the Discord community for deployment questions.

Talk to DEV.co Schedule a Consultation