Dashboard
KRZN Live includes a dashboard, that is enabled by default and reachable with any browser at http://localhost:9990.
On Windows, the dashboard is also available as an app: when the server starts, it opens in its own window (based on Microsoft Edge WebView2, included in Windows 10 and 11), and an icon appears in the notification area. Closing the window keeps the server running in the background; clicking the icon reopens the window, and its menu allows to open the dashboard in the browser or to stop the server. The menu also allows to start the app with Windows (in the tray, without opening the window).
Only one copy of the app runs at a time: launching it again brings the running one to the front. If the old KRZN Live or frpc programs are running, the app offers to stop them, since it replaces them and they use the same ports. If the server stops unexpectedly, it is restarted automatically. While at least one stream is online, the computer is kept awake (preventSleep). When the server is started by double clicking it, the console window is hidden; when it's started from a terminal, logs are still printed there. Set dashboardWindow: false to use the browser instead of the window.
The dashboard provides:
- Status: uptime, online streams, viewers, bandwidth, errors, tunnel status, the public IP of this server, server listeners and the latest events;
- Multiviewer: plays up to 9 streams at once, in a grid;
- Stream Paths: add, rename and remove stream paths (with a label). For each path, the exact fields to type into the encoder and the URL to watch it are shown, depending on the selected encoder (OBS or vMix), publishing protocol (RTMP or SRT), playback protocol (HLS, RTSP, WebRTC, SRT) and route (Home, VPS or LAN), with copy buttons. Each path can also require a stream key, be received through the VPS edge, show a reconnecting slate when the site drops, be recorded, and be published as a NDI source for vMix and other production software, with its tally (LIVE in vMix). Paths are saved into the configuration file;
- Recordings: the recordings of every feed, to play or download them;
- Ports & URLs: every port, with its URL for each route and its status through the VPS;
- Events: streams going online or offline, encoder reconnections, corrupted frames, drops of the incoming bitrate, tunnel ports going down or up, changes of the public IP, errors. New errors are notified on every page;
- Logs: the full log, updated in real time, with filters, search, pause and download;
- VPS tunnel: the status of every port exposed through the tunnel, and of the VPS edge with the sites connected to it;
- Settings: changes are applied immediately and saved into the configuration file, keeping its comments. Tunnel settings and paths can be imported from an old frpc and KRZN Live setup.
Routes
URLs are shown for three routes:
- Home: encoders and viewers connect directly to the public IP of this server (
publicAddress, or the IP detected automatically). The ports must be forwarded on the router. - VPS: encoders and viewers connect to the VPS, and traffic reaches this server through the tunnel. Nothing is needed on the router.
- LAN: devices on the same network.
The public IP is detected every 5 minutes (through api.ipify.org); when it changes, an event is raised, since URLs that use the old IP stop working.
Stream keys
By default, anyone who knows the address of the server can publish to a path. Require a stream key generates a key for a path (publishKey in the path configuration): from then on, only encoders that provide it can publish, and the fields shown for the path already contain it:
- RTMP: stream key
path?key=KEY; - SRT: stream ID
publish:path:path:KEY; - RTSP: user
path, passwordKEY; - WebRTC (WHIP):
Authorization: Bearer KEY.
Generating a new key disconnects the encoder that is publishing, which must be updated with the new fields. Reading is not affected.
Reconnecting slate
When a site drops, viewers, vMix and OBS are disconnected from its path, and must reconnect. With Enable reconnecting slate, they stay connected and receive an "offline" picture until the site comes back (this uses the always-available feature). Since the picture and the feed are joined without re-encoding, the site must keep sending the same kind of tracks: they are copied from the live feed when the slate is enabled, therefore the site must be live at that moment.
Password
The dashboard asks for a password only (there's no username). When no password is set, the dashboard can be opened only on the computer that runs the server. In order to open it from other devices (on the local network or through the tunnel), set a password in the Settings page of the dashboard, or in the configuration file:
dashboardPass: a-password
Passwords set through the dashboard are saved as a hash. After 5 wrong passwords, an address is locked out for 5 minutes; after 30 wrong passwords in a minute from any address, logins are suspended for a minute. Since connections through the tunnel all come from the same address, a short password exposed through the tunnel can lock out legitimate users during an attack: prefer a long one. When the dashboard is exposed on the Internet, enable encryption too (dashboardEncryption: true, with a certificate in dashboardServerKey and dashboardServerCert), otherwise the password travels in clear text.
The monitor plays streams with the WebRTC server (or the HLS server, when WebRTC is disabled). When the dashboard uses HTTPS, the WebRTC server must use HTTPS too, since browsers block insecure content inside secure pages.
Disable
dashboard: false
tray: false