{"id":13442969,"url":"https://github.com/tiangolo/nginx-rtmp-docker","last_synced_at":"2025-05-14T14:08:00.238Z","repository":{"id":43698649,"uuid":"66982390","full_name":"tiangolo/nginx-rtmp-docker","owner":"tiangolo","description":"Docker image with Nginx using the nginx-rtmp-module module for live multimedia (video) streaming.","archived":false,"fork":false,"pushed_at":"2025-02-10T13:59:52.000Z","size":68,"stargazers_count":1227,"open_issues_count":2,"forks_count":374,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-04-11T21:48:40.228Z","etag":null,"topics":["docker","docker-image","dockerfile","live-multimedia","multimedia","nginx","nginx-rtmp","obs-studio","rtmp","server","stream","video","vlc"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tiangolo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["tiangolo"]}},"created_at":"2016-08-30T22:30:06.000Z","updated_at":"2025-04-08T18:28:39.000Z","dependencies_parsed_at":"2023-01-21T17:16:11.299Z","dependency_job_id":"a7bae513-ddf0-4f93-bd1e-a94f997a8601","html_url":"https://github.com/tiangolo/nginx-rtmp-docker","commit_stats":{"total_commits":89,"total_committers":12,"mean_commits":7.416666666666667,"dds":0.6179775280898876,"last_synced_commit":"571b8b6d9ccf3ee51d9557da388a54729a95af46"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiangolo%2Fnginx-rtmp-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiangolo%2Fnginx-rtmp-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiangolo%2Fnginx-rtmp-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiangolo%2Fnginx-rtmp-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiangolo","download_url":"https://codeload.github.com/tiangolo/nginx-rtmp-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254159344,"owners_count":22024558,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-image","dockerfile","live-multimedia","multimedia","nginx","nginx-rtmp","obs-studio","rtmp","server","stream","video","vlc"],"created_at":"2024-07-31T03:01:54.040Z","updated_at":"2025-05-14T14:08:00.188Z","avatar_url":"https://github.com/tiangolo.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/tiangolo"],"categories":["Dockerfile","HarmonyOS","Shell"],"sub_categories":["Windows Manager"],"readme":"[![Deploy](https://github.com/tiangolo/nginx-rtmp-docker/workflows/Deploy/badge.svg)](https://github.com/tiangolo/nginx-rtmp-docker/actions?query=workflow%3ADeploy)\n\n## Supported tags and respective `Dockerfile` links\n\n* [`latest` _(Dockerfile)_](https://github.com/tiangolo/nginx-rtmp-docker/blob/master/Dockerfile)\n\n**Note**: Note: There are [tags for each build date](https://hub.docker.com/r/tiangolo/nginx-rtmp/tags). If you need to \"pin\" the Docker image version you use, you can select one of those tags. E.g. `tiangolo/nginx-rtmp:latest-2020-08-16`.\n\n# nginx-rtmp\n\n[**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.\n\n## Description\n\nThis [**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).\n\nThis 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/).\n\nThe 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.\n\n**GitHub repo**: \u003chttps://github.com/tiangolo/nginx-rtmp-docker\u003e\n\n**Docker Hub image**: \u003chttps://hub.docker.com/r/tiangolo/nginx-rtmp/\u003e\n\n## Details\n\n## How to use\n\n* For the simplest case, just run a container with this image:\n\n```bash\ndocker run -d -p 1935:1935 --name nginx-rtmp tiangolo/nginx-rtmp\n```\n\n## How to test with OBS Studio and VLC\n\n* Run a container with the command above\n\n\n* Open [OBS Studio](https://obsproject.com/)\n* Click the \"Settings\" button\n* Go to the \"Stream\" section\n* In \"Stream Type\" select \"Custom Streaming Server\"\n* In the \"URL\" enter the `rtmp://\u003cip_of_host\u003e/live` replacing `\u003cip_of_host\u003e` with the IP of the host in which the container is running. For example: `rtmp://192.168.0.30/live`\n* In the \"Stream key\" use a \"key\" that will be used later in the client URL to display that specific stream. For example: `test`\n* Click the \"OK\" button\n* In the section \"Sources\" click the \"Add\" button (`+`) and select a source (for example \"Screen Capture\") and configure it as you need\n* Click the \"Start Streaming\" button\n\n\n* Open a [VLC](http://www.videolan.org/vlc/index.html) player (it also works in Raspberry Pi using `omxplayer`)\n* Click in the \"Media\" menu\n* Click in \"Open Network Stream\"\n* Enter the URL from above as `rtmp://\u003cip_of_host\u003e/live/\u003ckey\u003e` replacing `\u003cip_of_host\u003e` with the IP of the host in which the container is running and `\u003ckey\u003e` with the key you created in OBS Studio. For example: `rtmp://192.168.0.30/live/test`\n* Click \"Play\"\n* Now VLC should start playing whatever you are transmitting from OBS Studio\n\n## Debugging\n\nIf something is not working you can check the logs of the container with:\n\n```bash\ndocker logs nginx-rtmp\n```\n\n## Extending\n\nIf 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:\n\n```Dockerfile\nFROM tiangolo/nginx-rtmp\n\nCOPY nginx.conf /etc/nginx/nginx.conf\n```\n\nThe current `nginx.conf` contains:\n\n```Nginx\nworker_processes auto;\nrtmp_auto_push on;\nevents {}\nrtmp {\n    server {\n        listen 1935;\n        listen [::]:1935 ipv6only=on;\n\n        application live {\n            live on;\n            record off;\n        }\n    }\n}\n```\n\nYou 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).\n\n## Technical details\n\n* 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.\n\n* 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).\n\n* 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).\n\n## Release Notes\n\n### Latest Changes\n\n#### Internal\n\n* ⬆ Bump tiangolo/latest-changes from 0.3.1 to 0.3.2. PR [#98](https://github.com/tiangolo/nginx-rtmp-docker/pull/98) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* ⬆ Bump tiangolo/issue-manager from 0.5.0 to 0.5.1. PR [#96](https://github.com/tiangolo/nginx-rtmp-docker/pull/96) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* 👷 Update `issue-manager.yml`. PR [#95](https://github.com/tiangolo/nginx-rtmp-docker/pull/95) by [@tiangolo](https://github.com/tiangolo).\n* ⬆ Bump docker/build-push-action from 5 to 6. PR [#92](https://github.com/tiangolo/nginx-rtmp-docker/pull/92) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* 👷 Update `latest-changes` GitHub Action. PR [#93](https://github.com/tiangolo/nginx-rtmp-docker/pull/93) by [@tiangolo](https://github.com/tiangolo).\n* ⬆ Bump docker/build-push-action from 2 to 5. PR [#68](https://github.com/tiangolo/nginx-rtmp-docker/pull/68) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* ⬆ Bump docker/setup-buildx-action from 1 to 3. PR [#67](https://github.com/tiangolo/nginx-rtmp-docker/pull/67) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* ⬆ Bump docker/login-action from 1 to 3. PR [#69](https://github.com/tiangolo/nginx-rtmp-docker/pull/69) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* 👷 Update issue-manager.yml GitHub Action permissions. PR [#76](https://github.com/tiangolo/nginx-rtmp-docker/pull/76) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Update issue-manager.yml GitHub Action permissions. PR [#75](https://github.com/tiangolo/nginx-rtmp-docker/pull/75) by [@tiangolo](https://github.com/tiangolo).\n* 🔧 Add GitHub templates for discussions and issues, and security policy. PR [#72](https://github.com/tiangolo/nginx-rtmp-docker/pull/72) by [@alejsdev](https://github.com/alejsdev).\n* 🔧 Update `latest-changes.yml`. PR [#70](https://github.com/tiangolo/nginx-rtmp-docker/pull/70) by [@alejsdev](https://github.com/alejsdev).\n\n### 0.0.1\n\n#### Features\n\n* ✨ Allow using debug directives, enable ` --with-debug` compile option. PR [#16](https://github.com/tiangolo/nginx-rtmp-docker/pull/16) by [@agconti](https://github.com/agconti).\n* ✨ Add support for multiarch builds, including ARM (e.g. Mac M1). PR [#65](https://github.com/tiangolo/nginx-rtmp-docker/pull/65) by [@tiangolo](https://github.com/tiangolo).\n\n#### Fixes\n\n* 👷 Fix multiarch deploy build. PR [#66](https://github.com/tiangolo/nginx-rtmp-docker/pull/66) by [@tiangolo](https://github.com/tiangolo).\n\n#### Docs\n\n* ✏️ Fix a typo in README. PR [#20](https://github.com/tiangolo/nginx-rtmp-docker/pull/20) by [@Irishsmurf](https://github.com/Irishsmurf).\n\n#### Upgrades\n\n* ⬆️ Upgrade Nginx to 1.23.2 and OS to bullseye. PR [#40](https://github.com/tiangolo/nginx-rtmp-docker/pull/40) by [@tiangolo](https://github.com/tiangolo).\n* ⬆ Upgrade to nginx-1.19.7. PR [#26](https://github.com/tiangolo/nginx-rtmp-docker/pull/26) by [@cesarandreslopez](https://github.com/cesarandreslopez).\n* ⬆ Update RTMP module version to 1.2.2. PR [#28](https://github.com/tiangolo/nginx-rtmp-docker/pull/28) by [@louis70109](https://github.com/louis70109).\n* Upgrade Nginx to version 1.18.0. PR [#13](https://github.com/tiangolo/nginx-rtmp-docker/pull/13) by [@Nathanael-Mtd](https://github.com/Nathanael-Mtd).\n\n#### Internal\n\n* 👷 Update token for latest changes. PR [#50](https://github.com/tiangolo/nginx-rtmp-docker/pull/50) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Add GitHub Action for Docker Hub description. PR [#45](https://github.com/tiangolo/nginx-rtmp-docker/pull/45) by [@tiangolo](https://github.com/tiangolo).\n* Bump tiangolo/issue-manager from 0.3.0 to 0.4.0. PR [#42](https://github.com/tiangolo/nginx-rtmp-docker/pull/42) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* Bump actions/checkout from 2 to 3. PR [#43](https://github.com/tiangolo/nginx-rtmp-docker/pull/43) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* 🎨 Format CI config. PR [#44](https://github.com/tiangolo/nginx-rtmp-docker/pull/44) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Add Dependabot and funding configs. PR [#41](https://github.com/tiangolo/nginx-rtmp-docker/pull/41) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Add scheduled CI. PR [#39](https://github.com/tiangolo/nginx-rtmp-docker/pull/39) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Add alls-green GitHub Action. PR [#38](https://github.com/tiangolo/nginx-rtmp-docker/pull/38) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Build to test on CI for PRs, update GitHub Actions. PR [#37](https://github.com/tiangolo/nginx-rtmp-docker/pull/37) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Add Latest Changes GitHub Action. PR [#29](https://github.com/tiangolo/nginx-rtmp-docker/pull/29) by [@tiangolo](https://github.com/tiangolo).\n* Add CI with GitHub actions. PR [#15](https://github.com/tiangolo/nginx-rtmp-docker/pull/15).\n* ⬆ Bump peter-evans/dockerhub-description from 3 to 4. PR [#63](https://github.com/tiangolo/nginx-rtmp-docker/pull/63) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* ⬆ Bump tiangolo/issue-manager from 0.4.1 to 0.5.0. PR [#64](https://github.com/tiangolo/nginx-rtmp-docker/pull/64) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* Bump actions/checkout from 3 to 4. PR [#52](https://github.com/tiangolo/nginx-rtmp-docker/pull/52) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* ⬆ Bump tiangolo/issue-manager from 0.4.0 to 0.4.1. PR [#61](https://github.com/tiangolo/nginx-rtmp-docker/pull/61) by [@dependabot[bot]](https://github.com/apps/dependabot).\n* 👷 Update dependabot. PR [#55](https://github.com/tiangolo/nginx-rtmp-docker/pull/55) by [@tiangolo](https://github.com/tiangolo).\n* 👷 Update latest-changes. PR [#54](https://github.com/tiangolo/nginx-rtmp-docker/pull/54) by [@tiangolo](https://github.com/tiangolo).\n\n## License\n\nThis project is licensed under the terms of the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiangolo%2Fnginx-rtmp-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiangolo%2Fnginx-rtmp-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiangolo%2Fnginx-rtmp-docker/lists"}