|
@@ -1,12 +1,12 @@
|
|
|
# Overview
|
|
|
|
|
|
-This document explains how to enable VoIP relaying on your Home Server with
|
|
|
+This document explains how to enable VoIP relaying on your homeserver with
|
|
|
TURN.
|
|
|
|
|
|
-The synapse Matrix Home Server supports integration with TURN server via the
|
|
|
+The synapse Matrix homeserver supports integration with TURN server via the
|
|
|
[TURN server REST API](<https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00>). 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.
|
|
|
|
|
|
The following sections describe how to install [coturn](<https://github.com/coturn/coturn>) (which implements the TURN REST API) and integrate it with synapse.
|
|
@@ -165,18 +165,18 @@ This will install and start a systemd service called `coturn`.
|
|
|
|
|
|
## Synapse setup
|
|
|
|
|
|
-Your home server configuration file needs the following extra keys:
|
|
|
+Your homeserver configuration file needs the following extra keys:
|
|
|
|
|
|
1. "`turn_uris`": 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.
|
|
|
2. "`turn_shared_secret`": 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.
|
|
|
3. "`turn_user_lifetime`": 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).
|
|
|
4. "`turn_allow_guests`": Whether to allow guest users to use the
|