bilistream

The Web Console provides a remote interface to manage your bilistream instance, including:

• Monitoring: View status for monitoring, origin servers, Bilibili, and FFmpeg.
• Notifications: View notification strategies and toggle channel switches.
• Configuration: Edit config.yaml online.
• Control: Remotely start/stop monitoring and reload configurations.
• Logs: View recent execution logs.
• System Info: View version number and GitHub repository links.

bilistream supports multiple notification channels and a hierarchical toggle system.

Supported Channels (Notification.Channel):

• gotify
• ntfy
• both (sends to both services)

Toggle Hierarchy: Notifications are controlled by a master switch and individual channel switches. All active switches must be true for a notification to be sent via a specific channel:

1. Notification.Enabled: The master switch for all notifications.
2. Notification.GotifyEnabled: Specific switch for Gotify.
3. Notification.NtfyEnabled: Specific switch for ntfy.

To run the bilistream binary directly on Linux, you must ensure the following dependencies are installed on your system:

• ffmpeg
• python3
• yt-dlp (installed via pip)

Installation steps for dependencies:

apt update
apt install -y ffmpeg python3 python3-pip
pip3 install -U yt-dlp

Execution:

./bilistream

The built-in Web Console allows for remote management of bilistream. It is accessible via the address configured in WebConsole.Addr (default 0.0.0.0:9090).

Capabilities:

• Monitoring: View status for the source site, Bilibili, FFmpeg, and notifications.
• Control: Remotely start/stop monitoring or reload the configuration.
• Configuration: Edit config.yaml directly in the browser.
• Logs: View recent execution logs.
• Information: View current version and GitHub repository links.

You can deploy bilistream using Docker. Ensure you map the port 9090 to access the Web Console and mount your config.yaml as a writable volume so the console can save changes online.

Important: The cookies.txt volume should be mounted as read-only (:ro) if it is only used for authentication context.

services:
  bilistream:
    image: ghcr.io/limitcool/bilistream:v0.2.0
    restart: unless-stopped
    ports:
      - "9090:9090"
    volumes:
      - ./config.yaml:/app/config.yaml
      - ./cookies.txt:/app/cookies.txt:ro

Starting from v0.2.0, bilistream includes a built-in Web Console for remote management. By default, the console listens on 0.0.0.0:9090. You can access it via your browser at http://<your-server-ip>:9090.

To restrict access to the local machine only, change the WebConsole.Addr setting in your configuration to 127.0.0.1:9090.

WebConsole:
  Addr: 0.0.0.0:9090

The Web Console uses Basic Auth configured in config.yaml.

• To enable authentication, provide a Username and Password under the WebConsole section.
• If Password is left empty, authentication is disabled.
• Security Note: Do not expose a console without a password to the public internet. If the program detects public listening with an empty password during startup, it will automatically generate a random password and write it to config.yaml.
• If no config.yaml exists on first startup, the program will automatically initialize one.

WebConsole:
  Addr: 0.0.0.0:9090
  Username: admin
  Password: change-me

The YouTube platform implementation for bilistream relies on the external yt-dlp binary to resolve live stream URLs. To ensure successful stream monitoring and URL extraction, yt-dlp must be installed and available in your system's PATH.

If you are monitoring channels that require authentication (e.g., age-restricted content), you must provide a path to a cookies file in your configuration.

To use the Twitch plugin for stream monitoring and URL extraction, the following must be true:

1. yt-dlp: The yt-dlp binary must be installed and available in your system's PATH.
2. Cookies (Optional): If the stream requires authentication or specific access, ensure the cookies field in your Config points to a valid cookie file path. This path is passed to the yt-dlp command.