Reading (OPDS)

Serve your comic library to mobile and tablet readers via the built-in OPDS feed.

Comicarr includes a built-in OPDS (Open Publication Distribution System) catalog server. OPDS is a standard feed format that comic and ebook reader apps understand natively, letting you browse and download comics directly from your library.

Enabling OPDS

config.ini

[OPDS]
opds_enable = True
opds_authentication = True
opds_endpoint = opds
opds_username = myuser
opds_password = mypassword
opds_metainfo = False
opds_pagesize = 30

Configuration Reference

Setting	Default	Description
`OPDS_ENABLE`	`False`	Enable the OPDS feed server.
`OPDS_AUTHENTICATION`	`False`	Require username/password to access the feed.
`OPDS_ENDPOINT`	`opds`	URL path segment for the feed.
`OPDS_USERNAME`	`None`	Username for OPDS authentication.
`OPDS_PASSWORD`	`None`	Password for OPDS authentication.
`OPDS_METAINFO`	`False`	Include extended metadata in feed entries.
`OPDS_PAGESIZE`	`30`	Number of items per page in the feed.

Feed URL

Once enabled, the OPDS feed is available at:

http://your-host:8090/opds

If you have changed HTTP_ROOT, the URL includes that prefix:

http://your-host:8090/your-root/opds

The endpoint path is controlled by OPDS_ENDPOINT. If you change it to comics, the URL becomes http://your-host:8090/comics.

Enable OPDS_AUTHENTICATION if your Comicarr instance is accessible outside your local network. Without it, anyone with the URL can browse and download your entire library.

Feed Structure

The OPDS catalog exposes your library through several browsable sections:

Publishers -- browse by publisher
All Titles -- alphabetical listing of all series
Story Arcs -- browse story arc collections
Reading List -- your curated reading list
One-Offs -- standalone issues
Recent -- recently added comics

Each series entry shows its issues, and each issue links to the downloadable file.

Compatible Readers

Chunky (iOS)

Full OPDS support with streaming. Add your feed URL under Settings > OPDS Feeds.

Panels (iOS / Mac)

Native OPDS browser. Add via Library > Add Connection > OPDS.

KOReader

Open-source reader for e-ink and other devices. Configure under Network > OPDS Catalog.

Moon+ Reader (Android)

Add your OPDS feed under Net Library > OPDS Catalog.

Connection Setup

In your reader app, add a new OPDS feed with:

URL: http://your-host:8090/opds
Username / Password: the values from OPDS_USERNAME and OPDS_PASSWORD (if authentication is enabled)

If connecting from outside your local network, use HTTPS (via a reverse proxy) and enable OPDS authentication. OPDS credentials are sent as HTTP Basic Auth, which is not encrypted without TLS.

Page Size

The OPDS_PAGESIZE setting (default: 30) controls how many entries appear per page in the feed. Readers that support pagination will load additional pages as you scroll. Lower values improve initial load time on slower connections; higher values reduce the number of round trips.