Skip to content

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

LIBRARY MANAGEMENT

Create, configure, and manage your media libraries. Libraries are the foundation of how FluxPlay organizes and presents your content.

Library Types

Movies

Feature films, documentaries, shorts

Single video files representing complete works

TV Shows

Series with seasons and episodes

Episodic content organized hierarchically

Music

Songs, albums, playlists

Audio tracks and music videos

Books

Ebooks, novels

EPUB, PDF, and MOBI files

Comics

Comic books, manga, graphic novels

CBZ, CBR, and image archives

Audiobooks

Spoken-word audio

Audio files grouped by book

Creating Libraries

Step-by-Step Guide

  1. 1
    Navigate to Settings → Libraries
    Access from the admin menu or Mission Control
  2. 2
    Click "Add Library"
    Opens the library creation wizard
  3. 3
    Select a Library Type
    Choose from Movies, TV Shows, Music, Books, etc.
  4. 4
    Enter a Display Name
    E.g., "Movies", "Kids TV", "My Music"
  5. 5
    Add Folders
    Click "Add Folder" to add one or more media locations
  6. 6
    Configure Options
    Set metadata language, providers, and scan preferences
  7. 7
    Click "Create Library"
    FluxPlay begins scanning immediately

Library Settings

Display Options

Library NameFriendly name shown in the interface
Library IconCustom icon for the library
Default SortHow items are ordered by default
Items Per PageNumber of items shown in grid view

Scanning Options

Monitor for ChangesAuto-detect new files
Scan IntervalHow often to check for changes
Include HiddenScan dot-files and folders
Ignore PatternsFiles to skip during scan

Metadata Options

Preferred LanguageLanguage for titles and descriptions
Provider PriorityWhich metadata sources to use
Auto-Fetch MetadataDownload metadata automatically
Prefer LocalPrioritize NFO/local metadata

Access Control

Visible to UsersWhich users can see this library
Download PermissionAllow offline downloads
Quality LimitsMax streaming quality
Parental RatingContent rating restrictions

Multi-Folder Libraries

A single library can contain multiple folders from different locations. Content from all folders appears together in one unified view.

My Movies Library:
├── /media/movies          (Local SSD)
├── /nas/archive/movies    (Network Storage)
└── /external/films        (USB Drive)

All folders appear as one library in the interface.
Use Cases

Split content across drives, mix local and network storage

Note

All folders must contain the same content type

File Permissions

FluxPlay needs read access to your media folders. For Docker installations, folders must be properly mounted.

Linux/Docker

chown -R 1000:1000 /media
chmod -R 755 /media

Docker Volume Mount

volumes:
  - /path/to/movies:/media/movies

Library Best Practices

  • Keep different media types in separate libraries
  • Use descriptive names for multiple libraries of the same type
  • Enable real-time monitoring for active download folders
  • Set up proper folder structures before creating libraries
  • Consider creating a "Kids" library with parental controls