Skip to content

Releases: bookorbit/bookorbit

v3.2.0

Choose a tag to compare

@github-actions github-actions released this 30 Sep 18:49
d1b3fae

Highlights

  • BookOrbit, now made for iPad (iOS): The entire app has been reimagined for iPad, with spacious two-pane layouts across Home, Library, Search, Book Details, Requests, Activity, Downloads, More, and Settings, plus purpose-built EPUB, PDF, comic, and audiobook experiences with panels, spreads, search, scrubbers, keyboard shortcuts, trackpad gestures, pointer support, and a Home Screen widget.
13 14 20 21 15 16 17 18 19 22
  • A faster way to manage libraries: Library setup now uses a single settings sheet instead of a seven-step wizard, while the Libraries page adds live scan status, recent history, in-place automation controls with undo, responsive cards, and the option to copy settings from another library.
3 5 6 7 8 9
  • Search and compare metadata in one place: The new two-pane match sheet ranks results by match strength, shows word-level field differences, lets you keep or use each value, preserves selections while browsing candidates, and brings the same workflow to Book Dock.
1
  • More control over each library and account: Libraries support precise fractional completion thresholds and a read-aloud filename token, while each user can hide Requests and its notifications without interrupting requests already in progress.
2
  • Dedicated ebook and audiobook covers: Books with both media now store independent covers for each medium. Audio screens show square artwork while library browsing, Kobo, and OPDS display the ebook cover, with automatic migration on upgrade.
10

Features

Bug Fixes

Read more

v3.1.0

Choose a tag to compare

@github-actions github-actions released this 25 Sep 20:31

Highlights

  • Your library, now on iPhone and Apple Watch (in v3.0.0+): The official BookOrbit app is here, native and offline-first. Read EPUBs, PDFs, and comics, play audiobooks with chapters and a sleep timer, and have any book read aloud to you. Download all of it for the commute, push files in from any app's share sheet, and then leave your phone behind entirely: the Apple Watch app downloads and plays your audiobooks on its own, and syncs your place when you are back.

    Download from Apple App Store: https://apps.apple.com/us/app/bookorbit-the-official-app/id6811807346

ios-app-gallery apple-watch-showcase
  • Reader tune bar and custom fonts (iOS): Adjust appearance directly over the page with a fluid tune bar, render your server and uploaded custom fonts, and configure account reading defaults in Settings for books, PDFs, and comics.
1 5 2 3 4 11 12
  • Redesigned Apple Watch experience (iOS): The Apple Watch companion features a redesigned player, speed sheet, and library list for seamless, phone-free audiobook listening on the go.
6 7 8
  • Polished audiobook player (iOS): The player highlights larger cover art and centered titles, displays dedicated covers separate from ebook editions, and prevents accidental seeks while scrolling.
13
  • Faster downloaded EPUBs and Read Along (iOS): Downloaded books now load individual chapters and Read Along audio on-demand, opening large files instantly while letting you tap any sentence to start narrated playback.
  • Conflict-free reader settings sync - Reader preferences now update field-by-field over PATCH instead of replacing the entire settings row, preventing web and companion apps from overwriting each other's customizations.
  • Enhanced read-along playback - Read-along EPUBs sync reading positions with standalone EPUB files, start narration at the exact selected sentence, and preserve active word highlights across all color themes.
  • Automatic format re-ranking on import - Adding new formats into an existing book automatically re-evaluates the primary file based on library priority rules, so preferred formats take the lead right away.

Features

Bug Fixes


Docker

docker pull ghcr.io/bookorbit/bookorbit:3.1.0

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

v3.0.0

Choose a tag to compare

@github-actions github-actions released this 21 Sep 07:49

Highlights

  • Your library, now on iPhone and Apple Watch: The official BookOrbit app is here, native and offline-first. Read EPUBs, PDFs, and comics, play audiobooks with chapters and a sleep timer, and have any book read aloud to you. Download all of it for the commute, push files in from any app's share sheet, and then leave your phone behind entirely: the Apple Watch app downloads and plays your audiobooks on its own, and syncs your place when you are back.

    Download from Apple App Store: https://apps.apple.com/us/app/bookorbit-the-official-app/id6811807346

ios-app-gallery apple-watch-showcase
  • Read-along EPUBs - A book with EPUB 3 media overlays, such as the ones Storyteller produces, now plays its real recorded narration in the reader. The sentence being read is highlighted, the audio streams straight out of the EPUB, and closing the book resumes on the exact sentence.

    How I use this in practice: https://bookorbit.app/my-workflow/

1
  • Bring your own speech engine: Admins connect any OpenAI-compatible text-to-speech server, such as a local Kokoro container, under Settings. Test the connection, let it list its own voices, preview them, and curate which ones readers can choose. Providers are ordered, so readers always fall back to a working one.

    Koroko setup guide: https://bookorbit.app/text-to-speech/

provider-configuration provider-overview manage-voices
  • Prowlarr and SABnzbd - Manage synchronized torrent and Usenet sources through a single Prowlarr connection, and fulfil requests through SABnzbd with NZB uploads, queue monitoring, reconciliation, and completed-download imports. Search health is reported per source.
2
  • One reading position across audiobook, ebook, and devices: Read-aloud progress sync keeps the audiobook, the web reader, Kobo, and KOReader on the same spot. A switch on the book's Details tab turns it on per book and says plainly when a book cannot use it, for example when the durations do not match.

Features

Bug Fixes

Internationalization


Docker

docker pull ghcr.io/bookorbit/bookorbit:3.0.0

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

Full diff

v2.10.0

Choose a tag to compare

@github-actions github-actions released this 14 Sep 05:25

Highlights

  • Expanded book request automation - Automated requests now support Usenet via Newznab and NZBGet alongside torrents, customizable release scoring profiles, per-indexer seed goals, and in-app indexer plugin updates.
1 2 3
  • Flexible "Date Added" sources - Libraries can now determine a book's added date from its import time, file modification time, or file creation time, with one-click recomputation for existing collections.
4
  • Collapsible series on author pages - Author pages can now collapse books into series groups, making large author bibliographies much cleaner and easier to navigate.
  • Configurable listen address - Bind the server to specific IPv4 or IPv6 network interfaces using the HOST environment variable for customized network deployments.

Features

Bug Fixes

Internationalization

Security


Docker

docker pull ghcr.io/bookorbit/bookorbit:2.10.0

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

Full diff

v2.9.0

Choose a tag to compare

@github-actions github-actions released this 07 Sep 03:49

Highlights

  • Automated book requests - Users can request books, send them through approval, search configured sources, and import fulfilled releases through the Book Dock. Permissions and requester visibility stay scoped throughout the workflow.
my-requests release-picker request-detail settings-automation settings-sources source-editor
  • PDF highlights and annotations - Create, style, search, revisit, and delete PDF highlights and notes in the web reader, with improved responsive outline and annotation navigation.
  • More control over EPUB typography - Adjust paragraph spacing and indentation while preserving publisher formatting by default, with synchronized defaults and per-book overrides.
  • SSO-only authentication - Administrators can require OIDC sign-in after linking an enabled superuser, with password flows blocked consistently across the API, web app, WebSockets, and administrative actions.
  • Safer automatic metadata refreshes - Books with trusted provider IDs now refresh only from those identities, avoiding accidental matches to a different edition while keeping manual search flexible.

Features

Bug Fixes

Read more

v2.8.1

Choose a tag to compare

@github-actions github-actions released this 29 Aug 00:42

Highlights

  • Redesigned book detail tabs: The Details, Edit Metadata, Files, Reading Log, and Highlights tabs now use single-screen layouts. Reading Log and Highlights remain mounted between tab changes to prevent loading flashes.
1 2 3 4 5
  • Bulk rename and missing-resource cleanup tools: Bulk Rename now provides server-side search, virtualized selection, inline filename diffs, tree previews, and progress reporting. Missing Resources reviews absent books, orphaned cover references, and leftover cover folders before deletion.
15
  • Public collections: Collection owners can make a collection readable by every authenticated user. Editing, reordering, and deletion remain restricted to the owner.
13
  • Per-category notification levels and repeat collapsing: Each notification category supports Off, Problems, or All. Repeated events collapse into one notification with a count, and scheduled scans with no changes no longer create notifications.
14
  • Overhaul settings pages: Redesign the settings interface to reduce cognitive load and simplify complex configurations.
6 8 10 11 12
  • KOReader and Kobo reading statistics: KOReader sync progress and Kobo reading-time counters now create reading sessions used by streaks and statistics. Daily calculations use the reader's configured timezone.

  • Series volume tracking and next-comic navigation: Series cards and lists show read, reading, available, and missing volumes on one track. Reaching the last page of a comic can now open the next issue in the series.


Features

Bug Fixes

Read more

v2.7.0

Choose a tag to compare

@github-actions github-actions released this 23 Aug 01:25

Highlights

  • Audiobookself and Calibre-Web Automated import support: Migrate from Audiobookshelf through a live connection or offline backup, or from a stopped Calibre-Web Automated snapshot, while preserving matched books and user reading state.
1
  • Goodreads as Author metadata provider: Add biographies, photos, dates, websites, genres, and influences, with a preferred metadata source and merge strategy for each field.
2 5
  • Retire a KOReader without erasing its history: Take an old device off the active list while keeping its synced events, progress, file naming pattern, and unmatched books. A returning device becomes active again automatically.
4
  • Read EPUBs in the font style you actually chose: Pick real weight and style variants, including uploaded variable-font axes, and keep those choices stable as font catalogs load.
3
  • Keep reading history consistent across edits and devices: Manual reading dates now drive book status correctly, KOReader progress resets stick, and rebuilding a library no longer silently drops device reading history.

Features

Bug Fixes

Internationalization

Read more

v2.6.0

Choose a tag to compare

@github-actions github-actions released this 23 Aug 01:26

Highlights

  • A faster way through Book Dock: Review incoming books in a responsive triage list with attention-first sorting, a needs-review filter, clearer match scores, and visible write destinations.
05
  • Build roomier dashboard shelves: Give each shelf one to three rows, fill books in natural reading order, and customize the dashboard from a clearer, wider settings drawer.
02
  • BookOrbit now speaks 25 languages: Nine more interface languages join the catalog, with one searchable picker that understands native names, English names, and locale codes on desktop and mobile.
03
  • Open registration when you want it: Administrators can enable self-registration, giving new readers a dedicated sign-up page while keeping closed instances closed by default.
  • Kobo purchases arrive alongside BookOrbit books: Optionally deliver Kobo Plus and purchased titles during device sync, with working covers for store books throughout the Kobo experience.

Features

Bug Fixes

Internationalization

Performance


Docker

docker pull ghcr.io/bookorbit/bookorbit:2.6.0

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

v2.5.0

Choose a tag to compare

@github-actions github-actions released this 23 Aug 01:26

Highlights

  • Updating the KOReader plugin no longer crashes KOReader: Tapping Update inside KOReader crashed the app on devices still running plugin v1.3.x. That update is no longer offered to affected devices, so the crash cannot happen. Those devices need one manual install to get going again: Settings > KOReader flags them as Manual update required and the steps are below.

Action Required: Devices on plugin v1.3.x need one manual install

If updating the plugin from inside KOReader crashed the app, that device is still on v1.3.x and cannot update itself. The broken updater is the same code that would have to install the fix, so it can never self-deliver. One manual install per affected device clears it for good.

  • In the BookOrbit web UI, go to Settings > KOReader. Any device that needs this is flagged Manual update required.
  • Click Download Plugin.
  • Extract the zip and copy the bookorbit.koplugin folder into koreader/plugins/ on the device, replacing the existing folder.
  • Restart KOReader.

The downloaded plugin comes preconfigured with your server URL and credentials. Your reading progress, annotations, and device links on the server are untouched.

What causes it: plugin v1.3.x calls a KOReader function that KOReader removed in July 2026. The old updater does not check whether that function exists and does not contain the failure, so the missing function crashes KOReader instead of showing an error. Plugin v1.4.0 fixed this, and devices on v1.4.0 or newer are unaffected and continue to update normally.

Two limits worth knowing:

  • The update check identifies your account, not the individual device, so while any one of your devices is still on v1.3.x, in-app plugin updates pause on all of them. They resume once that device is updated by hand, or removed from Settings > KOReader.
  • A device that has never completed a full sync has not reported its plugin version, so BookOrbit cannot tell it apart and does not protect it. Run Sync all books now once, or install the plugin manually.

Features

Bug Fixes

Internationalization

Performance

Visual Changes


Docker

docker pull ghcr.io/bookorbit/bookorbit:2.5.0

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

Full diff

v2.4.0

Choose a tag to compare

@github-actions github-actions released this 23 Aug 01:26

Highlights

  • Move books between libraries: Move individual books or large selections without importing them again. Preview each move and follow its progress while BookOrbit preserves reading progress, annotations, collections, and device sync history.
book-move-action book-move-library-picker
  • KOReader, rebuilt: A faster, pixel-perfect overhaul keeps sync and bulk downloads responsive and resumable in large libraries, while fixing crashes on older hardware and Kindle devices. It also adds bookmark sync, personalized dashboards, reading statistics, series browsing, and on-device views.
koreader-dashboard koreader-book-details
  • Make BookOrbit feel like yours: Reorder sidebar sections, choose your home dashboard shelves, and pick from more accent colors. Richer navigation keeps libraries, collections, and SmartScopes close at hand without slowing down large libraries.

  • Reader settings, redesigned: Ebook and comic controls now live in one easy-to-scan panel with visual theme previews, clear sliders, and layouts tailored to desktop and mobile. Administrators can also provide shared fonts for every reader.

appearance-customization ebook-reader-settings dashboard-shelf-customization customizable-dashboard server-fonts
  • Keep metadata inside more formats: Save metadata and cover changes directly inside MOBI, AZW, and FB2 files, so edits travel with the book to your Kindle or another reader. Per-library controls let you choose which formats BookOrbit updates.
mobi-fb2-metadata-writing
  • BookOrbit now speaks 16 languages: Interface support grows from 5 to 16 languages with Czech, Danish, Spanish, Finnish, French, Italian, Polish, Russian, Swedish, Ukrainian, and Simplified Chinese.
interface-language-picker
  • Administration built for larger communities: Search, filter, and page through users with clearer account status and magic-link actions. Richer audit details and filters make activity easier to investigate, and file-naming settings now include live previews.

  • Reading sync you can trust: Continuous-scroll CBZ books reopen at the right place, StoryGraph keeps reading-attempt dates intact, and read-status changes made in BookOrbit reach Kobo devices on the next sync.

  • See what is missing from a series: BookOrbit can learn a series total and compare it with your collection. A new ownership meter shows completeness, while expanded gap detection reveals missing volumes beyond your latest book.

  • Better covers and comic metadata: Updated EPUB covers now display correctly across more reading apps and OPDS clients. ComicVine IDs and issue titles also stay clean when metadata is imported, edited, and saved back to files.


Features

Read more