RepoMirrors/mediamtx
1
0
Fork 0
mirror of https://github.com/bluenviron/mediamtx synced 2025-01-18 21:10:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Alessandro Ros 2020-10-14 11:41:58 +02:00 committed by aler9
parent 14efc103ba
commit f13e198f23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -9,7 +9,7 @@ _rtsp-simple-server_ is a simple, ready-to-use and zero-dependency RTSP server a
Features: Features:
* Read and publish live streams with UDP and TCP * Read and publish live streams with UDP and TCP
* Each stream can have multiple video and audio tracks, encoded in any format (including H264, H265, VP8, VP9, MP3, AAC, Opus, PCM) * Each stream can have multiple video and audio tracks, encoded with any codec (including H264, H265, VP8, VP9, MP3, AAC, Opus, PCM)
* Publish multiple streams at once, each in a separate path, that can be read by multiple users * Publish multiple streams at once, each in a separate path, that can be read by multiple users
* Pull and serve streams from other RTSP or RTMP servers, always or on-demand (RTSP proxy) * Pull and serve streams from other RTSP or RTMP servers, always or on-demand (RTSP proxy)
* Provide separate authentication for reading and publishing * Provide separate authentication for reading and publishing
@ -66,14 +66,17 @@ docker run --rm -it -e RTSP_PROTOCOLS=tcp -p 8554:8554 aler9/rtsp-simple-server
### Configuration ### Configuration
To see or change the configuration, edit the `rtsp-simple-server.yml` file, provided with the executable, and also [available here](rtsp-simple-server.yml). To see or change the configuration, edit the `rtsp-simple-server.yml` file, that is:
* included the release bundle
* available in the root folder of the Docker image (`/rtsp-simple-server.yml`)
* also [available here](rtsp-simple-server.yml).
The configuration can be overridden by environment variables, in the format `RTSP_PARAMNAME`, where `PARAMNAME` is the uppercase name of a parameter. For instance, the `rtspPort` parameter can be overridden in the following way: Every configuration parameter can be overridden by environment variables, in the format `RTSP_PARAMNAME`, where `PARAMNAME` is the uppercase name of a parameter. For instance, the `rtspPort` parameter can be overridden in the following way:
``` ```
RTSP_RTSPPORT=8555 ./rtsp-simple-server RTSP_RTSPPORT=8555 ./rtsp-simple-server
``` ```
Parameters in dicts/maps can be overridden by using underscores, in the following way: Parameters in maps can be overridden by using underscores, in the following way:
``` ```
RTSP_PATHS_TEST_SOURCE=rtsp://myurl ./rtsp-simple-server RTSP_PATHS_TEST_SOURCE=rtsp://myurl ./rtsp-simple-server
``` ```