Self-host KoShelf
2026.10.1Reading dashboard for KOReader notes and statistics
- Stars
- 254
- Port
- 3000 (web server)
ghcr.io/devtigro/koshelf
What is KoShelf?
KoShelf is a self-hosted reading companion that reads KOReader metadata — highlights, annotations, reading progress, and statistics — and presents it in a web dashboard. It supports browsing your library with books and comics, viewing and editing metadata and annotations (with writeback to KOReader sidecars), detailed reading statistics with customizable heatmaps and weekly breakdowns, a monthly reading calendar, and a yearly recap with completions and summaries. An in-app reader opens EPUB, FB2, MOBI, and CBZ files with keyboard navigation and inline highlight notes. KoShelf can run as a live server with file watching or generate a complete static site for hosting anywhere. It supports all three KOReader metadata storage modes (adjacent .sdr folders, docsettings, hashdocsettings) and merges statistics from multiple devices. Optional authentication uses a generated password or delegates to trusted reverse proxies like Home Assistant ingress. The project is open source under EUPL-1.2 and built for personal use with daily testing by the author.
Should you self-host KoShelf?
KoShelf scores 45/100 on selfhost.directory (how scoring works) and ranks #10 of 19 in Ebook Management. It has 254 GitHub stars.
It shipped 15 stable releases in the past year. The latest, 2026.10.1, came out on 15 October 2026. New versions land roughly every 5 days.
Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is EUPL-1.2-licensed and written mostly in Rust.
Its closest alternative on selfhost.directory is Calibre (83/100, 26 268 stars). It scores higher overall, so compare the two before you pick. See KoShelf vs Calibre side by side.
Features
- Annotations, Highlights & Ratings
- In-App Reader
- Library Archives
- Library overview
- Metadata Entries
- Metadata WritebackRequires --enable-writeback flag
- Optional authenticationServe mode only
- Original File Downloads
- Per-Item Statistics
- Reading Calendar
- Reading statistics
- Search & Filter
- Server Mode
- Static Site Generation
- Yearly Recap
KoShelf README
More in Library Management
RetromOpen-source, self-hosted game library service focused on emulation, with desktop clients for Windows, macOS, Linux and a built-in web client.
ArchivesSpaceSelf-hosted, open-source archives management system for accessioning, arrangement and description, with a staff interface, public catalog, OAI-PMH and a REST API.
BookLogrSelf-hosted, open-source reading tracker for your personal book library: lists, progress, ratings, quotes, Goodreads import, Mastodon sharing, run via Docker.
BookLoreBookLore is a self-hosted, open-source digital library for EPUBs, PDFs and comics, offering smart shelves, automatic metadata, OPDS, Kobo sync, and a built-in reader.
EvergreenSelf-hosted open-source Integrated Library System (ILS) for libraries, providing catalog, circulation, acquisitions, serials, and web staff client.
Fedora RepositoryFedora Repository is a self-hosted, open-source digital repository for managing and preserving digital content, used by libraries and archives worldwide.
InventaireOpen-source, self-hosted webapp for collaborative book inventories and lending among friends and groups, built on a bibliographic database mapped to Wikidata and ISBNs.
KohaKoha is a free software integrated library system (ILS). Koha is distributed under the GNU GPL version 3 or later. ***Note: this is a synced mirror of the official Koha repo. Note: This project uses its own bug tracker, see https://bugs.koha-community.org/ to report a bug or submit a patch.
0 comments