1
0
Fork 0
mirror of https://gitlab.com/famedly/conduit.git synced 2025-08-01 17:38:36 +00:00

docs: Use mdbook for docs

This commit is contained in:
Jonas Zohren 2022-02-06 17:48:06 +01:00
parent 6e106b5732
commit 70b6890edd
No known key found for this signature in database
GPG key ID: FE3ED5D90A175463
14 changed files with 342 additions and 162 deletions

33
docs/turn.md Normal file
View file

@ -0,0 +1,33 @@
# Setting up TURN/STURN
{{#include _getting_help.md}}
## General instructions
- It is assumed you have a [Coturn server](https://github.com/coturn/coturn) up and running. See [Synapse reference implementation](https://github.com/matrix-org/synapse/blob/e3fe6347be1da930b6a0ed2005b565369800a327/docs/turn-howto.md).
## Edit/Add a few settings to your existing conduit.toml
```toml
# Refer to your Coturn settings.
# `your.turn.url` has to match the REALM setting of your Coturn as well as `transport`.
turn_uris = ["turn:your.turn.url?transport=udp", "turn:your.turn.url?transport=tcp"]
# static-auth-secret of your turnserver
turn_secret = "ADD SECRET HERE"
# If you have your TURN server configured to use a username and password
# you can provide these information too. In this case comment out `turn_secret above`!
#turn_username = ""
#turn_password = ""
```
You can generate a secret by running the following command on Linux:
```bash
openssl rand -base64 33
```
## Apply settings
Restart Conduit.