Quick Start

Choose your installation method. Docker is recommended for most users.

Docker

Pull the official image and run with persistent storage for your media and config.

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

Docker Compose

Use a compose file for easier configuration and upgrades.

services:
  phlix:
    image: detain/phlix:latest
    ports:
      - "8080:8080"
    volumes:
      - /path/to/media:/media
      - phlix-config:/config
  volumes:
    phlix-config:

Direct Installation

Clone the repository and install dependencies via Composer.

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

System Requirements

Lightweight enough to run on a Raspberry Pi, powerful enough for a 4K home theater.

PHP 8.3+

Required. PHP 8.3 or newer with extensions: pdo, json, gd, mbstring, xml, zip

Workerman 5.x

Included via Composer. Async PHP runtime for handling concurrent connections.

FFmpeg

Required for transcoding. Install via your package manager or from ffmpeg.org

Storage

Minimum 100MB for application. Media storage depends on your library size.

Network

LAN recommended. Port 8080 for web interface, optional UPnP for DLNA discovery.

OS Support

Linux (recommended), macOS, Windows (via WSL2). ARM support for Raspberry Pi.

Next Steps

Once Phlix is running, the web interface will guide you through initial setup.

1. Access the Web UI

Open http://localhost:8080 (or your server's IP) to access the setup wizard.

2. Add Your Media

Point Phlix to your media folders. The scanner will organize and fetch metadata automatically.

3. Install a Client

Download a client app for your devices from the Clients page.

View Clients

4. Read the Docs

Learn about advanced features, plugins, and configuration options.

Documentation