Appearance

OmniLux DocsBring OmniLux home with clarity.

Guides for setup, self-hosting, remote access, and the server API, shaped to match the OmniLux product experience.

Start with the guide
Run a server
Browse API docs
OmniLux
✨

Start beautifully

Learn the account, app, and first-library flow without digging through internal platform language.

🏠

Bring OmniLux home

Stand up OmniLux on Docker, NAS platforms, or bare metal with a cleaner self-hosting path.

🔐

Remote access, done clearly

Get household access, browser streaming, and remote connectivity set up with confidence.

📱

Apps and devices

Connect mobile, TV, and browser clients with the current account and pairing model.

⚙️

Server API

Work with authentication, library, playback, Live TV, and admin endpoints exposed by the server.

Choose your path ​

These docs are organized around the two journeys that matter most: enjoying OmniLux and operating OmniLux.

Experience OmniLux

Set up your account, apps, and first library flow.

Best for anyone who wants the polished OmniLux experience, from sign-in and playback to inviting the rest of the household.

Run a Server

Launch a self-hosted server and get it ready to claim.

Best for operators bringing OmniLux online across Docker, NAS platforms, or bare metal, then preparing for local and remote use.

What you'll find here ​

Guide

Product framing and onboarding

Understand the account model, device access, library flow, and household experience before you touch infrastructure.

Self-hosting

Install and operate with confidence

Deploy on Docker, NAS platforms, or bare metal, then layer in reverse proxying, updates, and environment tuning when you need them.

API

Automate against the server

Use the documented authentication, library, playback, Live TV, and admin endpoints exposed by the self-hosted server.

Current platform model ​

OmniLux docs assume two connected product surfaces:

  • The self-hosted OmniLux server running on your own hardware
  • The OmniLux cloud account that can attach to that server for apps, invites, billing, and remote services

The docs stay centered on the product experience and operator path, not internal implementation surfaces.