Bluemedia/nginx-live
1
0
Fork 0
mirror of https://github.com/BluemediaGER/nginx-live.git synced 2024-11-22 17:55:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docker image name in README.md

Browse source
This commit is contained in:
Oliver Traber 2022-08-07 00:58:46 +02:00 committed by GitHub
parent ac2c98bcdc
commit da915d702d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -1,5 +1,23 @@
# nginx-live # nginx-live
<table>
<thead>
<tr>
<td align="left">
:warning: Notice
</td>
</tr>
</thead>
<tbody>
<tr>
<td align="left">
The docker image is now hosted as <code>git.bluemedia.dev/bluemedia/nginx-live</code>. The old registry name will continue to point to the current image for now, but may stop working at some point in the future.
</td>
</tr>
</tbody>
</table>
nginx-live is a simple, lightweight, self-hosted video streaming service in 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.
@ -10,7 +28,7 @@ It allows you to securely stream video and audio from encoders such as OBS via R
If you want to try nginx-live, or test a configuration change, you can start the container without any environment variables. In this case the ingest is done unencrypted via RTMP. The necessary stream key is generated randomly and printed in the Docker log during the first start. If you want to try nginx-live, or test a configuration change, you can start the container without any environment variables. In this case the ingest is done unencrypted via RTMP. The necessary stream key is generated randomly and printed in the Docker log during the first start.
```shell ```shell
docker run -d --name streaming -p 8080:8080 -p 1935:1935 repo.bluemedia.dev/bluemedia/nginx-live docker run -d --name streaming -p 8080:8080 -p 1935:1935 git.bluemedia.dev/bluemedia/nginx-live
``` ```
After launch, the web player should be available at `http://<hostname-or-ip>:8080/`. After launch, the web player should be available at `http://<hostname-or-ip>:8080/`.
@ -25,7 +43,7 @@ docker run -d --name streaming -p 8080:8080 -p 1935:1935 \
-v /path/to/certs:/cert:ro \ -v /path/to/certs:/cert:ro \
-e TLS_CERT=fullchain.cer \ -e TLS_CERT=fullchain.cer \
-e TLS_KEY=private.key \ -e TLS_KEY=private.key \
repo.bluemedia.dev/bluemedia/nginx-live git.bluemedia.dev/bluemedia/nginx-live
``` ```
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. 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.
@ -51,7 +69,7 @@ If you want to make the web player and the HLS files available via HTTPS, you ca
- `frontend/` All frontend related files. These will be copied to the web root of nginx. - `frontend/` All frontend related files. These will be copied to the web root of nginx.
## Automated image builds ## Automated image builds
The Docker image `repo.bluemedia.dev/bluemedia/nginx-live` is built an pushed every two days by a Jenkins instance. Builds are based on the current main branch of this repository. The Docker image `git.bluemedia.dev/bluemedia/nginx-live` is built an pushed every two days by a Jenkins instance. Builds are based on the current main branch of this repository.
## Contribution Guidelines ## Contribution Guidelines