Skip to content

OpenRTMP/librtmp2-server-panel

Repository files navigation

librtmp2-server-panel

A web-based control panel for librtmp2-server. Manage streams, copy publish/play URLs, and view live stats through a simple UI.

The panel reads streams, keys, and stats directly from the server REST API. Keys are shown blurred in the overview and can be copied on click.

Configuration

Copy .env.example to .env and adjust:

Variable Description Required
LRTMP2_API_URL Base URL of librtmp2-server's HTTP API (http.bind; server-side / internal) Yes
LRTMP2_STATS_URL Browser-reachable HTTP API URL for copied stats links (defaults to LRTMP2_API_URL) No
LRTMP2_API_TOKEN Bearer token from librtmp2-server (printed once on first server startup, stored in its SQLite DB) Yes
LRTMP2_DOMAIN Public host/IP clients use to reach the RTMP listener Yes
LRTMP2_RTMP_PORT RTMP port (rtmp.bind port), default 1935 No
LRTMP2_APP Default RTMP app name for new streams, default live No
REQUIRE_LOGIN Enable panel login (True/False, default True) No
USERNAME / PASSWORD Panel admin credentials If login enabled
SECRET_KEY Flask session secret Yes

Quick Start (Docker Compose)

git clone https://github.com/OpenRTMP/librtmp2-server-panel.git
cd librtmp2-server-panel
cp .env.example .env   # set PASSWORD, SECRET_KEY, LRTMP2_DOMAIN, etc.
docker compose up -d server
docker logs librtmp2-server   # copy the generated API token
# paste token into .env as LRTMP2_API_TOKEN=
docker compose up -d panel

The server generates its API token once on first startup, stores it in SQLite (/data/server.db), and prints it to the log. It cannot be set via config or environment. The panel only needs the token in .env so it can call the REST API.

Open http://localhost:8000.

Local Development

python3 -m venv venv && source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env  # edit values
export $(grep -v '^#' .env | xargs)
python3 app.py

Features

  • Create/delete streams against librtmp2-server's REST API
  • One-click copy for publish URL, stream key, play URL, and stats URL
  • Live per-stream stats (bitrate, resolution, codec, uptime, RTT) polled from /stats?key=...
  • Optional login gate for the whole panel

About

🎥 Web-based management panel for librtmp2 RTMP server.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors