diff --git a/templates/default/documentation.html.ep b/templates/default/documentation.html.ep index 40a8697..28d1f27 100644 --- a/templates/default/documentation.html.ep +++ b/templates/default/documentation.html.ep @@ -288,18 +288,28 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini If you plan to use VROOM only on a local network, where each peer can connect to each others, you can just omit this part. But if you want VROOM to work from anywhere, you'll need use STUN and most likely TURN too.

@@ -417,10 +427,11 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini

- Setup rfc5766-turn-server + Setup coturn or rfc5766-turn-server

- You can run any TURN server you want, but VROOM integrates well with rfc5766-turn-server. + You can run any TURN server you want, but VROOM is mainly tested rfc5766-turn-server + or coturn (which are very similar). The reference instance https://vroom.im is using coturn. To make use of it, follow those steps

@@ -432,7 +443,7 @@ cp /opt/vroom/conf/settings.ini.dist /opt/vroom/conf/settings.ini Download the latest version from here and extract the archive

- Only the 3.x branch is supported + Branch 3.x is rfc5766-turn-server and 4.x is coturn. 4.x is recommanded
@@ -455,11 +466,10 @@ yum localinstall turnserver-*/*.rpm
 mv /etc/turnserver/turnserver.conf /etc/turnserver/turnserver.conf.default
 cat <<'EOF' > /etc/turnserver/turnserver.conf
-mysql-userdb "host=localhost dbname=vroom user=vroom password=MySuperPassw0rd connect_timeout=5"
 verbose
-syslog
 fingerprint
 lt-cred-mech
+syslog
 no-sslv2
 no-sslv3
 no-tcp
@@ -473,6 +483,8 @@ cert /etc/turnserver/cert.pem
 pkey /etc/turnserver/key.pem
 proc-user turnserver
 proc-group turnserver
+use-auth-secret
+static-auth-secret SuperSecretPassword
 EOF

@@ -481,6 +493,9 @@ EOF
  • Both key and certificate must be readable by turnserver user and/or group
  • You can comment no-tcp, no-udp and alt-tls-listening-port if you want to test without encryption
  • If you have intermediate(s) CA, you have to put them in the cert.pem file, but after your certificate
  • +
  • In this example, the turn server will use TURN REST API compatible authentication, so you must set + credentials='rest' and secret_key='SuperSecretPassword' in the turn section of VROOM's settings.ini +