Skip to content

BookHeaven.Server

v0.17.0 Breaking

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

Published 2mo File Storage & Sync
✓ No known CVEs patched
Read the diff → Tool health → What is this tool? →

✓ No known CVEs patched in this version

Topics

bookheaven books docker ebook ebook-library self-hosted

Summary

AI summary

OPDS endpoint moved to /opds/v1; KOReader Sync support added.

Full changelog

# Breaking Changes

  • The OPDS endpoint has been moved from /opds to /opds/v1.

Features

  • Added support for KOReader Sync.

Fixes

  • KOReader was unable to load the OPDS catalog due to a missing header in the response.

KOReader Sync

As you may be aware, BookHeaven Server has been designed to work in tandem with the dedicated reader app for Android, which will provide the best overall experience.

However, BookHeaven is all about convenience and adding support for KOReader Sync has been an effort to provide more of that.

So from now on you can use BookHeaven as a KOReader Sync server, to read your books and sync your reading progress across devices using KOReader.

On top of that, your progress will also show up in the web ui, minus the reading time, the sync API doesn't provide that info.

Sharing progress between the android app and KOReader is not possible though, since the way of handling ebooks and progress is different between the two platforms.

How to set up

To use KOReader with BookHeaven Server, add your Server as an OPDS catalog:

http://<your-server-ip>:<your-server-port>/opds/v1

-- or --

https://<your-server-domain>/opds/v1

Then, inside progress sync settings, add again your server url as a custom server (just the base url).

Log in using your BookHeaven profile name as username. The password is not required, but don't leave it blank otherwise it will throw an error.

And that's it!

Full Changelog: https://github.com/BookHeaven/BookHeaven.Server/compare/v0.16.0...v0.17.0

Breaking Changes

  • OPDS endpoint moved from /opds to /opds/v1

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 BookHeaven.Server

Get notified when new releases ship.

Sign up free

About BookHeaven.Server

Official BookHeaven Server web app to manage your ebook library.

All releases →

Related context

Beta — feedback welcome: [email protected]