Browse documentation
DocsGet started

Add your media

Mount a folder. Register a root. Import once.

Mount a folder

Create compose.override.yaml beside the release Compose file. Replace the host paths with your own.

yaml
services:
  lumina:
    volumes:
      - /srv/media/movies:/media/movies:ro
      - /srv/media/tv:/media/tv:ro
      - /srv/media/music:/media/music:ro
shell
docker compose up -d --no-build lumina

Register and import

  1. Open Manage Server → Library & storage.
  2. Add the container path, such as /media/movies, as an external root.
  3. Choose household sharing or Private, then Import now.
  4. Check discovery and indexing progress in the header activity indicator.
Root typeBehavior
ExternalIndexes in place. Never writes, moves, or deletes source files. Use :ro.
ManagedLumina can write files here. Deleted files enter quarantine before expiry.

Use predictable folders

folder layout
movies/Film (2024)/Film (2024).mkv
tv/Series/Season 01/Series S01E01.mkv
music/Artist/Album/01 Track.flac

NFO metadata and your edits take priority over fetched matches. Music tags take priority over folder names; album cover.jpg or folder.jpg takes priority over embedded art.

Keep it current

After the first import, enable scheduled scans or folder watching on the root. Use Refresh for an immediate scan. Missing mounts show as offline; a changed mount identity needs attention.

Read books and comics

Import EPUB, PDF, CBZ, or CBR files, up to 256 MiB each. Lumina keeps private managed copies under app-data/books/. PDF uses page images; EPUB supports reflow. Back up the books directory separately from database backups.

Applies to Lumina 0.4.0. Source: operator guide

Find your next step.

Type to search all documentation.