EpicMorg/docker-scripts
2
1
Fork 0
mirror of https://github.com/EpicMorg/docker-scripts.git synced 2025-02-03 17:20:39 +03:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
STAM 2020-08-04 16:41:37 +03:00 committed by GitHub
parent 8ac58973be
commit 092e7439f4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
balancer/rtmp-hls/README.md
View File

@ -1,12 +1,9 @@
# RTMP-HLS Docker
** BASED ON https://github.com/TareqAlqutami/rtmp-hls-server **
**BASED ON** [TareqAlqutami/rtmp-hls-server](https://github.com/TareqAlqutami/rtmp-hls-server)
**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.
@ -24,28 +21,16 @@ All modules are built from source on Debian and Alpine Linux base images.
* Statistic page of RTMP streams at `http://<server ip>:<server port>/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
docker run -d -p 1935:1935 -p 8080:8080 epicmorg/balancer: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
docker run -d -p 1935:1935 -p 8080:8080 -v custom.conf:/etc/nginx/nginx.conf epicmorg/balancer:rtmp-hls
```
where `custom.conf` is the new conf file for Nginx.
@ -86,14 +71,8 @@ The provided demo players assume the stream-key is called `test` and the player
* 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
docker run -d -p 1935:1935 -p 8080:8080 -v custom_players:/usr/local/nginx/html/players epicmorg/balancer:rtmp-hls
```
where `custom_players` is the directory holding the modified html files.
## Copyright
Released under MIT license.
## More info
* **GitHub repo**: <https://github.com/TareqAlqutami/rtmp-hls-server.git>
* **Docker Hub image**: <https://hub.docker.com/r/alqutami/rtmp-hls>