Skip to content

bookorbit/bookorbit](https:

v2.0.1 Breaking

This release includes 1 breaking change for platform teams planning a safe upgrade.

Published 29d Productivity & Wikis
✓ No known CVEs patched
Read the diff → Tool health → What is this tool? →

✓ No known CVEs patched in this version

Topics

audiobook-player digital-library docker ebook-reader library-management metadata-management
+5 more
nestjs oidc-single-sign-on opds self-hosted vue

Affected surfaces

breaking_upgrade

Summary

AI summary

Updates Highlights, Bug Fixes, and https://github.com/bookorbit/bookorbit/compare/v1.12.0...v2.0.1 across a mixed release.

Full changelog

Highlights

  • Full KOReader integration via BookOrbit Plugin - KOReader is now a first-class citizen. The Bookorbit plugin syncs your reading progress automatically as you read, uploads your entire read history in a single sweep, and keeps your highlights and notes in sync. A built-in catalog lets you browse and download books from your Bookorbit library without leaving your e-reader.

  • Annotations sync across all three platforms - Highlights and notes from Kobo, KOReader, and the built-in web reader now live in one place. Annotations survive file updates and format changes, and are never lost to duplicate detection or sync conflicts.

  • New Annotations Hub - A dedicated page showing all your highlights and notes across every book and library. Filter by book, annotation style, or source (Kobo / KOReader / web reader), select in bulk, and export.

  • Revamped Reading Log - The per-book reading log is completely rebuilt. See total reading time, session count, start and finish dates, and an achievement ring at a glance. A per-book activity heatmap shows your reading rhythm over time. A journey chart plots your progress across the life of the book. A source breakdown shows how much you read on each device. You can now log manual sessions directly from this tab too.

  • Custom book metadata fields - Define your own fields on top of the standard metadata set - text, URL, number, date, or boolean. Fields can be scoped to specific libraries, and their values are saved back into your EPUB, PDF, and CBZ files.

  • Community ratings from all providers - Book details now show community scores and vote counts from every configured metadata provider (Goodreads, Hardcover, Amazon, Audible, Google Books, iTunes, OpenLibrary, RanobeDB), right alongside the rest of the metadata.

  • Per-book Hardcover sync controls - Choose between two sync modes: sync all eligible books by default, or only sync books you explicitly opt in. A per-book toggle on the book detail page gives you fine-grained control, and unread books are handled correctly - your choice is remembered and sync activates automatically when you start reading.

  • Source distribution chart in statistics - A new chart on the statistics page breaks down your total reading time by source - Kobo, KOReader, and web reader - so you know exactly where you do most of your reading.

Action Required: Replace the KOReader Plugin

The old plugin is not compatible with v2.0.1. You must replace it manually - the in-KOReader update mechanism cannot perform this migration.

  • On your device, delete the bookorbit.koplugin folder from koreader/plugins/.
  • In the BookOrbit web UI, go to Settings > KOReader and click Download Plugin.
  • Extract the zip and copy the bookorbit.koplugin folder into koreader/plugins/.
  • Restart KOReader.

The downloaded plugin is already preconfigured with your server URL and credentials - no pairing step needed. Your reading progress and annotations on the server are untouched by this upgrade.


Features

  • sync: three way (kobo, koreader and bookorbit) progress and annotation sync (6da3c910) by @neonsolstice
  • kobo: add KOReader catalog plugin integration (1e58f21b) by @neonsolstice
  • metadata: add configuration for custom book metadata fields (498d23ca) by @neonsolstice
  • metadata: add community rating and rating count (ab371077) by @neonsolstice
  • metadata: store and write hardcover edition IDs (934f7cea) by @neonsolstice
  • hardcover: add per-book sync controls and book sync scope (780064ab) by @neonsolstice
  • book-dock: allow importing duplicates and same-path collisions (5dcd4196) by @neonsolstice

Bug Fixes

  • kobo: support syncing native kepub files (a9b4d218) by @neonsolstice
  • library: lock organization mode after creation (856e6084) by @neonsolstice
  • metadata: preserve Book Dock epub metadata (3c4cdd13) by @neonsolstice
  • metadata: prioritize edition release date over book release year (3b43edf1) by @neonsolstice
  • metadata: use ISBN context for Hardcover slug lookup (cfc24343) by @neonsolstice
  • metadata: always unpause queue on manual trigger (5542f1bc) by @neonsolstice
  • metadata: persist auto-fetch library overrides (e2522652) by @neonsolstice
  • client: preserve scroll position when navigating back to book grid views (f64a87d8) by @neonsolstice
  • server: resolve bulk selection queries for collections and email (db813413) by @neonsolstice
  • reader: skip throttling for EPUB file streams (61181cc7) by @neonsolstice

Docker

docker pull ghcr.io/bookorbit/bookorbit:2.0.1

Multi-arch: linux/amd64 and linux/arm64.

Full diff

Breaking Changes

  • Removal of old KOReader plugin; must manually delete `bookorbit.koplugin` from `koreader/plugins/` and install the new version.

Weekly OSS security release digest.

The CVE patches and breaking changes that affected production tools this week. One email, every Sunday.

No spam, unsubscribe anytime.

Share this release

Track bookorbit/bookorbit](https:

Get notified when new releases ship.

Sign up free

About bookorbit/bookorbit](https:

All releases →

Related context

Beta — feedback welcome: [email protected]