summaryrefslogtreecommitdiff
path: root/TURN.md
diff options
context:
space:
mode:
authorTorsten Flammiger <git@netfg.net>2022-02-04 19:11:29 +0100
committerTorsten Flammiger <git@netfg.net>2022-02-04 19:11:29 +0100
commit63a2c6cce5f01cfca8295a2ea5ad7f639bc257b8 (patch)
tree71525d1593810e0e232acd46e7a6737f493fda80 /TURN.md
parentdffa5570e7573b768fdacf8e136405f5262a5db7 (diff)
downloadconduit-63a2c6cce5f01cfca8295a2ea5ad7f639bc257b8.zip
Add new TURN Readme and reference it from DEPLOY.md
Diffstat (limited to 'TURN.md')
-rw-r--r--TURN.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/TURN.md b/TURN.md
new file mode 100644
index 0000000..ed96295
--- /dev/null
+++ b/TURN.md
@@ -0,0 +1,25 @@
+# Setting up TURN/STURN
+
+## 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/develop/docs/turn-howto.md).
+
+## Edit/Add a few settings to your existing conduit.toml
+
+```
+# Refer to your Coturn settings.
+# `server.name` has to match the REALM setting of your Coturn as well as `transport`.
+turn_uris = ["turn:server.name?transport=udp", "turn:server.name?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 = ""
+```
+
+## Apply settings
+
+Restart Conduit. \ No newline at end of file