A self-hosted ebook library server. Scan, upload, browse, and read your entire collection from any device.
Built with FastAPI, React, and SQLite. Ships as a single Docker image.
Early release -- actively developed, expect rough edges.
Continue reading where you left off. Track streaks, pages, and reading time at a glance.
- Built-in reader -- EPUBs, manga (CBZ/CBR), and PDFs render directly in the browser. Two-page spread, RTL mode, webtoon scroll, pinch-to-zoom on mobile. Details
- KOReader sync -- custom TomeSync plugin syncs reading positions and sessions, works fully offline. Details
- Bindery -- an inbox for incoming books. Drop files in a folder, review pre-filled metadata, accept into your library. Details
- Metadata from 3 sources -- fetch and compare metadata from Hardcover, Google Books, and OpenLibrary with a side-by-side diff UI
- OPDS feed -- browse and download from KOReader, Panels, Chunky, or any OPDS client
- Reading stats -- session tracking, streaks, time-of-day heatmaps, and charts
- 9 themes -- light, dark, Catppuccin (4 flavors), Nord, Neon, 8-bit
Plus: series browsing, bulk operations, libraries with icons, saved filters, Quick Connect (6-char code sign-in), OPDS PINs (e-ink-friendly passwords), granular user permissions, audit logging, and a bulk import script. Full feature list
Filter, sort, and browse your library. Bulk select for metadata edits, library assignment, or export.
Drill into a series to see every volume, track progress per book, and pick up where you stopped.
Full metadata view with cover, description, tags, and one-click reading.
All your series at a glance with volume counts and descriptions.
Reading activity, streaks, session history, and time-of-day patterns.
Tome works as a PWA on mobile. Pin it to your home screen for a native app feel.
 |
 |
 |
 |
 |
docker run -d \
-p 8080:8080 \
-v /path/to/data:/data \
-v /path/to/ebooks:/books:ro \
-v /path/to/bindery:/bindery \
-e TOME_SECRET_KEY=changeme \
ghcr.io/bndct-devops/tomeOpen http://localhost:8080 and follow the setup wizard to create your admin account.
Or use Docker Compose -- copy docker-compose.example.yml, edit the values, and docker compose up -d.
| Mount | Purpose |
|---|---|
/data |
SQLite database and cover cache |
/books |
Ebook library (read-only is fine) |
/bindery |
Incoming folder for new books |
| Variable | Required | Default | Description |
|---|---|---|---|
TOME_SECRET_KEY |
Yes | -- | JWT signing secret |
TOME_DATA_DIR |
No | /data |
DB and cover cache |
TOME_LIBRARY_DIR |
No | /books |
Library root |
TOME_INCOMING_DIR |
No | /bindery |
Bindery folder |
TOME_PORT |
No | 8080 |
HTTP port |
TOME_HARDCOVER_TOKEN |
No | -- | Hardcover API token for metadata |
| Format | Reader | Notes |
|---|---|---|
| EPUB | Text reader | CFI position tracking |
| CBZ | Comic reader | Streaming page delivery |
| CBR | Comic reader | Auto-repacked to ZIP |
| Browser viewer | Served directly |
Requirements: Python 3.12+, Node.js 18+
./dev.sh # starts backend :8080 + frontend :5173| Layer | Technology |
|---|---|
| Backend | Python 3.12+ / FastAPI |
| Database | SQLite (WAL) / SQLAlchemy 2.0 |
| Frontend | React 19 / Vite / TypeScript |
| Styling | Tailwind CSS 4 |
| Auth | JWT (python-jose) |
Built with Claude Code.
- Reader -- EPUB, comic/manga reader, keyboard shortcuts, ComicInfo.xml
- KOReader Plugin -- TomeSync setup, sync behavior, offline support
- Bindery -- setting up the incoming book inbox
- Import Script -- bulk importing an existing collection
- Features -- Quick Connect, OPDS PINs, permissions, themes, and more
- KOReader -- the open source e-reader app that Tome's sync plugin and OPDS integration are built for
- Hardcover -- book metadata and cover art API
- foliate-js -- the EPUB rendering engine powering Tome's built-in reader
MIT