Technical Reference

Docs

Everything you need to configure, extend, and troubleshoot Phlix. Installation guides, API reference, plugin SDK, and a full troubleshooting section.

Quick Start

Install Phlix Server in under a minute with a single command. Covers Linux, macOS, Windows, and Docker across three installation methods.

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

Configuration

config.json, environment variables, admin panel, CLI tool. Every setting documented with defaults and examples for both beginners and power users.

API Reference

Full RESTful JSON API. Authentication, media endpoints, library management, SyncPlay rooms, user management, and webhook configuration.

Plugin SDK

Build and distribute plugins. Manifest format, catalog providers, metadata hooks, lifecycle events, and the submission process for the official repo.

Installation

Linux, macOS, Windows, Docker, FreeBSD, NAS systems.

Command Line

CLI tool for configuration, user management, and diagnostics.

Transcoding

Hardware GPU acceleration, codec support matrix, quality tuning.

Troubleshooting

Common errors, performance diagnostics, log file locations.

API Documentation

Full interactive API docs are available at /api/docs on your running Phlix server. All endpoints, parameters, and response schemas documented with live test support.