Skip to content

Reading over OPDS and Komga

Outside apps can read from Maki over OPDS or the Komga-compatible API. Both are off by default.

OPDS 1.2 with page streaming (OPDS-PSE) works with Panels, Chunky, KOReader and Mihon. Each user’s feed URL carries its own rotatable token. Each page an app streams saves your position. A chapter completes on its last page after you open it, so an app that fetches that page early does not mark it read.

Each chapter entry shows the chapter’s first page as its thumbnail. If that page will not render, the series cover is used instead. Archived series are left out of the feed. Restoring one brings it back. See Archiving a series. The on-deck shelf leaves out series you put On hold or Dropped, until you read them again.

Streamed JPEG XL pages always go out as WebP, since most OPDS apps cannot decode JPEG XL. A CBZ an app downloads whole keeps its JPEG XL pages, so if you download for offline reading, keep page conversion on WebP or AVIF. See Page conversion.

  1. Turn on the OPDS catalogue under Settings → Reading → OPDS catalogue.
  2. Copy the feed URL it shows. It is shown once, right after you turn the catalogue on or regenerate the token.
  3. Paste it into your app as a new catalogue.

From outside your network, swap the host for the address you use there. See Reverse proxy and HTTPS.

For KOReader, which can also sync progress, see KOReader.

Apps that only connect to a Komga server, like the Mihon Komga extension and Tachimanga, can use Maki’s Komga-compatible API instead. See Komga-compatible apps.