Reference & guides
Everything you need to know.
Maintained on VitePress, updated with every release.
Getting started
User Guide
Complete walkthrough from zero to streaming: server installation, library setup, client pairing, SyncPlay, and Live TV.
Read the user guide →For developers
Developer Documentation
Server architecture, event lifecycle, plugin SDK, service container, and DTO reference for contributors and plugin authors.
Read the developer docs →Self-hosted relay
Hub Admin Guide
Self-hosting the Phlix Hub: Docker Compose setup, reverse-tunnel configuration, user management, and TLS.
Read the hub admin guide →API
REST API Reference
Full endpoint reference for the Phlix REST API: authentication, library, playback, sync, and admin routes.
Read the API reference →