Skip to content

BookOrbit

Updated

BookOrbit puts every kind of book in one library and lets you enjoy them anywhere. Ebooks, PDFs, comics, and audiobooks all get a reader in the browser, there's an official iPhone app (offline too) with audiobooks on Apple Watch, and your progress, highlights, and reading status follow you between the browser, a Kobo, and KOReader. Start a chapter on one, finish it on another.

Around that sit fourteen metadata providers, OPDS and Send-to-Kindle delivery, multi-user accounts, reading statistics and achievements, and automatic sync out to Hardcover, Readwise, and StoryGraph.

When does managed BookOrbit make sense?

  • You read on a Kobo or in KOReader, and want progress and highlights to survive moving between devices rather than starting again each time.
  • Your library is mixed. Ebooks, comics, and audiobooks live in one place instead of one app each.
  • You already run a book library and want to move. BookOrbit imports directly from Grimmory, Audiobookshelf, and Calibre-Web-Automated, so you are not rebuilding your collection by hand.
  • Pair it with Shelfmark to search for and fetch books, then have them land in BookOrbit's Book Dock for review.

Note

BookOrbit and Grimmory cover similar ground. Grimmory is the community continuation of BookLore; BookOrbit is a separate project that puts every kind of book (ebooks, PDFs, comics and audiobooks) in one library, with its own iPhone and Apple Watch app. Running both is fine, and BookOrbit can import from Grimmory if you decide to consolidate.

Get a 7-day trial of ElfHosted BookOrbit! πŸͺ„

How do I access BookOrbit?

BookOrbit is available:

Signed-in users see their own URLs

The addresses above show the general pattern. Sign in and these become your personal, clickable links.

Info

BookOrbit is an open-source tool. ElfHosted provides hosting infrastructure only. Users are responsible for their use of this service in compliance with applicable laws and third-party terms of service.

Initial setup

The first time you open BookOrbit it asks you to create an admin account, and for a setup token. Enter:

changemeelfie

That token only works while your instance has no accounts on it, so create your account as soon as your app is ready. Once your account exists the token stops working entirely. If someone else ever gets there first, reset BookOrbit in ElfBot and set it up again.

After that:

  1. Set a password you are happy with. This is BookOrbit's own login, separate from your ElfHosted one, because e-readers and OPDS apps sign in with it.
  2. Create a library and point it at where your books live. The folder picker starts at /storage, so an rclone-mounted remote appears under /storage/rclone/<mount>/.
  3. Scan the library, and let the metadata providers fill in covers and details.

Getting books in

There are three routes, and most people end up using more than one.

Book Dock is a watched folder. Anything dropped into storage/config/bookorbit/book-dock/ (via FileBrowser) is picked up, has its metadata extracted, and waits in the Book Dock screen for you to confirm the match and file it into a library. Files are only ingested once they have finished copying, so a slow upload will not be half-imported.

Shelfmark can deliver straight into that folder. In Shelfmark's settings, set the save path to /bookorbit-bookdock, and books you fetch there appear in BookOrbit for review.

Drag and drop in the web interface, for one-off additions.

Saving indexer and download client passwords

BookOrbit's book requests can use your own indexers and download clients, and it encrypts their passwords and API keys before storing them. Until it has an encryption key, it refuses to save them and says BOOK_REQUEST_ENCRYPTION_KEY is not set.

The key must be exactly 64 hexadecimal characters (0-9 and a-f), with no prefix, spaces or line breaks. Generate one on your own computer with:

openssl rand -hex 32

Then set it with ElfBot. BookOrbit restarts and picks it up:

Quick-paste into BookOrbit's environment variables using ElfBot
BOOK_REQUEST_ENCRYPTION_KEY=<64 hex characters from openssl>

A value of any other length or with other characters is ignored, and BookOrbit keeps saying the key is not set. Keep the key once it works: changing it later makes the passwords you already saved unreadable, and you'd need to enter them again.

Sending to Kindle and other e-readers by email

Send-to-email needs your own mail provider. Add its SMTP details in BookOrbit's email settings before you send anything.

If a send fails straight away with a Conflict error, BookOrbit has noticed that the book file changed since the library was last scanned (common for libraries on an rclone mount, or when another app edits the file's metadata), and it won't send a file it can't vouch for. Rescan the library, then send again. The same fix applies when an OPDS reading app's download fails with a conflict.

Reading on a Kobo or in KOReader

This is what BookOrbit is built around, and both directions work: progress and annotations made on the device come back, and progress made in the browser goes out.

  • Kobo: BookOrbit stands in front of the Kobo sync service, so your own library shows up on the device alongside anything bought from the store. Setup is per-device, from Settings.
  • KOReader: install the BookOrbit plugin on the device for an on-device catalogue with search and download, plus progress and annotation sync.
  • OPDS: for any other reading app, generate a personal OPDS feed and point the app at it.

Highlights from all three merge into one searchable hub, and can be exported as Markdown, CSV, or JSON, or pushed to Readwise as you make them.

Sharing with family

BookOrbit has its own user accounts with per-library permissions, so you can give someone access to part of your collection without giving them your ElfHosted login. Registration is closed by default; you invite people from the admin settings.

BookOrbit also works with

How do I get support for BookOrbit?

  1. For general use of BookOrbit, refer to the official site or to one of the links in the resources section below.

  2. For specific support re your ElfHosted configuration / account, see the ElfHosted support options!

You can contribute directly to the development of BookOrbit using the following:

BookOrbit resources

Your content, your responsibility

ElfHosted provides BookOrbit as a hosted application β€” we do not supply content, accounts, or third-party credentials. You are responsible for ensuring that your use of this app complies with applicable laws and our Acceptable Use Policy. If you have questions about what is or isn't permitted, please reach out β€” we're happy to help.

What users say..

We're rocking some excellent ⭐⭐⭐⭐⭐ TrustPilot Reviews, and here's what some of our usersfriends say..

Really great products. Excellent and timely support. Really took away all the hard work of hosting. Love it!

β˜…β˜…β˜…β˜…β˜… Sparsh B. (Trustpilot)

Literally what the slogan says. Self hosting without the suffering, setup once and just forget about, let them deal with being the system admin for a cheap monthly sub!

β˜…β˜…β˜…β˜…β˜… PlΓΆde (Trustpilot)

There so helpful and willing to go out if there way to get you all setup. They went out of there to help me get my media server setup and running and organized properly since I was total noob at it.

β˜…β˜…β˜…β˜…β˜… Kenny (Trustpilot)

It all seems to be working now great service

β˜…β˜…β˜…β˜…β˜… Mick D. (Trustpilot)