Get started

Download and install Phlix in minutes.

PHP 8.3+ and Composer. That's the only thing your server needs.

Quick start

Clone and run

Terminal — Linux / macOS / Windows (WSL)

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

With Docker

Docker

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

With Docker Compose

docker-compose.yml

services:
  phlix:
    image: detain/phlix-server:latest
    container_name: phlix
    ports:
      - "8080:8080"
    volumes:
      - /path/to/your/media:/media:ro
    restart: unless-stopped

PHP

8.3 or higher with extensions: pdo, json, mbstring, curl, zip, gmp, pcntl, posix, sockets

Web server

Workerman 5.x (included via Composer). Reverse-proxy with nginx or Caddy for TLS termination.

Storage

Local filesystem, NFS, or SMB mount. All media formats FFmpeg can read are supported.

Network

LAN exposure for local clients. Port 8080 TCP. Hub relay connects outbound on port 443.

Need help? The full setup guide covers reverse-proxy configuration, TLS, and troubleshooting.

View on GitHub Full documentation