summaryrefslogtreecommitdiff
path: root/content/coturn.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/coturn.md')
-rw-r--r--content/coturn.md115
1 files changed, 115 insertions, 0 deletions
diff --git a/content/coturn.md b/content/coturn.md
new file mode 100644
index 0000000..b49c47c
--- /dev/null
+++ b/content/coturn.md
@@ -0,0 +1,115 @@
+---
+title: "Coturn"
+date: 2022-03-29
+short_desc: 'A STUN and TURN server that allows users to perform WebRTC calls while being behind NATs.'
+icon: "webrtc.svg"
+img: "webrtc.svg"
+tags: ['service']
+---
+
+[Coturn](https://github.com/coturn/coturn) is a libre **STUN** and **TURN** server software that allows users of internet applications or protocols (Such as [XMPP](/prosody) and [Matrix](/matrix)) to perform WebRTC **voice and video calls** despite them being behind NATs.
+
+If you want to add video and voice calling natively to your XMPP or Matrix server (or a myriad of various other applications), you'll need to install Coturn and configure it appropriately.
+
+### Note on ejabberd
+If you're installing [ejabberd,](/ejabberd) then *you don't need Coturn.* Ejabberd comes with a TURN server built-in, and you should only setup ejabberd to connect to Coturn if you intend on running **multiple chat services** like Matrix and XMPP.
+
+## Installation
+
+Coturn is available in the Debian repositories:
+
+```sh
+apt install coturn
+```
+
+## Configuration
+
+### Base configuration
+
+Coturn\'s configuration file is `/etc/turnserver.conf`. There are a few
+aspects that need to be changed in order to get a fully-functioning
+turnserver.
+
+Here is an example of some sane defaults:
+
+```txt
+server-name={{<hl>}}turn.example.org{{</hl>}}
+realm={{<hl>}}turn.example.org{{</hl>}}
+listening-ip=your_public_ip
+
+listening-port=3478
+min-port=10000
+max-port=20000
+
+## The "verbose" option is useful for debugging issues
+verbose
+```
+
+### Authentication
+
+There are two options for authentication on a turnserver:
+
+1. **Usernames** and **passwords**
+2. **Authentication secrets**
+
+Depending on what self-hosted service is being used in conjunction with Coturn, you may need one or the other of these two options.
+
+#### Usernames and Passwords
+
+To utilize username and password authentication with Coturn, add the following configuration in `turnserver.conf`:
+
+```txt
+lt-cred-mech
+user=username:password
+```
+
+#### Authentication Secrets
+
+To utilize authentication secrets with Coturn, add the following
+configuration in `turnserver.conf`:
+
+```txt
+use-auth-secret
+static-auth-secret={{<hl>}}your_auth_secret{{</hl>}}
+```
+
+### TURNS (TLS Encryption)
+
+Some self-hosted services may support the use of **TURNS:** An encrypted version of TURN, which allows for WebRTC connections to be established with the use of an encrypted TLS tunnel, just like HTTPS allows for encrypted viewing of websites.
+
+*Note: This does **not** affect the encryption of the audio or video feeds. This only makes the requests to the TURN servers encrypted, which is still desireable for security. Any encryption of the call contents will be handled by the client and server of the application you are using.*
+
+To utilize TURNS, certificates need to be declared for **turn.example.org** in `turnserver.conf`:
+
+```txt
+cert=/etc/letsencrypt/live/{{<hl>}}turn.example.org{{</hl>}}/fullchain.pem
+pkey=/etc/letsencrypt/live/{{<hl>}}turn.example.org{{</hl>}}/privkey.pem
+```
+
+In this example, Letsencrypt certificates generated with `certbot` are used.
+
+
+
+## Starting Coturn
+
+After all configuration changes are complete, Coturn can be started with its systemd daemon:
+
+```sh
+systemctl restart coturn
+```
+
+## Configuring your application
+
+At this stage, you should look in your application's own guide on how to set the TURN and STUN server settings. Configure it to point at **turn.example.org** and use either your **username and password pair** or your super-secure **authentication secret.**
+
+- [How to configure TURN on ejabberd](/ejabberd#voice-and-video-calls)
+- [How to configure TURN on Prosody](/prosody#voice-and-video-calls)
+- [How to configure TURN on Matrix Synapse](/matrix#voice-and-video-calls)
+- [How to configure TURN on Matrix Dendrite](/dendrite#voice-and-video-calls)
+
+Congratulations! You've successfully setup a Coturn server!
+
+---
+
+Written by [Denshi.](https://denshi.org)
+Donate Monero at: `48dnPpGgo8WernVJp5VhvhaX3u9e46NujdYA44u8zuMdETNC5jXiA9S7JoYMM6qRt1ZcKpt1J3RZ3JPuMyXetmbHH7Mnc9C`