From 167c5ec6c505990498d2e968c72563e93edcf792 Mon Sep 17 00:00:00 2001 From: Jason Walton Date: Thu, 9 Mar 2023 10:47:40 -0500 Subject: [PATCH] docs: Fix webrtcICEServers format in README.md. (#1528) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 17eb990f..dbdd9cca 100644 --- a/README.md +++ b/README.md @@ -1116,15 +1116,15 @@ rtsp-simple-server Finally, if none of these methods work, you can force all WebRTC/ICE connections to pass through a TURN server, like [coturn](https://github.com/coturn/coturn), that must be configured externally. The server address and credentials must be set in the configuration file: ```yml -webrtcICEServers: [turn:user:pass:host:ip] +webrtcICEServers: [turn:user:pass:host:port] ``` -Where `user` and `pass` are the username and password of the server. +Where `user` and `pass` are the username and password of the server. Note that `port` is not optional. 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] +webrtcICEServers: [turn:AUTH_SECRET:secret:host:port] ``` 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/ICE connection is established.