DOCUMENTATION — V1.0

Pick your guide

The docs are organized by who you are — the person watching, the person running the server, or the person reading the source. Start where you live.

START HERE

Install

Platform chooser, system requirements, and how to verify what you downloaded.
Docker & Compose — recommended Linux — tarball + systemd Windows — MSI macOS — .pkg + menu bar Troubleshooting a first install
FOR EVERYONE — PLAIN LANGUAGE, NO JARGON

User Guide

For anyone watching or listening — no server knowledge assumed.
Browsing your library Watching — resume, subtitles, quality Music and queues Restricted content & the PIN “Why is it converting?”
FOR WHOEVER RUNS THE SERVER

Admin Guide

Everything reachable from the settings screens.
The first-run wizard Libraries & scanning Users, profiles & permissions Plugins & metadata providers Settings reference
FOR THE TECHNICAL SELF-HOSTER

Operator Guide

The parts outside the app: network, TLS, storage, upgrades.
Reverse proxy — Caddy, nginx, Traefik recipes Built-in ACME (Let’s Encrypt) Backup & restore — and what not to back up External PostgreSQL Updating — and exactly what the checker sends
FOR CONTRIBUTORS

Developer Guide

Architecture tour and the rules that keep the codebase honest.
Getting started — pnpm dev to first request The contract-first workflow Adding a metadata provider The playback matrix regression law Glossary
FOR MACHINES — AND THEIR AUTHORS

API Reference

Generated from the OpenAPI contract — the single source of truth the SDK is tested against for drift.
REST endpoints Event schemas The generated SDK Plugin protocol (LPP)

REFERENCE — STRAIGHT FROM THE REPO

CHANGELOG CONTRIBUTING SECURITY LICENSE — AGPL-3.0