Skip to main content

OPDS Catalog

Litara exposes an OPDS catalog so ebook reader apps can browse and download books directly. OPDS is disabled by default — enable it in Settings → OPDS Catalog.

VersionURLFormatCompatible apps
OPDS 1.2http://<host>:3000/opds/v1Atom XMLKOReader, Pocketbook, Moon+ Reader
OPDS 2.0 (experimental)http://<host>:3000/opds/v2JSONThorium Reader

Authentication

OPDS uses dedicated OPDS credentials — not your Litara account login. Create OPDS users in Settings → OPDS Catalog → Add User. These accounts can only access the OPDS catalog and cannot log into the Litara web UI.

App Setup

KOReader

  1. Open OPDS catalogAdd catalog
  2. Enter http://<host>:3000/opds/v1
  3. Enter your OPDS username and password when prompted

Thorium Reader

  1. Open CatalogsAdd an OPDS feed
  2. Enter http://<host>:3000/opds/v2
  3. Enter your OPDS username and password when prompted
note

OPDS v2.0 support is experimental. Client compatibility varies. Please open an issue if you encounter problems.

Available Feeds

OPDS v1 (Atom XML)

EndpointDescription
/opds/v1Root navigation
/opds/v1/catalogAll books (paginated, 20/page)
/opds/v1/newNew arrivals
/opds/v1/search/results?q=…Search by title or author
/opds/v1/authorsBrowse by author
/opds/v1/seriesBrowse by series
/opds/v1/genresBrowse by genre
/opds/v1/download/:bookId/:fileIdDownload a file

OPDS v2 (JSON)

EndpointDescription
/opds/v2Root navigation