Grimmory — Self-Hosted eBook and Comics Library Server

Introduction

Grimmory organizes your personal collection of eBooks, comics, and documents into a browsable web library. It scans your file system for supported formats, extracts metadata, and provides a reading interface accessible from any device with a browser.

What Grimmory Does

• Scans directories for eBooks and comics in EPUB, PDF, CBR, CBZ, MOBI, and AZW3 formats
• Extracts and displays metadata including cover art, authors, and series information
• Provides an in-browser reader for all supported formats
• Serves an OPDS feed for compatibility with external reading apps
• Supports user accounts with reading progress synchronization

Architecture Overview

Grimmory is built with Java and Spring Boot on the backend, with an Angular frontend. It uses an embedded database for metadata storage and a file watcher for automatic library updates. The OPDS server implements the standard catalog protocol, enabling integration with apps like KOReader and Moon+ Reader. Authentication supports both local accounts and OIDC providers.

Self-Hosting & Configuration

• Deploy via Docker with volumes for your library and configuration
• Point the library volume to your existing eBook collection
• Configure user accounts and permissions through the web admin panel
• Set up OIDC authentication for single sign-on with identity providers
• Customize metadata sources and scanning intervals in the settings

Key Features

• Supports a wide range of formats including EPUB, PDF, CBR, CBZ, MOBI, and AZW3
• Built-in web reader with progress tracking across devices
• OPDS catalog feed for external reading app integration
• Automatic metadata extraction with manual editing support
• Multi-user support with per-user reading progress and libraries

Comparison with Similar Tools

• Calibre-Web — Python-based with Calibre database dependency; Grimmory scans files directly without external tools
• Kavita — C#-based with strong manga support; Grimmory offers broader document format coverage
• Komga — focused on comics and manga; Grimmory handles eBooks and documents equally well
• Audiobookshelf — specialized for audiobooks and podcasts; Grimmory focuses on text and image-based reading

FAQ

Q: Do I need to organize my files in a specific structure? A: No. Grimmory scans recursively and extracts metadata from file contents regardless of directory structure.

Q: Can I read books on my phone or tablet? A: Yes. The web reader is responsive and works on mobile browsers. You can also use OPDS-compatible apps.

Q: Does it modify my original files? A: No. Metadata is stored in its own database. Your original files remain untouched.

Q: How do I migrate from another library manager? A: Point Grimmory at your existing file directory. It will scan and index your collection automatically.

Sources

• https://github.com/grimmory-tools/grimmory