From 6c9d3230d8071545d7111962204e1520d38721f0 Mon Sep 17 00:00:00 2001 From: Torsten Flammiger Date: Mon, 20 Dec 2021 15:35:34 +0100 Subject: [PATCH 1/2] Add TURN Readme --- TURN.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 TURN.md diff --git a/TURN.md b/TURN.md new file mode 100644 index 0000000..746b2da --- /dev/null +++ b/TURN.md @@ -0,0 +1,36 @@ +# Setting up TURN/STURN + +## General instructions + +* This was tested against Conduit(Next), Coturn (Archlinux) and Element (Android) +* Build your own Conduit from source. It's dead simple to build. +* Use the NEXT branch as only this branch provides the necessary functionality. +* This documentation assumes you have a [Coturn server](https://github.com/coturn/coturn) up and runnig. See [here](https://github.com/matrix-org/synapse/blob/develop/docs/turn-howto.md) how to get it working with the reference implementation. It's almost the same with Conduit. + +## Add a few setting to your existing conduit.toml + +``` +# Coturn settings to inform the clients where to find a coturn server +# to enable Audio/Video calls + +# domain.tdl should match the REALM setting of coturn +# Adjust this as needed, If you have only one transport write it this way: +# turn_uris = ["turn:domain.tld?transport=tcp"] +turn_uris = ["turn:domain.tdl?transport=udp", "turn:domain.tld?transport=tcp"] + +# the value of static-auth-secret of your turnserver +turn_secret = "" + +# the default +turn_ttl = 86400 # 1 Day + +# 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 setting + +Restart Conduit and enjoy audio and/or video call functionality from within Element. \ No newline at end of file From d80df04b202da5bf4e5d4ca85163ee934643aa90 Mon Sep 17 00:00:00 2001 From: Torsten Flammiger Date: Fri, 24 Dec 2021 20:32:27 +0100 Subject: [PATCH 2/2] Fix some typos and made some instructions more generic --- TURN.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/TURN.md b/TURN.md index 746b2da..9966d44 100644 --- a/TURN.md +++ b/TURN.md @@ -3,14 +3,14 @@ ## General instructions * This was tested against Conduit(Next), Coturn (Archlinux) and Element (Android) -* Build your own Conduit from source. It's dead simple to build. +* Build your own Conduit from source (always recommended). It's dead simple to build. * Use the NEXT branch as only this branch provides the necessary functionality. * This documentation assumes you have a [Coturn server](https://github.com/coturn/coturn) up and runnig. See [here](https://github.com/matrix-org/synapse/blob/develop/docs/turn-howto.md) how to get it working with the reference implementation. It's almost the same with Conduit. -## Add a few setting to your existing conduit.toml +## Edit/Add a few settings to your existing conduit.toml ``` -# Coturn settings to inform the clients where to find a coturn server +# Settings to inform the clients where to find a TURN server # to enable Audio/Video calls # domain.tdl should match the REALM setting of coturn @@ -21,16 +21,15 @@ turn_uris = ["turn:domain.tdl?transport=udp", "turn:domain.tld?transport=tcp"] # the value of static-auth-secret of your turnserver turn_secret = "" -# the default -turn_ttl = 86400 # 1 Day +# the default of one day +turn_ttl = 86400 # 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! +# you can provide these information too. In this case comment out turn_secret above! #turn_username = "" #turn_password = "" ``` ## Apply setting -Restart Conduit and enjoy audio and/or video call functionality from within Element. \ No newline at end of file +Restart Conduit and enjoy audio and/or video call functionality. \ No newline at end of file