Guides
OPDS

OPDS

Open Publication Distribution System (OPDS (opens in a new tab)) is a specification for generating and serving catalogs of digital content. It is used by many applications, such as Panels (opens in a new tab) and Chunky Reader (opens in a new tab).

So long as an OPDS client properly implements the OPDS specification, you should be able to use it with Stump. Each OPDS client might have a different way of collecting this information during their onboarding steps. If you have any trouble using your preferred client, please open an issue on GitHub (opens in a new tab) or feel free to pop into the Discord (opens in a new tab) for help. This page can be updated with your findings to help others in the future.

Supported OPDS Versions

Stump fully supports OPDS 1.2 and has experimental support for 2.0. At the time of writing, there are few clients which actually support 2.0, so it is difficult to test. If you have any experiences with OPDS 2.0, please consider updating this page with your findings!

OPDS 1.2

The general structure of the URL to connect to your Stump server is:

http(s)://your-server(:10801)(/baseUrl)/opds/v1.2/catalog

Tested Clients

Note: The ✨ emoji indicates a client which the developer of Stump personally uses

The following clients have been tested with Stump:

OSApplicationPage StreamingIssues/Notes
iOSPanels (opens in a new tab)
iOSChunky Reader (opens in a new tab)
AndroidMoon+ Reader (opens in a new tab)Users report OK experience
AndroidKyBook 3 (opens in a new tab)No testing at this time

If you have any experiences, good or bad, using any of these clients or another client not listed here, please consider updating this page with your findings.

OPDS 2.0

The general structure of the URL to connect to your Stump server is:

http(s)://your-server(:10801)(/baseUrl)/opds/v2.0/catalog

Tested Clients

The following clients have been tested with Stump:

OSApplicationPage StreamingIssues/Notes
iOSCantook by Aldiko (opens in a new tab)Supports catalog traversal and media downloads. Issues with rendering media covers, however this appears to be an issue on their end