diff --git a/README.md b/README.md index 410294f4..39dee810 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ _rtsp-simple-server_ is a simple, ready-to-use and zero-dependency RTSP server a Features: * 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 * Pull and serve streams from other RTSP or RTMP servers, always or on-demand (RTSP proxy) * 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 -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 ``` -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 ```