Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TareqAlqutami/rtmp-hls-server

a docker file to create a streaming server that supports RTMP, HLS and DASH content based on nginx and nginx-rtmp-module.
https://github.com/TareqAlqutami/rtmp-hls-server

Last synced: 8 days ago
JSON representation

a docker file to create a streaming server that supports RTMP, HLS and DASH content based on nginx and nginx-rtmp-module.

Host: GitHub
URL: https://github.com/TareqAlqutami/rtmp-hls-server
Owner: TareqAlqutami
License: mit
Created: 2019-12-12T08:35:33.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-07-10T11:57:13.000Z (over 1 year ago)
Last Synced: 2024-08-02T16:09:08.706Z (3 months ago)
Language: Shell
Size: 18.6 KB
Stars: 391
Watchers: 9
Forks: 191
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# RTMP-HLS Docker

**Docker image for video streaming server that supports RTMP, HLS, and DASH streams.**

[![Docker Automated build](https://img.shields.io/docker/cloud/automated/alqutami/rtmp-hls.svg)](https://hub.docker.com/r/alqutami/rtmp-hls/builds/)
[![Build Status](https://img.shields.io/docker/cloud/build/alqutami/rtmp-hls.svg)](https://hub.docker.com/r/alqutami/rtmp-hls)

## 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.

## 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.
* Default settings:
* RTMP is ON
* HLS is ON (adaptive, 5 variants)
* DASH is ON
* 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`.

Current Image is built using:
* Nginx 1.17.5 (compiled from source)
* Nginx-rtmp-module 1.2.1 (compiled from source)
* FFmpeg 4.2.1 (compiled from source)

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.

## Usage

### To run the server
```
docker run -d -p 1935:1935 -p 8080:8080 alqutami/rtmp-hls
```

For Alpine-based Image use:
```
docker run -d -p 1935:1935 -p 8080:8080 alqutami/rtmp-hls:latest-alpine
```

To run with custom conf file:
```
docker run -d -p 1935:1935 -p 8080:8080 -v custom.conf:/etc/nginx/nginx.conf alqutami/rtmp-hls
```
where `custom.conf` is the new conf file for Nginx.

### 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://:8080/hls/.m3u8` and
`http://:8080/dash/_src.mpd` respectively.
* Click Play.

* **Using provided web players:**

The provided demo players assume the stream-key is called `test` and the player is opened in localhost.
* To play RTMP content (requires Flash): `http://localhost:8080/players/rtmp.html`
* To play HLS content: `http://localhost:8080/players/hls.html`
* To play HLS content using hls.js library: `http://localhost:8080/players/hls_hlsjs.html`
* To play DASH content: `http://localhost:8080/players/dash.html`
* To play RTMP and HLS contents on the same page: `http://localhost:8080/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:8080 -v custom_players:/usr/local/nginx/html/players alqutami/rtmp-hls
```
where `custom_players` is the directory holding the modified html files.

## Copyright
Released under MIT license.

## More info
* **GitHub repo**:

* **Docker Hub image**: