asanrom/rtmp-server-rs repository overview

⁠RTMP Server (Rust Implementation)

This is a RTMP (Real Time Messaging Protocol) server for live streaming broadcasting, implemented in Rust⁠.

Git Repository: https://github.com/AgustinSRG/rtmp-server-rs⁠

⁠Usage

In order to run the server you have to run a docker container from this image. A good way to do it is to use docker compose⁠. Here is an example compose file:

version: "3.7"

services:
  rtmp_server:
    image: asanrom/rtmp-server-rs
    ports:
      - "1935:1935"
      #- '443:443'
    environment:
      # Configure it using env vars:
      - PLAY_ALLOWED_FROM=*
      - CONCURRENT_LIMIT_WHITELIST=*
      - REDIS_USE=NO
      - LOG_REQUESTS=YES
      - LOG_DEBUG=NO
      - GOP_CACHE_SIZE_MB=0

The server will listen by default in the port 1935.

The server will accept RTMP connections with the following schema:

rtmp://{HOST}/{CHANNEL}/{KEY}

Note: Both CHANNEL and KEY are restricted to letters a-z, numbers 0-9, dashes - and underscores _.

By default, it will accept any connections. If you need to restrict the access or customize the server in any way, you can use environment variables.

⁠RTMP play restrict

You probably only want external users to be able to publish to the RTMP server, since spectators probably receive the stream using other protocol, like HLS or MPEG-Dash.

In order to do that, set the RTMP_PLAY_WHITELIST to a list of allowed internet addresses split by commas. Example: 127.0.0.1,10.0.0.0/8. You can set IPs, or subnets. It supports both IP version 4 and version 6.

⁠Event callback

In order to restrict the access and have control over who publishes, the RTMP server can send requests to a remote server with the information of certain events.

Set the CALLBACK_URL environment variable to the remote server that is going to handle those events:

• When an user wants to publish, to validate the streaming channel and key. (start)
• When a session is closed, meaning the live streaming has ended. (stop)

The events are sent as HTTP(S) POST requests to the given URL, with empty body, and with a header with name rtmp-event, containing the event data encoded as a Base 64 JWT (JSON Web Token), signed using a secret you must provide using the JWT_SECRET environment variable.

The JWT is signed using the algorithm HMAC_256.

The JWT contains the following fields:

• Subject (sub) is rtmp_event.
• Event name (event) can be start or stop.
• Channel (channel) is the requested channel to publish.
• Key (key) is the given key to publish.
• Stream ID (stream_id) is the unique ID for the stream session, It is undefined for the start event, since is not known yet.
• Client IP (client_ip) is the client IP for logging purposes.

For the start event, the event handler server must return with status code 200, and with a header with name stream-id, containing the unique identifier for the RTMP publishing session. If the server does not return with 200, the server will consider the key is invalid and it will close the connection with the client. You can use this to validate streaming keys.

⁠Redis

This server supports listening for commands using Redis Pub/Sub.

To configure it, set the following variables:

The commands have the following structure:

COMMAND>ARG_1|ARG2|...

Each command goes in a separate message.

List of commands:

• kill-session>CHANNEL - Closes any sessions for that specific channel.
• close-stream>CHANNEL|STREAM_ID - Closes specific connection.

These commands are meant to stop a streaming session once started, to enforce application-specific limits.

⁠Control server

In order to integrate this RTMP server with tcp-video-streaming⁠'s control server, set CONTROL_USE to YES.

Also, configure the following variables:

Note: Enabling the control server will disable the callback request feature, replacing it with requests to the control server instead.

⁠TLS

If you want to use TLS, you have to set the following variables in order for it to work:

⁠Log options

Here is a list of options to customize log messages:

⁠DOS mitigation options

List of options made to mitigate DOS (Denial of Service) attacks.

⁠Performance options

Lis of options related to performance.

⁠More options

Here is a list with more options you can configure: