KoShelf
KoShelf is a self-hosted reading companion that turns your KOReader metadata into a web dashboard, letting you browse your e-book library, review highlights…
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
53/100 Fair
- Maintained
- 81last commit 37 days ago
- Popular
- 48255 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- No data
- Security check
- 201 serious finding, CI, tests
Based on 4 of 5 factors.
Security check: 1 serious finding
- Uses zip 9.0.3, which has a known critical vulnerability (crates.io)
Automated checks on commit 5b74f61, 5 Nov 2026. Not an audit.
Availability: platform listings confirmed today, links checked 21 days ago
- GitHub stars
- 255
- Open issues
- 8
- Last commit
- 2026-10-15
- Latest release
- 2026.10.1
- License
- EUPL-1.2
- Activity
- stale
Checked 7 days ago - source: GitHub (paviro/KoShelf)
Resources & Compatibility
Requirements not published yet.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- KOReader Metadata KoShelf is a web dashboard for KOReader metadata; it can show entries without the original document when PDF or DjVu sidecars exist, and editing metadata, covers, or annotations requires writeback to be enabled. source
Fetched 31 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
How do I run KoShelf in Docker?
Use the community-maintained koshelf-docker image. The installation guide includes a sample docker-compose.yml to start it.
Can KoShelf be placed behind a reverse proxy?
Yes, server mode provides a built-in web server with live file watching for use with a reverse proxy.
Does KoShelf support login authentication?
Server mode supports optional password protection with session-based auth, login rate limiting, password rotation, and session management.
Can edits made in KoShelf sync back to KOReader?
Metadata writeback is opt-in in serve mode and syncs annotations, review notes, ratings, and reading status back to KOReader sidecar files.
Can I host KoShelf as a static website?
It can generate a complete static website that can be hosted anywhere.
How do I enable original file downloads?
Enable the --include-files flag so original item files can be downloaded from item detail pages, including static exports.
Answers sourced from github.com
Community
- Reddit (reddit)
- FIG Kosher Phone Forum - Community Discussion & Support (forum)
- JTech Forums - The Ultimate Tech and Filtering Forum For the Jewish ... (forum)
- Kosherforum.com (forum)
- Reddit (reddit)
Collected 49 days ago - public community threads