Get started

Download & Install

Phlix runs on PHP 8.3+ with Workerman. Install via Docker, Composer, or directly — your server, your way.

System Requirements

Component Minimum Recommended
PHP 8.3 8.3+
Memory 512 MB 2 GB+
Disk 10 GB Depends on library
OS Linux, macOS, Windows Linux (Ubuntu 22.04+)
FFmpeg 6.x Latest
Workerman 5.x 5.x

Installation Methods

Docker (Recommended)

Quickest way to get started. Runs in an isolated container with all dependencies.

docker run -d \ --name phlix \ -v /path/to/media:/media \ -v /path/to/config:/config \ -p 8080:8080 \ phlix/server:latest

Composer

Install as a Composer project for full control and customization.

composer create-project phlix/server:^1.0 \ --ignore-platform-reqs \ --no-interaction

Direct Install

Clone the repository and run directly with PHP CLI.

git clone https://github.com/detain/phlix-server cd phlix-server composer install php start.php start

Quick Start

1

Install Phlix

Choose your installation method above and follow the steps.

2

Configure your library

Point Phlix to your media folders. It will scan and organize automatically.

3

Install a client app

Download for Roku, Samsung TV, Windows, or mobile. Or just open a browser.

4

Start streaming

Browse your library, hit play, and enjoy your media on any device.

Need help?

Check the documentation or open an issue on GitHub.