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].

QUICK START

Get FluxPlay up and running in under 5 minutes. Follow this visual checklist for the fastest path to streaming your media.

5-Minute Checklist

Install FluxPlay

Docker or manual installation

2 min

Create owner account

Set up your admin credentials

30 sec

Add a media library

Point to your media folders

1 min

Wait for scan

Initial scan runs automatically

1-5 min

Start watching!

Browse and play your content

—

Essential Settings

Setting	Location	Default	Recommended
Server Name	Settings → General	FluxPlay	Your choice
Base URL	Settings → Network	localhost:5171	Your domain
Hardware Accel	Settings → Transcoding	Auto	Enable if GPU
Default Quality	Settings → Playback	Auto	Auto
Library Scan	Settings → Libraries	Every 4h	As needed

Adding Content

Folder Structure

Movies/
├── Inception (2010)/
│   └── Inception (2010).mkv
└── The Matrix (1999)/
    └── The Matrix (1999).mkv

TV Shows/
└── Breaking Bad (2008)/
    ├── Season 01/
    │   ├── S01E01.mkv
    │   └── S01E02.mkv
    └── Season 02/
        └── S02E01.mkv

Quick Tips

Include the year in folder names for better matching
Use S01E01 format for TV episode numbering
Keep subtitles in the same folder as videos
Separate different media types into different libraries
Use descriptive folder names for collections

Inviting Users

Navigate to Users

Go to Settings → Users and click "Add User"

Set Permissions

Choose their role and which libraries they can access

Share Login

Send them the server URL and their credentials

You're All Set!

Your FluxPlay server is ready. Browse your libraries, start streaming, and enjoy your media collection from any device.