docker-nginx-rtmp
A Dockerfile installing NGINX, nginx-rtmp-module and FFmpeg from source with default settings for HLS live streaming. Built on Alpine Linux.
- Nginx 1.23.1 (Mainline version compiled from source)
- nginx-rtmp-module 1.2.2 (compiled from source)
- ffmpeg 5.1 (compiled from source)
- Default HLS settings (See: nginx.conf)
Usage
Server
- Pull docker image and run:
docker pull alfg/nginx-rtmp
docker run -it -p 1935:1935 -p 8080:80 --rm alfg/nginx-rtmp
or
- Build and run container from source:
docker build -t nginx-rtmp .
docker run -it -p 1935:1935 -p 8080:80 --rm nginx-rtmp
- Stream live content to:
rtmp://localhost:1935/stream/$STREAM_NAME
SSL
To enable SSL, see nginx.conf and uncomment the lines:
listen 443 ssl;
ssl_certificate /opt/certs/example.com.crt;
ssl_certificate_key /opt/certs/example.com.key;
This will enable HTTPS using a self-signed certificate supplied in /certs. If you wish to use HTTPS, it is highly recommended to obtain your own certificates and update the ssl_certificate
and ssl_certificate_key
paths.
I recommend using Certbot from Let's Encrypt.
Environment Variables
This Docker image uses envsubst
for environment variable substitution. You can define additional environment variables in nginx.conf
as ${var}
and pass them in your docker-compose
file or docker
command.
nginx.conf
Custom If you wish to use your own nginx.conf
, mount it as a volume in your docker-compose
or docker
command as nginx.conf.template
:
volumes:
- ./nginx.conf:/etc/nginx/nginx.conf.template
OBS Configuration
- Stream Type:
Custom Streaming Server
- URL:
rtmp://localhost:1935/stream
- Stream Key:
hello
Watch Stream
- Load up the example hls.js player in your browser:
http://localhost:8080/player.html?url=http://localhost:8080/live/hello.m3u8
- Or in Safari, VLC or any HLS player, open:
http://localhost:8080/live/$STREAM_NAME.m3u8
- Example Playlist:
http://localhost:8080/live/hello.m3u8
- HLS.js Player
- FFplay:
ffplay -fflags nobuffer rtmp://localhost:1935/stream/hello
FFmpeg Build
$ ffmpeg -buildconf
ffmpeg version 4.4 Copyright (c) 2000-2021 the FFmpeg developers
built with gcc 10.2.1 (Alpine 10.2.1_pre1) 20201203
configuration: --prefix=/usr/local --enable-version3 --enable-gpl --enable-nonfree --enable-small --enable-libmp3lame --enable-libx264 --enable-libx265 --enable-libvpx --enable-libtheora --enable-libvorbis --enable-libopus --enable-libfdk-aac --enable-libass --enable-libwebp --enable-postproc --enable-avresample --enable-libfreetype --enable-openssl --disable-debug --disable-doc --disable-ffplay --extra-libs='-lpthread -lm'
libavutil 56. 70.100 / 56. 70.100
libavcodec 58.134.100 / 58.134.100
libavformat 58. 76.100 / 58. 76.100
libavdevice 58. 13.100 / 58. 13.100
libavfilter 7.110.100 / 7.110.100
libavresample 4. 0. 0 / 4. 0. 0
libswscale 5. 9.100 / 5. 9.100
libswresample 3. 9.100 / 3. 9.100
libpostproc 55. 9.100 / 55. 9.100
configuration:
--prefix=/usr/local
--enable-version3
--enable-gpl
--enable-nonfree
--enable-small
--enable-libmp3lame
--enable-libx264
--enable-libx265
--enable-libvpx
--enable-libtheora
--enable-libvorbis
--enable-libopus
--enable-libfdk-aac
--enable-libass
--enable-libwebp
--enable-postproc
--enable-avresample
--enable-libfreetype
--enable-openssl
--disable-debug
--disable-doc
--disable-ffplay
--extra-libs='-lpthread -lm'
FFmpeg Hardware Acceleration
A Dockerfile.cuda
image is available to enable FFmpeg hardware acceleration via the NVIDIA's CUDA.
Use the tag: alfg/nginx-rtmp:cuda
:
docker run -it -p 1935:1935 -p 8080:80 --rm alfg/nginx-rtmp:cuda
You must have a supported platform and driver to run this image.
- https://github.com/NVIDIA/nvidia-docker
- https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#docker
- https://docs.docker.com/docker-for-windows/wsl/
- https://trac.ffmpeg.org/wiki/HWAccelIntro#CUDANVENCNVDEC
*This image is experimental!