Resources

Guides and reference

How to set up a server, get your library in order, share it with the people you want to share it with, and change the things worth changing. Written for the person doing it.

Start here

Install the server

What the server is, which machine to put it on, and how to install it on Windows, Linux, or Docker.

Connect your server to your account

What linking gives you, how the handoff works, what to do when it fails, and how to unlink without losing anything.

Parental controls

Cap a profile by age rating, lock the grown-up profiles with a PIN, approve a request from your phone, and put a PIN on the server settings themselves.

Advanced settings reference

Every tuning knob in the server, what it actually changes, what it costs, and which symptom it fixes.

All guides

Getting started

Install the server, run through first-time setup, connect it to your account, and bring an existing collection across.

Your library

Add folders, get everything identified correctly, and organise it into collections that either you or the server keeps up to date.

People and access

Give everyone in the house their own profile, set limits for the children, and share the server with people who live somewhere else.

Watching

Queues and playlists, watching together from different houses, live channels and recordings, and taking things offline.

Running your server

The settings hub, backups and updates, and a full reference for every advanced option including what each one actually changes.

Building on your server

Every server ships a documented REST API. It is the same one our own apps use, so anything the apps can do, you can do.

Browse and search your libraries, filter with the same rules smart collections use, list connected devices, and drive playback on any screen. Documented as OpenAPI, with a console for trying every call against your own server.

Build a plugin

Add a metadata source, put your own information on a detail page, or extend the server with something we have not built. Plugins run sandboxed, ship as one file that works on every screen, and are free to list. Writing, packaging and submitting, plus the full API reference.

Webhooks

Push playback and library events to Discord, home automation, or your own scripts. Set up per server, in the settings hub.

You will need an API token. Open your server, go to Settings → Integrations, and create one. Read lets you browse; Full also drives playback. The token is shown once.