Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

deploy: e72135b9d3

This commit is contained in:
babolivier 2021-11-16 10:21:27 +00:00
parent 6b35d47b03
commit e351660987
4 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
develop/print.html
View File

@ -1167,12 +1167,12 @@ in Synapse can be deactivated.</p>
<pre><code class="language-yaml">use_insecure_ssl_client_just_for_testing_do_not_use: true <pre><code class="language-yaml">use_insecure_ssl_client_just_for_testing_do_not_use: true
</code></pre> </code></pre>
<div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="overview-1"><a class="header" href="#overview-1">Overview</a></h1> <div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="overview-1"><a class="header" href="#overview-1">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> 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 <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 allows the homeserver 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 TURN server through the use of a secret shared between the homeserver and the
TURN server.</p> 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> <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> <h2 id="requirements"><a class="header" href="#requirements">Requirements</a></h2>
@ -1305,18 +1305,18 @@ external IP address:</p>
</li> </li>
</ol> </ol>
<h2 id="synapse-setup"><a class="header" href="#synapse-setup">Synapse setup</a></h2> <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> <ol>
<li>&quot;<code>turn_uris</code>&quot;: This needs to be a yaml list of public-facing URIs <li>&quot;<code>turn_uris</code>&quot;: This needs to be a yaml list of public-facing URIs
for your TURN server to be given out to your clients. Add separate for your TURN server to be given out to your clients. Add separate
entries for each transport your TURN server supports.</li> entries for each transport your TURN server supports.</li>
<li>&quot;<code>turn_shared_secret</code>&quot;: This is the secret shared between your <li>&quot;<code>turn_shared_secret</code>&quot;: 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> string you used in turnserver.conf.</li>
<li>&quot;<code>turn_user_lifetime</code>&quot;: This is the amount of time credentials <li>&quot;<code>turn_user_lifetime</code>&quot;: 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 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 refresh credentials. The TURN REST API specification recommends
one day (86400000).</li> one day (86400000).</li>
<li>&quot;<code>turn_allow_guests</code>&quot;: Whether to allow guest users to use the <li>&quot;<code>turn_allow_guests</code>&quot;: Whether to allow guest users to use the

2
develop/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
develop/searchindex.json
View File

File diff suppressed because one or more lines are too long

16
develop/turn-howto.html
View File

@ -183,12 +183,12 @@
</div> </div>
<h1 id="overview"><a class="header" href="#overview">Overview</a></h1> <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> 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 <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 allows the homeserver 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 TURN server through the use of a secret shared between the homeserver and the
TURN server.</p> 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> <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> <h2 id="requirements"><a class="header" href="#requirements">Requirements</a></h2>
@ -321,18 +321,18 @@ external IP address:</p>
</li> </li>
</ol> </ol>
<h2 id="synapse-setup"><a class="header" href="#synapse-setup">Synapse setup</a></h2> <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> <ol>
<li>&quot;<code>turn_uris</code>&quot;: This needs to be a yaml list of public-facing URIs <li>&quot;<code>turn_uris</code>&quot;: This needs to be a yaml list of public-facing URIs
for your TURN server to be given out to your clients. Add separate for your TURN server to be given out to your clients. Add separate
entries for each transport your TURN server supports.</li> entries for each transport your TURN server supports.</li>
<li>&quot;<code>turn_shared_secret</code>&quot;: This is the secret shared between your <li>&quot;<code>turn_shared_secret</code>&quot;: 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> string you used in turnserver.conf.</li>
<li>&quot;<code>turn_user_lifetime</code>&quot;: This is the amount of time credentials <li>&quot;<code>turn_user_lifetime</code>&quot;: 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 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 refresh credentials. The TURN REST API specification recommends
one day (86400000).</li> one day (86400000).</li>
<li>&quot;<code>turn_allow_guests</code>&quot;: Whether to allow guest users to use the <li>&quot;<code>turn_allow_guests</code>&quot;: Whether to allow guest users to use the