From f9bf62ef0a870b077d6ed3dee1ff66e2aeb39abe Mon Sep 17 00:00:00 2001 From: aler9 <46489434+aler9@users.noreply.github.com> Date: Fri, 16 Dec 2022 01:03:04 +0100 Subject: [PATCH] update readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 0badeeac..889832d9 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,7 @@ Features: * [Decreasing latency](#decreasing-latency) * [WebRTC protocol](#webrtc-protocol) * [General usage](#general-usage-3) + * [TURN servers](#turn-servers) * [Links](#links) ## Installation @@ -995,6 +996,24 @@ Every stream published to the server can be read with WebRTC by visiting: https://localhost:8889/mystream ``` +### TURN servers + +The server can be configured in order to communicate to clients through a TURN server. The server must be set in the configuration file: + +```yml +webrtcICEServers: [turn:user:pass:host:ip] +``` + +Where `user` and `pass` are the username and password of the server. + +If the server uses a secret-based authentication (for instance, coturn with the `use-auth-secret` option), it must be configured in this way: + +```yml +webrtcICEServers: [turn:AUTH_SECRET:secret:host:ip] +``` + +where `secret` is the secret of the TURN server. rtsp_simple_server will generate a set of credentials by using the secret, and credentials will be sent to clients before the WebRTC connection begins. + ## Links Related projects