grimmory-tools / grimmory
Grimmory is the successor of booklore.
AI Architecture Analysis
This repository is indexed by RepoMind. By analyzing grimmory-tools/grimmory in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.
Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context on-demand, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.
Embed this Badge
Showcase RepoMind's analysis directly in your repository's README.
Repository Overview (README excerpt)
Crawler view> [!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 --- Features | 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 | Supported Formats | Category | Formats | | :--- | :--- | | eBooks | EPUB, MOBI, AZW, AZW3 | | Documents | PDF | | Comics | CBZ, CBR, CB7 | --- Quick Start > [!TIP] > For OIDC setup, advanced configuration, or upgrade guides, see the full documentation. Requirements: Docker and Docker Compose. Image Repositories | Registry | Image | | --- | --- | | Docker Hub | | | GitHub Container Registry | | Step 1: Environment Configuration Create a file: Step 2: Docker Compose Create a : Step 3: Launch Open http://localhost:6060, create your admin account, and start building your library. --- BookDrop Drop book files into a watched folder. Grimmory picks them up, pulls metadata, and queues them for your review. | 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 : --- Network Storage Set in your 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. --- Community and Support | 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. --- License Distributed under the terms of the LICENSE file in this repository.