Skip to content

Self-hosted OPDS 1.2 server for browsing a Calibre database

License

Notifications You must be signed in to change notification settings

victor1234/opds-server

Repository files navigation

OPDS Server

CI Docker Image

📚 Minimal OPDS 1.2 server for browsing a Calibre database.

Features

  • OPDS v1.2 compliant feeds (navigation, acquisition, search)
  • Browse by newest, title, or author
  • Prebuilt multi-arch Docker images for amd64 and arm64
  • Read-only access to Calibre database

Service Endpoints

  • /healthzliveness probe (returns 200 if the server process is alive)
  • /readyreadiness probe (returns 200 if the Calibre database is available)

Configuration

The server can be configured using environment variables

Variable Default Description
PAGE_SIZE 30 Number of items (books, authors) shown per page in OPDS feeds.

Installation / Run

Docker

docker run --rm -p 9000:8000 \
  -v /path_to_calibre_directory:/app/calibre:ro \
  ghcr.io/victor1234/opds-server:0.1.1

Docker Compose

services:
  opds:
    image: ghcr.io/victor1234/opds-server:0.1.1
    ports:
      - "9000:8000"
    volumes:
      - /path_to_calibre_directory:/app/calibre:ro

Then open http://localhost:9000/opds in your OPDS-compatible reader.

About

Self-hosted OPDS 1.2 server for browsing a Calibre database

Topics

Resources

License

Stars

Watchers

Forks

Packages