aboutsummaryrefslogtreecommitdiffstats
path: root/roles/coturn/README.md
blob: 74101f8ade50b1e2bc5d549360f2bf6671ab32ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Coturn
======

Description
-----------

The `coturn` role installs and configures the [coturn](https://github.com/coturn/coturn)
STUN/TURN server.


Variables
---------

This role **accepts** the following variables:

Variable          | Default              | Description
------------------|----------------------|------------
`coturn_port`     | 3478                 | Listening port
`coturn_min_port` | 49152                | Minimum UDP relay port
`coturn_max_port` | 65535                | Maximum UDP relay port
`coturn_realm`    | `{{ domain }}`       | Default realm for users


Usage
-----

Example playbook:

````yaml
- name: configure TURN/STUN servers
  hosts: turn_servers
  roles:
    - role: coturn
      vars:
        coturn_realm: example.com
````