openrtmp/librtmp2-server-panel repository overview

⁠librtmp2-server-panel

Web UI for librtmp2-server⁠: stream management, live stats, publish/play URLs and cluster status.

Source, full documentation and issue tracker: github.com/OpenRTMP/librtmp2-server-panel⁠

The panel is a thin REST client — it needs a running librtmp2-server and that server's API token. Nothing works without them.

⁠Quick start (existing server)

docker run -d \
  --name librtmp2-server-panel \
  -p 8000:8000 \
  -e LRTMP2_API_URL=http://<server-host>:8080 \
  -e LRTMP2_STATS_URL=http://<server-host>:8080 \
  -e LRTMP2_DOMAIN=<public-host-or-ip> \
  -e LRTMP2_API_TOKEN=<server-token> \
  -e PASSWORD=<panel-password-12-chars-or-more> \
  -e SECRET_KEY=<random-32-plus-char-secret> \
  openrtmp/librtmp2-server-panel:latest

Open http://localhost:8000 and log in with USERNAME (default admin) and PASSWORD.

LRTMP2_STATS_URL is the server URL the browser can reach; it is used for copied stats links. Leave it unset if it equals LRTMP2_API_URL from the browser's point of view.

⁠Full stack (server + panel + Redis)

Copy the quickstart compose file and its .env template, then start both containers with prebuilt images:

curl -LO https://raw.githubusercontent.com/OpenRTMP/librtmp2-server-panel/main/compose.quickstart.yml
curl -LO https://raw.githubusercontent.com/OpenRTMP/librtmp2-server-panel/main/.env.example
mv .env.example .env      # fill in API token, PASSWORD and SECRET_KEY
docker compose -f compose.quickstart.yml up -d

To use Docker Hub instead of GHCR, replace the two image: lines with openrtmp/librtmp2-server:latest and openrtmp/librtmp2-server-panel:latest.

⁠Supported tags and architectures

• latest, beta, alpha — moving channels
• 0.1.15, v0.1.15 — pinned releases (both spellings are published)
• linux/amd64, linux/arm64, linux/riscv64

Mirrors: ghcr.io/openrtmp/librtmp2-server-panel and quay.io/openrtmp/librtmp2-server-panel.

⁠Ports

⁠Configuration

* Required while REQUIRE_LOGIN is enabled (the default).

The container validates configuration at startup and exits with a clear error when a required value is missing or too short.

Full variable reference: .env.example⁠ · README⁠

⁠Reverse proxy notes

For HTTPS behind nginx/Caddy/Traefik:

1. Set PANEL_PUBLIC_URL=https://panel.example.com (or SESSION_COOKIE_SECURE=true).
2. Set PANEL_ALLOW_INSECURE_HTTP=0.
3. Set TRUSTED_PROXY_COUNT=1 and TRUSTED_PROXY_IPS to the proxy network.
4. Do not strip the Host header.

⁠Health and safety

• Built-in healthcheck: GET http://localhost:8000/login
• Runs as the unprivileged user openrtmp
• Session cookies signed with SECRET_KEY; rate limiting via Redis in the compose stack

⁠License

MIT — see LICENSE⁠.