ansible_home

A collection of Ansible roles for home free software self-hosting.

View on GitHub

CoTURN Ansible Role

Description

This role installs the CoTURN TURN/STUN server.

Features

Configuration:

Dependencies

None

Variables

Mandatory

Name Default Value Description
coturn_realm   Server domain.
coturn_static_auth_secret   TURN credentials.

Optional

Name Default Value Description
coturn_allowed_peer_ips Host addresses Peer addresses or ranges (ip or ip-ip) allowed despite coturn_denied_peer_ips. Defaults to the IPv4 and IPv6 addresses of the server’s default routes, so calls where both clients use this relay work. TCP relays are turned off (no-tcp-relay), so these addresses expose no TCP service.
coturn_bps_capacity 0 Maximum bandwidth per session. Defaults to no limit.
coturn_denied_peer_ips Private and reserved ranges Peer address ranges the relay refuses to reach: private networks, loopback, link-local, translation, documentation, segment routing and multicast ranges (IPv4 and IPv6). Keeps TURN users out of the local network. Set to [] to remove the restriction.
coturn_firewalld_source   If specified, restrict TURN/STUN access to the specified sources list in CIDR notation (["192.168.1.10/32", "192.168.1.0/24", "2001:db8:1234:5678::/64"], …). By default, allow all using the public zone. Exclusive with the coturn_firewalld_zone parameter. The coturn zone is removed when unset.
coturn_firewalld_zone   If specified, the existing firewalld zone where TURN/STUN access is allowed. By default, use the public zone. The service is removed from the public zone when another zone is used, and the admin zone keeps it when coturn_firewalld_zone is admin. The coturn zone is removed when coturn_firewalld_source is unset, unless coturn_firewalld_zone is coturn. Exclusive with the coturn_firewalld_source parameter.
coturn_listening_port 3478 TURN server port.
coturn_max_port 65535 Upper bound of the UDP port range used for relay endpoints. Opened in the firewall.
coturn_min_port 49152 Lower bound of the UDP port range used for relay endpoints. Opened in the firewall.
coturn_tls_certificate   Path to the TLS certificate associated with the coturn_realm domain.
coturn_tls_certificate_key   Path to the TLS private key associated with the coturn_realm domain.
coturn_tls_listening_port 5349 TURN TLS port.
coturn_total_quota 0 Simultaneous connections limit. Defaults to no limit.

Example Playbook

---
- hosts: all
  become: true
  collections:
    - jgoutin.home
  roles:
    - coturn
  vars:
    coturn_realm: my_turn.com
    coturn_static_auth_secret: my_secret_password