Get Started

Download & Install

Open-source media, on your terms.

System Requirements

Component Minimum Recommended
PHP Version PHP 8.3+ PHP 8.3 or higher
OS Linux, macOS, Windows (WSL2) Linux (Ubuntu 22.04+)
Memory 512 MB RAM 2 GB RAM
Storage 100 MB (server only) Depends on media library
Dependencies FFmpeg, MySQL/MariaDB, Composer
FFmpeg is required for transcoding. Install via your package manager or download from ffmpeg.org.

Installation Methods

Clone from GitHub

For developers and users comfortable with the command line. 

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

Download Release

Download the latest release as a zip or tarball.

# Download latest release
curl -L https://github.com/detain/phlix-server/archive/refs/tags/latest.tar.gz
tar -xzf latest.tar.gz
cd phlix-server-latest
composer install
php server.php start

Docker

Run Phlix in a container. Great for homelab setups.

# Pull and run
docker pull ghcr.io/detain/phlix-server:latest
docker run -d \
  --name phlix \
  -p 8080:8080 \
  -v /path/to/media:/media \
  ghcr.io/detain/phlix-server:latest

Quickstart Guide

1

Clone or download the repository

Get the latest Phlix server code from GitHub.

2

Install dependencies

Run composer install to fetch PHP dependencies.

3

Configure database

Set up MySQL/MariaDB and update config/database.php with your credentials.

4

Add your media

Point Phlix at your media folders in the admin UI or config.

5

Start streaming

Run php server.php start and open the web UI to start watching.

First time? Check out the full documentation for detailed setup instructions, including reverse proxy configuration and SSL certificates.

Ready to watch?

Download a client app for your device to start streaming.

Browse Clients