aboutsummaryrefslogtreecommitdiffstats
path: root/roles/coturn/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/coturn/README.md')
-rw-r--r--roles/coturn/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/roles/coturn/README.md b/roles/coturn/README.md
new file mode 100644
index 0000000..74101f8
--- /dev/null
+++ b/roles/coturn/README.md
@@ -0,0 +1,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
+````