omnibus-library/omnibus

Quick start

The image is published to Docker Hub as sesloan/omnibus, and the repo ships a Jellyfin-style docker-compose.yml.

No checkout needed. Save the docker-compose.yml into a folder of your own, edit the lines marked EDIT (your two library folders and the address you will open it at), then:

docker compose up -d

Open http://localhost:3000 and register — the first account is the admin. Adding it to an existing compose file, reverse-proxy/TLS, PUID/PGID, updating, and admin recovery are all in the Docker guide.

Documentation

Doc	What it covers
Feature tour	What Omnibus does, with screenshots
Deploy with Docker	Volumes, env vars, TLS, PUID/PGID, admin recovery
Kobo sync & KEPUB	Wired one-click transfer, wireless sync setup, two-way highlights
KOReader plugin	Install the Omnibus plugin, sync shelves to KOReader, the lane that tests it
Local development	Nix shells, just recipes, tests, the iOS app, project layout
Architecture	Crates, request flows, the REST contract; the iOS app's design
REST API	The OpenAPI contract every client builds against
Configuration reference	Every supported environment variable, annotated
Roadmap	What's shipped and what's next
Contributing	Issue-first workflow, quality gate, PR conventions
Security policy	How to report a vulnerability privately

REST API

The iOS app, the MCP server and the React web client talk to Omnibus through one REST API under /api/. Its contract is openapi/openapi.json, an OpenAPI 3.1 document the server's code generates, so it can't drift from what the server does. To write a client, generate one from that file; the copy at a release tag describes that release.

To read it as an API reference, run just openapi in a checkout. It regenerates the file and opens the reference in your browser.

License

MIT.