nilsost/nlpt-rtmp-server repository overview

⁠NLPT RTMP Server

A local streaming broker based on nginx-mod-rtmp, provided by an docker image.

The image is designed to be used as a container on our TrueNAS server, alongside a LanCache instance, in host-mode. Therefore the WebPort defaults to 8088, this is also reflected in the example docker-compose.yml (with nat-mode). If you have port 80 available on the system you like to nlpt-rtmp-server on, feel free to change the nated port to 80. But remember, that the examples expect 8088.

⁠Config

set the environment variable DISABLE_RECORDING=true to not record all incomming streams. By default all streams are recorded.

Create a volume to /var/www/html/recordings if you like to store the recordings outside the container.

⁠Connecting (using) the Server

In the following configs are two variables <address> and <stream_key>

• <address> is the IP or DNS of your RTMP Server
• <stream_key> is the identifier for a specific stream on your RTMP Server. It can be choosen freely, if this key does not already exists, it's created on runtime. BUT the stream_key has to match on sending an receiving side, just in case this is not obvious ;)

⁠Sending Stream

The default-port of rtmp protocol is 1935 which is used by this container.

The direct endpoint is: rtmp://<address>/live/<stream_key>

In OBS you would configure this as:

• Streaming Service: Custom
• Server: rtmp://<address>/live
• Play Path/Stream Key: <stream_key>

⁠Receiving Stream

The default port for http traffic, that is used by this container, is 8088.

There are two formats available to receive the stream Apple's HLS and MPEG DASH. HLS is the slightly more advanced one, regarding the configuration options serverwise.

HLS-URL: http://<address>:8088/hls/<stream_key>.m3u8
DASH-URL: http://<address>:8088/dash/<stream_key>.mpd

⁠Development

Development is happening in https://github.com/nlptournament/nlpt-rtmp-server⁠