Getting Started

Welcome to Phlix Storm Chaser. This documentation covers installation, configuration, and advanced usage of the Phlix media server.

Quick Start

Run the one-line installer on any Linux or macOS system:

curl -fsSL https://raw.githubusercontent.com/detain/phlix-server/master/scripts/install.sh | sudo bash

Once installed, access the web interface at http://localhost:7777.

Installation

Docker

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

System Requirements

• Minimum: 2 CPU cores, 4GB RAM, 20GB storage
• Recommended: 4+ CPU cores, 8GB+ RAM for 4K HDR transcoding
• Hardware acceleration: NVIDIA GPU (NVENC), Intel Quick Sync, or AMD VCE

Configuration

config.yaml

server:
  host: "0.0.0.0"
  port: 7777
  ssl: false

library:
  paths:
    - "/media/movies"
    - "/media/tv"

transcoding:
  hardware: "auto"  # auto, nvenc, qsv, v4l2, or software
  quality: "high"

auth:
  mode: "local"  # local, ldap, or oauth

Transcoding

Phlix supports hardware-accelerated transcoding for efficient media conversion. Enable by setting the hardware option in config.yaml.

SyncPlay

SyncPlay synchronizes playback across multiple clients. Create a session in the web interface and share the invite code.

Hub Relay

Hub provides secure remote access without port forwarding. Enable Hub in the settings panel and download the Hub client for your devices.

API Reference

The REST API is available at /api/v1. All endpoints require authentication via Bearer token.

Plugins

Plugins are installed to /config/plugins/. Each plugin contains a manifest.json and main.js.

Troubleshooting