Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davetacker/rtmp-server
Docker image for video streaming server that supports RTMP, RTMPS, HLS, and DASH streams.
https://github.com/davetacker/rtmp-server
docker dockercompose nginx rtmp-server rtmp-stream rtmps stunnel
Last synced: 8 days ago
JSON representation
Docker image for video streaming server that supports RTMP, RTMPS, HLS, and DASH streams.
- Host: GitHub
- URL: https://github.com/davetacker/rtmp-server
- Owner: DaveTacker
- License: mit
- Created: 2024-06-10T19:19:09.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-07-11T20:16:37.000Z (4 months ago)
- Last Synced: 2024-10-12T12:22:50.888Z (about 1 month ago)
- Topics: docker, dockercompose, nginx, rtmp-server, rtmp-stream, rtmps, stunnel
- Language: HTML
- Homepage: https://hub.docker.com/r/kneeki/rtmp-server
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# RTMP-HLS Server using NGINX
Docker image for video streaming server that supports RTMP, RTMPS, HLS, and DASH streams.
## Description
This Docker image can be used to create a video streaming server that supports [**RTMP**](https://en.wikipedia.org/wiki/Real-Time_Messaging_Protocol), [**HLS**](https://en.wikipedia.org/wiki/HTTP_Live_Streaming), [**DASH**](https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP) out of the box. It also allows adaptive streaming and custom transcoding of video streams. All modules are built from source on Debian and Alpine Linux base images.
Current Image is built using:
* Nginx 1.19.0 (compiled from source)
* Nginx-rtmp-module 1.2.1 (compiled from source)
* FFmpeg (compiled from source)
* Stunnel (installed from apt)
This image was inspired by similar docker images from [tiangolo](https://hub.docker.com/r/tiangolo/nginx-rtmp/) and [alfg](https://hub.docker.com/r/alfg/nginx-rtmp/). It has small build size, adds support for HTTP-based streams and adaptive streaming using FFmpeg.
## Features
* The backend is [**Nginx**](http://nginx.org/en/) with [**nginx-rtmp-module**](https://github.com/arut/nginx-rtmp-module).
* [**FFmpeg**](https://www.ffmpeg.org/) for transcoding and adaptive streaming.
* [**Stunnel**](https://www.stunnel.org/) for secure RTMP (RTMPS) support.
* Default settings:
* ✅ RTMP
* ✅ HLS (adaptive, 5 variants)
* ✅ DASH
* Other Nginx configuration files are also provided to allow for RTMP-only streams or no-FFmpeg transcoding.
* Statistic page of RTMP streams at `http://:/stats`.
* Available web video players (based on [video.js](https://videojs.com/) and [hls.js](https://github.com/video-dev/hls.js/)) at `/usr/local/nginx/html/players`.
## Tips
For your development convienence a devcontainer was provided utilizing [Ubuntu-22.04 (Jammy)](https://github.com/microsoft/vscode-dev-containers/blob/main/containers/ubuntu/README.md).
Use Docker Compose to build and run the container with the following command:
```
docker-compose up -d
```
## Usage
### To run the server
```
docker run -d -p 1935:1935 -p 8080 kneeki/rtmp-server
```
To run with custom conf file where `custom.conf` is the new conf file for Nginx:
```
docker run -d -p 1935:1935 -p 8080 -v custom.conf:/etc/nginx/nginx.conf kneeki/rtmp-server
```
### To stream to the server
* **Stream live RTMP content to:**
```
rtmp://:1935/live/
```
where `` is any stream key you specify.
* **Configure [OBS](https://obsproject.com/) to stream content:**
Go to Settings > Stream, choose the following settings:
* Service: Custom Streaming Server.
* Server: `rtmp://:1935/live`.
* Stream key: anything you want, however provided video players assume stream key is `test`
### To view the stream
* **Using [VLC](https://www.videolan.org/vlc/index.html):**
* Go to Media > Open Network Stream.
* Enter the streaming URL: `rtmp://:1935/live/`
Replace `` with the IP of where the server is running, and
`` with the stream key you used when setting up the stream.
* For HLS and DASH, the URLs are of the forms:
`http:///hls/.m3u8` and
`http:///dash/_src.mpd` respectively.
* Click Play.
* **Using provided web players:**
The provided demo players (`http://localhost/players`) assume the stream-key is called `test` and the player is opened in localhost.
* To play RTMP content (requires Flash): `http://localhost/players/rtmp.html`
* To play HLS content: `http://localhost/players/hls.html`
* To play HLS content using hls.js library: `http://localhost/players/hlsjs.html`
* To play DASH content: `http://localhost/players/dash.html`
* To play RTMP and HLS contents on the same page: `http://localhost/players/rtmp_hls.html`
**Notes:**
* These web players are hardcoded to play stream key "test" at localhost.
* To change the stream source for these players. Download the html files and modify the `src` attribute in the video tag in the html file. You can then mount the modified files to the container as follows:
```
docker run -d -p 1935:1935 -p 8080 -v custom_players:/usr/local/nginx/html/players kneeki/rtmp-server
```
where `custom_players` is the directory holding the modified html files.
## Copyright
Released under MIT license.
## More info
* **GitHub repo**:
* **Docker Hub image**: