HomeBranch

Guides

Set up an OPDS server for KOReader, Moon+ Reader and more

OPDS is a standard feed format that lets e-reader apps browse and download from an ebook library. If your library publishes an OPDS catalog, any OPDS-capable app can connect to it, search it and download books to the device.

What you need

  1. A catalog URL. For HomeBranch this ends in /api/opds/v1/catalog (OPDS 1.2) or /api/opds/v2/catalog (OPDS 2.0).
  2. A username. Your HomeBranch email address.
  3. A password. Your HomeBranch password. Pick basic authentication if the app asks.

Connect KOReader

  1. Open the top menu and choose the search icon, then OPDS catalog.
  2. Tap the + button and enter a name.
  3. Paste the catalog URL and fill in your email and password.
  4. Save, open the catalog and download a book.

Connect Moon+ Reader

Open Net Library, tap the + icon, enter a name and the catalog URL, then sign in with your email and password.

Connect Thorium Reader

Open Catalogs, choose Add, paste the catalog URL and sign in when prompted.

Connect iOS apps

Panels, Yomu and KyBook all let you add an OPDS source. Paste the catalog URL and enter your email as the username.

Troubleshooting

  • Login fails: confirm the same email and password work on the web app.
  • Forbidden: on HomeBranch Cloud, an inactive subscription blocks OPDS access.
  • Empty catalog: OPDS lists what is already in your library, so upload books first.
  • Connection errors on a self-hosted server: use HTTPS, and make sure your reverse proxy forwards the Authorization header.

Using HomeBranch Cloud? Your exact URL is on the Cloud OPDS setup page. Self-hosting? See the API reference for every OPDS endpoint.

Frequently asked questions

What does OPDS stand for?

Open Publication Distribution System. It is an open standard that lets reading apps browse, search and download books from a catalog over HTTP.

Which e-reader apps support OPDS?

KOReader, Moon+ Reader, Thorium Reader, Panels, Yomu and KyBook are common examples. Menu names vary by app and version.

Does HomeBranch support OPDS 2?

Yes. HomeBranch serves OPDS 1.2 (Atom) and OPDS 2.0 (JSON). Use the v1 address unless your app asks for v2.

Is OPDS secure?

It uses HTTP basic authentication, so always serve your library over HTTPS. HomeBranch Cloud is HTTPS by default.