Documentation

Docs & API Reference

Comprehensive guides for end users, developers, and hub administrators.

Guides

Pick your path

User Guide

Setting up your server, adding media, managing users, using SyncPlay, Live TV, and more.

→

Developer Docs

Architecture overview, building clients, contributing to Phlix, plugin development guide.

→

Hub Admin Guide

Self-hosting Phlix Hub, managing the relay, user management, and security considerations.

→

API Reference

Complete API documentation for Phlix server, client protocols, and plugin interfaces.

→
Quick Links

Server Source

PHP 8.3+, Workerman 5.x based media server

GitHub

Plugin Example

Reference metadata-provider plugin implementation

GitHub

phlix-shared

Shared interfaces, DTOs, event types

GitHub

Hub Source

Cloud directory + reverse-tunnel relay

GitHub
phlix ~ docs

$ phlix docs --serve

Serving documentation at http://localhost:8080/docs

API reference: http://localhost:8080/docs/reference

Press Ctrl+C to stop.