tiangolo/nginx-rtmp

https://github.com/tiangolo/nginx-rtmp-docker/workflows/Deploy/badge.svg](https://github.com/tiangolo/nginx-rtmp-docker/actions?query=workflow%3ADeploy)

Supported tags and respective Dockerfile links

• https://github.com/tiangolo/nginx-rtmp-docker/blob/master/Dockerfile

Note: Note: There are https://hub.docker.com/r/tiangolo/nginx-rtmp/tags. If you need to "pin" the Docker image version you use, you can select one of those tags. E.g. tiangolo/nginx-rtmp:latest-2020-08-16.

nginx-rtmp

Docker image with Nginx using the https://github.com/arut/nginx-rtmp-module module for live multimedia (video) streaming.

Description

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

This was inspired by other similar previous images from https://hub.docker.com/r/dvdgiessen/nginx-rtmp-docker/, https://hub.docker.com/r/jasonrivers/nginx-rtmp/, https://hub.docker.com/r/aevumdecessus/docker-nginx-rtmp/ and by an OBS Studio post.

The main purpose (and test case) to build it was to allow streaming from OBS Studio to different clients at the same time.

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

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

Details

How to use

• For the simplest case, just run a container with this image:

bash
docker run -d -p 1935:1935 --name nginx-rtmp tiangolo/nginx-rtmp

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 the "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

Manual RTMP playback test

You can also verify retransmission by watching the stream yourself. First build and run the image:

bash
docker build -t nginx-rtmp-test .
docker run --rm --name nginx-rtmp-test -p 1935:1935 nginx-rtmp-test

In a second terminal, publish a generated test stream:

bash
./scripts/publish-test-stream.sh

This publisher is intentionally long-running and will not exit on its own. Leave it running while you watch the stream, then stop it with Ctrl+C.

In a third terminal, watch the retransmitted stream:

bash
ffplay rtmp://127.0.0.1:1935/live/test

You should see the moving FFmpeg test pattern and hear a generated tone. VLC can also open rtmp://127.0.0.1:1935/live/test as a network stream.

Debugging

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

bash
docker logs nginx-rtmp

Extending

If you need to modify the configurations you can create a file nginx.conf and replace the one in this image using a Dockerfile that is based on the image, for example:

Dockerfile
FROM tiangolo/nginx-rtmp

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

The current nginx.conf contains:

Nginx
worker_processes auto;
rtmp_auto_push on;
events {}
rtmp {
    server {
        listen 1935;
        listen [::]:1935 ipv6only=on;

        application live {
            live on;
            record off;
        }
    }
}

You can start from it and modify it as you need. Here's the https://github.com/arut/nginx-rtmp-module/wiki/Directives.

RTMPS (RTMP with TLS)

This image includes Nginx stream SSL support, so you can terminate TLS in Nginx and proxy the decrypted RTMP connection to the RTMP application. With this setup, clients publish and play through rtmps://<domain>/live/<key> on port 1935, while the internal RTMP server listens on 127.0.0.1:1936.

Create an nginx.conf like this, replacing the certificate paths with paths available inside your container:

Nginx
worker_processes auto;
rtmp_auto_push on;
events {}

stream {
    upstream backend {
        server 127.0.0.1:1936;
    }

    server {
        listen 1935 ssl;
        proxy_pass backend;
        ssl_certificate /etc/nginx/certs/fullchain.pem;
        ssl_certificate_key /etc/nginx/certs/privkey.pem;
    }
}

rtmp {
    server {
        listen 1936;
        chunk_size 4096;

        application live {
            live on;
            record off;
        }
    }
}

Then build a small image with your custom configuration:

Dockerfile
FROM tiangolo/nginx-rtmp

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

Run it with your TLS certificates mounted into the container:

bash
docker run -d \
  -p 1935:1935 \
  -v /path/to/certs:/etc/nginx/certs:ro \
  --name nginx-rtmps \
  your-nginx-rtmps-image

For example, if your certificate files are mounted as /etc/nginx/certs/fullchain.pem and /etc/nginx/certs/privkey.pem, configure an RTMPS client to use:

text
rtmps://<domain>/live/<key>

Technical details

• This image is built from the same base official images that most of the other official images, as Python, Node, Postgres, Nginx itself, etc. Specifically, https://hub.docker.com/_/buildpack-deps/ which is in turn based on https://hub.docker.com/_/debian/. So, if you have any other image locally you probably have the base image layers already downloaded.

• It is built from the official sources of Nginx and nginx-rtmp-module without adding anything else. (Surprisingly, most of the available images that include nginx-rtmp-module are made from different sources, old versions or add several other components).

• It has a simple default configuration that should allow you to send one or more streams to it and have several clients receiving multiple copies of those streams simultaneously. (It includes rtmp_auto_push and an automatic number of worker processes).

Release Notes

Latest Changes

• ⬆ Bump docker/build-push-action from 6 to 7. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/111 by https://github.com/apps/dependabot.
• ⬆ Bump docker/setup-buildx-action from 3 to 4. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/112 by https://github.com/apps/dependabot.
• 👷 Upgrade actions/checkout from v5 to v6. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/109 by https://github.com/tiangolo.

Features

