Omnius

Setup & Deployment

Get your Omnius streaming server running in minutes with Docker.

1. Quick Start with Docker

The fastest way to get started. Run this single command:

docker run -d \
  --name omnius \
  -p 8080:8080 \
  -e LICENSE_KEY=YOUR_LICENSE_KEY \
  -e ADMIN_PASSWORD=your_secure_password \
  -v omnius-data:/app/data \
  ghcr.io/omnius-stream/server:latest

2. Docker Compose (Recommended)

For production deployments, use Docker Compose for easier management and automatic restarts:

services:
  omnius:
    image: ghcr.io/omnius-stream/server:latest
    ports:
      - "8080:8080"
    environment:
      LICENSE_KEY: YOUR_LICENSE_KEY
      ADMIN_PASSWORD: your_secure_password
    volumes:
      - omnius-data:/app/data
    restart: unless-stopped

volumes:
  omnius-data:

Save this as docker-compose.yml and run: docker-compose up -d

3. Environment Variables

Configure your server with these environment variables:

Variable Default Description
LICENSE_KEY (empty) Your Omnius license key. Without it, only the admin panel works - JSON APIs are disabled.
ADMIN_PASSWORD admin Password for the admin panel at /admin
PORT 8080 HTTP port
DATABASE_PATH ./data/omnius.db Path to SQLite database

4. Without a License

You can run Omnius without a LICENSE_KEY, but with limited functionality:

✓ The admin panel at /admin works fully - manage your movie catalog, series, live streams, and settings
✗ JSON API endpoints (/api/v2/*.json) are disabled - returns 403 with error message
✗ Client apps (Android TV, macOS) cannot connect to the server

Purchase a license at /pricing to enable the full API and client app connectivity.

5. Try the Demo

Want to explore the admin panel before deploying your own instance?

We have a live demo instance running without a license key so you can see how the admin panel works:

Visit Demo Instance→

Note: The demo runs without a license, so API endpoints will return 403 errors.

6. After Setup

1

Access the Admin Panel

Navigate to http://your-server:8080/admin and login with your ADMIN_PASSWORD.

2

Add Content

Use the admin panel to add movies, series, and live streams to your server.

3

Configure Client Apps

Point your Android TV or macOS client apps to your server URL (e.g., http://your-server:8080).

4

License Validation

The server validates your license every 6 hours via heartbeat. Ensure your server has internet connectivity.

Need a License?

Purchase a license to unlock the full API and enable client app connectivity.

View Pricing →