OmniLux Docs

Appearance

OmniLux Documentation

User guides, self-hosting setup, and developer reference for the OmniLux platform.

Start Here
Run a Server
🧭

Start Here

Understand the OmniLux model: self-hosted server, optional cloud account, and paid cloud-connected services.

🚀

First-Time Setup

Go from account creation to first playback, including claiming, scanning, and app sign-in.

📦

Self-Hosting

Run OmniLux on Docker, TrueNAS, Unraid, Synology, or bare metal with a cleaner operator path.

📱

Apps and Devices

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

📡

Remote and Sharing

Add family members and choose between Tailscale, public domains, or relay-based access.

🛠️

Build and Extend

Use the plugin system, REST API, and cloud platform docs to integrate or contribute.

Choose your path ​

Use OmniLux

Start with the account, apps, and first library flow.

Best for anyone who wants to stream, invite people, or understand the cloud-linked experience before worrying about implementation details.

Run a Server

Get a self-hosted install online and ready to claim.

Best for operators setting up Docker, NAS, or bare-metal infrastructure and preparing a server for local or remote use.

Build on OmniLux

Work with plugins, APIs, and cloud platform internals.

Best for contributors, integrators, and anyone extending the product or running the public-facing cloud stack.

What changed ​

OmniLux docs now assume two distinct surfaces:

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

If a page is meant for contributors or operators rather than regular users, it now lives in the dedicated technical sections instead of the main onboarding flow.

Use OmniLux, run your own server, or build on the platform.

OmniLux