• ✨ Add support, docs and tests for TLS. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/120 by https://github.com/tiangolo.

Internal

• 👷 Add CI tests. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/119 by https://github.com/tiangolo.
• ⬆ Bump the github-actions group across 1 directory with 2 updates. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/118 by https://github.com/apps/dependabot.
• 🔥 Remove config files now in GitHub central repo. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/115 by https://github.com/tiangolo.
• 👷 Update Dependabot. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/113 by https://github.com/tiangolo.
• ⬆ Bump actions/checkout from 5 to 6. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/107 by https://github.com/apps/dependabot.
• 👷 Upgrade latest-changes GitHub Action and pin actions/checkout@v5. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/108 by https://github.com/tiangolo.
• ⬆ Bump tiangolo/latest-changes from 0.3.2 to 0.4.0. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/103 by https://github.com/apps/dependabot.
• ⬆ Bump peter-evans/dockerhub-description from 4 to 5. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/105 by https://github.com/apps/dependabot.
• ⬆ Bump tiangolo/issue-manager from 0.5.1 to 0.6.0. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/106 by https://github.com/apps/dependabot.
• ⬆ Bump actions/checkout from 4 to 5. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/104 by https://github.com/apps/dependabot.
• ⬆ Bump tiangolo/latest-changes from 0.3.1 to 0.3.2. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/98 by https://github.com/apps/dependabot.
• ⬆ Bump tiangolo/issue-manager from 0.5.0 to 0.5.1. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/96 by https://github.com/apps/dependabot.
• 👷 Update issue-manager.yml. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/95 by https://github.com/tiangolo.
• ⬆ Bump docker/build-push-action from 5 to 6. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/92 by https://github.com/apps/dependabot.
• 👷 Update latest-changes GitHub Action. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/93 by https://github.com/tiangolo.
• ⬆ Bump docker/build-push-action from 2 to 5. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/68 by https://github.com/apps/dependabot.
• ⬆ Bump docker/setup-buildx-action from 1 to 3. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/67 by https://github.com/apps/dependabot.
• ⬆ Bump docker/login-action from 1 to 3. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/69 by https://github.com/apps/dependabot.
• 👷 Update issue-manager.yml GitHub Action permissions. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/76 by https://github.com/tiangolo.
• 👷 Update issue-manager.yml GitHub Action permissions. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/75 by https://github.com/tiangolo.
• 🔧 Add GitHub templates for discussions and issues, and security policy. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/72 by https://github.com/alejsdev.
• 🔧 Update latest-changes.yml. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/70 by https://github.com/alejsdev.

0.0.1

Features

• ✨ Allow using debug directives, enable --with-debug compile option. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/16 by https://github.com/agconti.
• ✨ Add support for multiarch builds, including ARM (e.g. Mac M1). PR https://github.com/tiangolo/nginx-rtmp-docker/pull/65 by https://github.com/tiangolo.

Fixes

• 👷 Fix multiarch deploy build. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/66 by https://github.com/tiangolo.

Docs

• ✏️ Fix a typo in README. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/20 by https://github.com/Irishsmurf.

Upgrades

• ⬆️ Upgrade Nginx to 1.23.2 and OS to bullseye. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/40 by https://github.com/tiangolo.
• ⬆ Upgrade to nginx-1.19.7. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/26 by https://github.com/cesarandreslopez.
• ⬆ Update RTMP module version to 1.2.2. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/28 by https://github.com/louis70109.
• Upgrade Nginx to version 1.18.0. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/13 by https://github.com/Nathanael-Mtd.

Internal

• 👷 Update token for latest changes. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/50 by https://github.com/tiangolo.
• 👷 Add GitHub Action for Docker Hub description. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/45 by https://github.com/tiangolo.
• Bump tiangolo/issue-manager from 0.3.0 to 0.4.0. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/42 by https://github.com/apps/dependabot.
• Bump actions/checkout from 2 to 3. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/43 by https://github.com/apps/dependabot.
• 🎨 Format CI config. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/44 by https://github.com/tiangolo.
• 👷 Add Dependabot and funding configs. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/41 by https://github.com/tiangolo.
• 👷 Add scheduled CI. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/39 by https://github.com/tiangolo.
• 👷 Add alls-green GitHub Action. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/38 by https://github.com/tiangolo.
• 👷 Build to test on CI for PRs, update GitHub Actions. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/37 by https://github.com/tiangolo.
• 👷 Add Latest Changes GitHub Action. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/29 by https://github.com/tiangolo.
• Add CI with GitHub actions. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/15.
• ⬆ Bump peter-evans/dockerhub-description from 3 to 4. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/63 by https://github.com/apps/dependabot.
• ⬆ Bump tiangolo/issue-manager from 0.4.1 to 0.5.0. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/64 by https://github.com/apps/dependabot.
• Bump actions/checkout from 3 to 4. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/52 by https://github.com/apps/dependabot.
• ⬆ Bump tiangolo/issue-manager from 0.4.0 to 0.4.1. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/61 by https://github.com/apps/dependabot.
• 👷 Update dependabot. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/55 by https://github.com/tiangolo.
• 👷 Update latest-changes. PR https://github.com/tiangolo/nginx-rtmp-docker/pull/54 by https://github.com/tiangolo.

License

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