r0zbot/nginx-rtmp repository overview

⁠Supported tags and respective Dockerfile links

• latest (Dockerfile)⁠

⁠nginx-rtmp

Docker⁠ image with Nginx⁠ using the nginx-rtmp-module⁠ module for live multimedia (video) streaming, with transcoding support through ffmpeg.

⁠Description

This is a fork of tiangolo's Docker Image⁠ using Alpine for a smaller image and with added FFmpeg support, as well as a more comprehensive default nginx.conf.

This Docker⁠ image can be used to create an RTMP server for multimedia / video streaming and/or transcoding using Nginx⁠ and nginx-rtmp-module⁠, built from the current latest sources (Nginx 1.15.0 and nginx-rtmp-module 1.2.1).

The main purpose (and test case) to build it was to allow streaming from OBS Studio⁠ to both Twitch and YouTube at the same time, but with different resolutions/bitrate, since YouTube supports transcoding for everyone, and Twitch only does for partner streamers.

GitHub repo: https://github.com/r0zbot/nginx-rtmp-docker⁠

Docker Hub image: https://hub.docker.com/r/r0zbot/nginx-rtmp/⁠

⁠Details

The default configuration file supports a few modes of operation:

• RTMP Server Only: Streaming to the url rtmp://<ip_of_host>/live, you get a simple RTMP stream in -> RTMP stream out, which can be used, for example, to show another OBS instance as source. It can then be viewed (either in VLC or OBS RTMP Source) through the URL rtmp://<ip_of_host>/live/<key>, where key is the same key you used when streaming.

• RTMP Transcoding Push: Streaming to the url rtmp://<ip_of_host>/transcode, the server will call an instance of FFmpeg with the settings specified in the .env file and push its stream to the URL specified in TRANSCODE_URL with the key specified in TRANSCODE_KEY. This could be used, for example, to offload transcoding to a second computer, where you could use a slower compression setting.

• RTMP Transcoding Dual Push: Stream to the url rtmp://<ip_of_host>/transcode-dual. Same as above, but it will also push the source stream to the SOURCE_URL using the SOURCE_KEY. This could be used for streaming the source to YouTube and a more heavily compressed version to Twitch.

• RTMP Dual Push: Stream to the url rtmp://<ip_of_host>/dual. In this mode, it will dual-stream to both SOURCE_URL and TRANSCODE_URL using their respective keys, but without doing any transcoding.

⁠How to use

First, clone this repository. You will then get access to the default template, .env and docker-compose.yml files. If you wish to use the default use cases, all you need to do is edit the .env file with your settings/keys and then run docker-compose up in the folder you downloaded it to.

⁠How to test with OBS Studio and VLC

• Run a container with the command above

• Open OBS Studio⁠

• Click the "Settings" button

• Go to the "Stream" section

• In "Stream Type" select "Custom Streaming Server"

• In the "URL" enter the rtmp://<ip_of_host>/live replacing <ip_of_host> with the IP of the host in which the container is running. For example: rtmp://192.168.0.30/live

• In the "Stream key" use a "key" that will be used later in the client URL to display that specific stream. For example: test

• Click the "OK" button

• In the section "Sources" click de "Add" button (+) and select a source (for example "Screen Capture") and configure it as you need

• Click the "Start Streaming" button

• Open a VLC⁠ player (it also works in Raspberry Pi using omxplayer)

• Click in the "Media" menu

• Click in "Open Network Stream"

• Enter the URL from above as rtmp://<ip_of_host>/live/<key> replacing <ip_of_host> with the IP of the host in which the container is running and <key> with the key you created in OBS Studio. For example: rtmp://192.168.0.30/live/test

• Click "Play"

• Now VLC should start playing whatever you are transmitting from OBS Studio

For testing the transcoding option, you can just replace the live part of the url with transcoded. So, for example, if you're streaming to rtmp://192.168.0.30/transcode with the key "test", you can see the transcoded version on rtmp://192.168.0.30/transcoded/test. (NOTE: when using transcode-dual, the url for this will always be "/transcoded/$name" with no key)

⁠Debugging

If something is not working you can check the logs of the container with:

docker logs nginx-rtmp

⁠Extending

If you need to extend or modify the nginx.conf file, you have a few options:

• You can mount the nginx.conf.template file in the current directory to the container and make changes to it. This can be done by uncommenting the - ./nginx.conf.template:/etc/nginx/nginx.conf.template line in docker-compose.yml. This is great for testing, as you don't need to rebuild the image for every change you make (only restart the container).

• You can replace the image: r0zbot/nginx-rtmp:latest line with build: .. Make sure to run docker-compose build after any changes are made to the files so they get applied.

• You can create a file nginx.conf.template and replace the one in this image using a Dockerfile that is based on the image, for example:

FROM r0zbot/nginx-rtmp

COPY nginx.conf.template /etc/nginx/nginx.conf.template

You can start with this file⁠ and modify it as you need. Here's the documentation related to nginx-rtmp-module⁠.

⁠Technical details

• This image is based on the alpine docker image.

• It is built from the official sources of Nginx and nginx-rtmp-module.

• The FFmpeg version used is the most recent x64 one available when building, so this will not work on 32 bit or ARM systems at the moment.

⁠License

This project is licensed under the terms of the MIT License.