Bluemedia/nginx-live
1
0
Fork 0
mirror of https://github.com/BluemediaGER/nginx-live.git synced 2024-11-23 02:05:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Oliver Traber 2021-06-03 01:26:13 +02:00
parent 7b0f58b9df
commit 47ed0f0695
Signed by: Bluemedia
GPG key ID: C7BA47275B086E2C
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,6 @@
# nginx-live # nginx-live
nginx-live is a simple, lightweight, self-hosted video streaming service as a Docker container. nginx-live is a simple, lightweight, self-hosted video streaming service in a Docker container.
It allows you to securely stream video and audio from encoders such as OBS via RTMP or RTMPS. The stream is then converted to the HLS format so that it can be viewed by a larger number of viewers in their favorite browser. It allows you to securely stream video and audio from encoders such as OBS via RTMP or RTMPS. The stream is then converted to the HLS format so that it can be viewed by a larger number of viewers in their favorite browser.
## Usage ## Usage
@ -28,16 +28,16 @@ docker run -d --name streaming -p 8080:8080 -p 1935:1935 \
repo.bluemedia.dev/bluemedia/nginx-live repo.bluemedia.dev/bluemedia/nginx-live
``` ```
You will now need to use the server url in your streaming software in the following format: `rtmps://<hostname-or-ip>:<rtmp-port>/live`. It is important that you specify the RTMP port. You will now need to set the server url in your streaming software in the following format: `rtmps://<hostname-or-ip>:<rtmp-port>/live`. It is important that you specify the RTMP port.
If you also want to make the web player and the HLS files available via HTTPS, you can simply put a reverse proxy of your choice in front of the nginx-live container. If you want to make the web player and the HLS files available via HTTPS, you can simply put a reverse proxy of your choice in front of the nginx-live container.
### Available environment variables ### Available environment variables
- RTMP_PORT - Port on which nginx-live listens for ingest data from your streaming software or encoder. Defaults to `1935`. - `RTMP_PORT` - Port on which nginx-live listens for ingest data from your streaming software or encoder. Defaults to `1935`.
- HTTP_PORT - Port on which the web player and HLS files are available via HTTP. Defaults to `8080`. - `HTTP_PORT` - Port on which the web player and HLS files are available via HTTP. Defaults to `8080`.
- TLS_CERT - File name of the TLS certificate file in the /cert directory inside the container. If set, encrypted ingest will be enabled on the RTMP port. - `TLS_CERT` - File name of the TLS certificate file in the /cert directory inside the container. If set, encrypted ingest will be enabled on the RTMP port.
- TLS_KEY - File name of the private key that belongs to the TLS certificate. - `TLS_KEY` - File name of the private key that belongs to the TLS certificate.
- STREAM_KEY - Stream key, which is needed to ingest stream data. If the variable is not set, the key is randomly generated at container startup. - `STREAM_KEY` - Stream key, which is needed to ingest stream data. If the variable is not set, the key is randomly generated at container startup.
## Built with ## Built with