diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-10 21:32:49 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-10 21:32:49 -0500 |
| commit | 7137a9c0f0c6511c9a513494955182262a177970 (patch) | |
| tree | ac7f10e8dd9ce075c66d6abeb7c35da7b62d6e32 | |
| parent | 372501cceb3b096c9df38c36d82c843a64d24cc7 (diff) | |
| download | selfhosted-7137a9c0f0c6511c9a513494955182262a177970.tar.gz selfhosted-7137a9c0f0c6511c9a513494955182262a177970.zip | |
add coturn docs
| -rw-r--r-- | roles/coturn/README.md | 36 |
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 +```` |