From 1e844f2b51cae74f366541c57d8fe35254669873 Mon Sep 17 00:00:00 2001 From: Pablo <42.pablo.ms@gmail.com> Date: Tue, 14 Apr 2020 00:10:50 +0200 Subject: [PATCH] Touch up readme --- README.md | 104 ++---------------------------------------------------- 1 file changed, 2 insertions(+), 102 deletions(-) diff --git a/README.md b/README.md index 5fbfd24..e2cfbc9 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,3 @@ -## Supported tags and respective `Dockerfile` links +Production docker-compose is provided. It just works. -* [`latest` _(Dockerfile)_](https://github.com/tiangolo/nginx-rtmp-docker/blob/master/Dockerfile) - -# nginx-rtmp - -[**Docker**](https://www.docker.com/) image with [**Nginx**](http://nginx.org/en/) using the [**nginx-rtmp-module**](https://github.com/arut/nginx-rtmp-module) module for live multimedia (video) streaming. - -## Description - -This [**Docker**](https://www.docker.com/) image can be used to create an RTMP server for multimedia / video streaming using [**Nginx**](http://nginx.org/en/) and [**nginx-rtmp-module**](https://github.com/arut/nginx-rtmp-module), built from the current latest sources (Nginx 1.15.0 and nginx-rtmp-module 1.2.1). - -This was inspired by other similar previous images from [dvdgiessen](https://hub.docker.com/r/dvdgiessen/nginx-rtmp-docker/), [jasonrivers](https://hub.docker.com/r/jasonrivers/nginx-rtmp/), [aevumdecessus](https://hub.docker.com/r/aevumdecessus/docker-nginx-rtmp/) and by an [OBS Studio post](https://obsproject.com/forum/resources/how-to-set-up-your-own-private-rtmp-server-using-nginx.50/). - -The main purpose (and test case) to build it was to allow streaming from [**OBS Studio**](https://obsproject.com/) to different clients at the same time. - -**GitHub repo**: - -**Docker Hub image**: - -## Details - -## How to use - -* For the simplest case, just run a container with this image: - -```bash -docker run -d -p 1935:1935 --name nginx-rtmp tiangolo/nginx-rtmp -``` - -## How to test with OBS Studio and VLC - -* Run a container with the command above - - -* Open [OBS Studio](https://obsproject.com/) -* Click the "Settings" button -* Go to the "Stream" section -* In "Stream Type" select "Custom Streaming Server" -* In the "URL" enter the `rtmp:///live` replacing `` with the IP of the host in which the container is running. For example: `rtmp://192.168.0.30/live` -* In the "Stream key" use a "key" that will be used later in the client URL to display that specific stream. For example: `test` -* Click the "OK" button -* In the section "Sources" click de "Add" button (`+`) and select a source (for example "Screen Capture") and configure it as you need -* Click the "Start Streaming" button - - -* Open a [VLC](http://www.videolan.org/vlc/index.html) player (it also works in Raspberry Pi using `omxplayer`) -* Click in the "Media" menu -* Click in "Open Network Stream" -* Enter the URL from above as `rtmp:///live/` replacing `` with the IP of the host in which the container is running and `` with the key you created in OBS Studio. For example: `rtmp://192.168.0.30/live/test` -* Click "Play" -* Now VLC should start playing whatever you are transmitting from OBS Studio - -## Debugging - -If something is not working you can check the logs of the container with: - -```bash -docker logs nginx-rtmp -``` - -## Extending - -If you need to modify the configurations you can create a file `nginx.conf` and replace the one in this image using a `Dockerfile` that is based on the image, for example: - -```Dockerfile -FROM tiangolo/nginx-rtmp - -COPY nginx.conf /etc/nginx/nginx.conf -``` - -The current `nginx.conf` contains: - -```Nginx -worker_processes auto; -rtmp_auto_push on; -events {} -rtmp { - server { - listen 1935; - listen [::]:1935 ipv6only=on; - - application live { - live on; - record off; - } - } -} -``` - -You can start from it and modify it as you need. Here's the [documentation related to `nginx-rtmp-module`](https://github.com/arut/nginx-rtmp-module/wiki/Directives). - -## Technical details - -* This image is built from the same base official images that most of the other official images, as Python, Node, Postgres, Nginx itself, etc. Specifically, [buildpack-deps](https://hub.docker.com/_/buildpack-deps/) which is in turn based on [debian](https://hub.docker.com/_/debian/). So, if you have any other image locally you probably have the base image layers already downloaded. - -* It is built from the official sources of **Nginx** and **nginx-rtmp-module** without adding anything else. (Surprisingly, most of the available images that include **nginx-rtmp-module** are made from different sources, old versions or add several other components). - -* It has a simple default configuration that should allow you to send one or more streams to it and have several clients receiving multiple copies of those streams simultaneously. (It includes `rtmp_auto_push` and an automatic number of worker processes). - -## License - -This project is licensed under the terms of the MIT License. +Alpha level software. Do not use in production. \ No newline at end of file