06Documentation
This page is an index. The documentation itself lives in phlix-docs, built with VitePress.
01Where the docs live
-
01
Installing the server, adding libraries, running a scan, connecting a client.
-
02
The HTTP surface: authentication, library and item endpoints, streaming and transcoding routes.
-
03
Architecture, the plugin contract, and the shared interfaces in phlix-shared.
-
04
Running your own hub: relay configuration, server enrolment, pairing.
02Read in this order
Four tasks, in the order the documentation assumes you will do them. Each one is covered by the guide it sits under above.
-
01Install the server — PHP 8.3+, Composer, and the one-line
create-projectcommand - 02Add a library — point the scanner at your folders and let the metadata providers fill in the rest
- 03Connect a client — Roku, Samsung Tizen, Windows, Mobile, or any DLNA device
- 04Go further — the plugin contract, the HTTP API, and running your own hub
03Ecosystem
Every repository in the project — name, address and purpose — is listed once, on the Download page. It is not repeated here.