diff options
| author | babolivier <babolivier@users.noreply.github.com> | 2021-11-16 10:21:27 +0000 |
|---|---|---|
| committer | babolivier <babolivier@users.noreply.github.com> | 2021-11-16 10:21:27 +0000 |
| commit | e3516609877ce111cced98873183ff0ab758bbdb (patch) | |
| tree | 135192416180ababd7e6f4c7fc06b2a4d58d6dc0 /develop/turn-howto.html | |
| parent | deploy: 2fffcb24d8c799a08f250af31da239494b3bda1b (diff) | |
| download | synapse-e3516609877ce111cced98873183ff0ab758bbdb.tar.xz | |
deploy: e72135b9d3601b36a32cc8b6cf0c5e0448f534b3
Diffstat (limited to '')
| -rw-r--r-- | develop/turn-howto.html | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/develop/turn-howto.html b/develop/turn-howto.html index 980c8f75d8..05431cda60 100644 --- a/develop/turn-howto.html +++ b/develop/turn-howto.html @@ -183,12 +183,12 @@ </div> <h1 id="overview"><a class="header" href="#overview">Overview</a></h1> -<p>This document explains how to enable VoIP relaying on your Home Server with +<p>This document explains how to enable VoIP relaying on your homeserver with TURN.</p> -<p>The synapse Matrix Home Server supports integration with TURN server via the +<p>The synapse Matrix homeserver supports integration with TURN server via the <a href="https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00">TURN server REST API</a>. This -allows the Home Server to generate credentials that are valid for use on the -TURN server through the use of a secret shared between the Home Server and the +allows the homeserver to generate credentials that are valid for use on the +TURN server through the use of a secret shared between the homeserver and the TURN server.</p> <p>The following sections describe how to install <a href="https://github.com/coturn/coturn">coturn</a> (which implements the TURN REST API) and integrate it with synapse.</p> <h2 id="requirements"><a class="header" href="#requirements">Requirements</a></h2> @@ -321,18 +321,18 @@ external IP address:</p> </li> </ol> <h2 id="synapse-setup"><a class="header" href="#synapse-setup">Synapse setup</a></h2> -<p>Your home server configuration file needs the following extra keys:</p> +<p>Your homeserver configuration file needs the following extra keys:</p> <ol> <li>"<code>turn_uris</code>": This needs to be a yaml list of public-facing URIs for your TURN server to be given out to your clients. Add separate entries for each transport your TURN server supports.</li> <li>"<code>turn_shared_secret</code>": This is the secret shared between your -Home server and your TURN server, so you should set it to the same +homeserver and your TURN server, so you should set it to the same string you used in turnserver.conf.</li> <li>"<code>turn_user_lifetime</code>": This is the amount of time credentials -generated by your Home Server are valid for (in milliseconds). +generated by your homeserver are valid for (in milliseconds). Shorter times offer less potential for abuse at the expense of -increased traffic between web clients and your home server to +increased traffic between web clients and your homeserver to refresh credentials. The TURN REST API specification recommends one day (86400000).</li> <li>"<code>turn_allow_guests</code>": Whether to allow guest users to use the |