External/mediamtx
1
0
Fork 1
mirror of https://github.com/bluenviron/mediamtx.git synced 2025-12-26 04:52:00 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Fix webrtcICEServers format in README.md. (#1528)

Browse source
This commit is contained in:
Jason Walton 2023-03-09 10:47:40 -05:00 • committed by GitHub
parent 8876ff9a83
commit 167c5ec6c5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -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.