Reading paths

The documentation is small enough to read whole, and the paths below route you through it in the order that matches what you are trying to do.

Every path starts with getting started unless you already run a server: it is the only page that brings one up, and every other page assumes one.

You manage machines with nix

Read getting started end to end and follow the nix path on both the server and each device: the NixOS module and the Home Manager module replace every manual step.

Add the Firefox add-on the same way when a browser or a phone joins, and keep the HTTP API reference at hand for anything the modules do not surface.

You want mpv tracking without nix

Follow the standalone path through getting started: cargo builds the two binaries, the Lua script drops into any mpv setup, and the example systemd units run the sync agent.

Nothing else is required; the other pages become interesting only when a second device or a browser joins.

You watch on your phone

Bring up a server with getting started on either path, then install the add-on following the Firefox guide, whose Android section covers what Release and Nightly can each do.

You want to build against the API

Skim getting started far enough to have a running server and a token to test with, then read the HTTP API reference whole: it is the complete contract, including the event schema and what the server tolerates in an event.