Closed Alpha

FluxPlay is currently in Closed Alpha. This documentation is a work in progress and may be incomplete or out of date. Features, UI, and APIs are subject to change without notice. For access inquiries, please contact [email protected].

INSTALLATION GUIDE

Get FluxPlay running on your server with Docker (recommended) or manual installation. Supports Windows, Linux, and macOS.

Prerequisites

Minimum Requirements

Operating SystemWindows 10/11, Ubuntu 20.04+, Debian 11+

ProcessorQuad-core CPU (x64 or ARM64)

Memory4 GB RAM

Storage500 MB + space for media

DatabasePostgreSQL 14 or newer

Required Dependencies

PostgreSQL 14+

Stores metadata, users, and settings

FFmpeg & FFprobe

Media analysis and transcoding

Redis (optional)

Caching; falls back to in-memory

Docker InstallationRecommended

1. Create a directory for FluxPlay

# Linux/macOS
mkdir -p /opt/fluxplay && cd /opt/fluxplay

# Windows (PowerShell)
mkdir C:\FluxPlay; cd C:\FluxPlay

2. Create docker-compose.yml

version: '3.8'
services:
  fluxplay:
    image: fluxplay/fluxplay:latest
    container_name: fluxplay
    ports:
      - "5171:5171"
    environment:
      - TZ=America/New_York
      - DATABASE_URL=postgresql://fluxplay:password@db:5432/fluxplay
    volumes:
      - ./config:/config
      - /path/to/movies:/media/movies
      - /path/to/tv:/media/tv
      - /path/to/music:/media/music
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:16-alpine
    container_name: fluxplay-db
    environment:
      - POSTGRES_USER=fluxplay
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=fluxplay
    volumes:
      - ./database:/var/lib/postgresql/data
    restart: unless-stopped

3. Start FluxPlay

docker compose up -d

Access FluxPlay at http://localhost:5171

Hardware Transcoding Setup

NVIDIA (NVENC)

RequirementsGTX 900 series or newer

Docker flag--gpus all

Best overall performance

Intel (Quick Sync)

Requirements6th gen Core or newer

Docker flag--device /dev/dri:/dev/dri

Excellent efficiency

AMD (AMF/VCN)

RequirementsRX 400 series or newer

Docker flag--device /dev/dri:/dev/dri

Good Linux support

VAAPI (Linux)

RequirementsIntel/AMD on Linux

Docker flag--device /dev/dri:/dev/dri

Universal Linux solution

Common Installation Issues

Cannot connect to FluxPlay

Check if the service is running
Verify you're using the correct port (default: 5171)
Allow the port through your firewall

Database connection failed

Ensure PostgreSQL service is started
Verify username and password in configuration
Create the database manually if needed

FFmpeg not found

Install FFmpeg from your package manager
Add FFmpeg location to system PATH
Verify version is 4.4 or newer