mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-10-31 02:10:05 +00:00
Kevin Veen-Birkenbach
a817d964e4
- Extract common HTTPS + Cloudflare + handler bootstrap into new role sys-stk-front-base - Update sys-stk-front-proxy, web-svc-cdn, web-svc-file, web-svc-html to depend on sys-stk-front-base - Add new sys-stk-semi-stateless role combining front-base + back-stateless - Update web-svc-coturn to use sys-stk-semi-stateless and rewrite README/meta with detailed Coturn description - Unify sys-util-csp-cert README heading Ref: ChatGPT conversation https://chatgpt.com/share/68d6cea2-3570-800f-acb3-c3277317f17b
47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
# Coturn
|
||
|
||
This folder contains the role to deploy and manage a [Coturn](https://github.com/coturn/coturn) service.
|
||
|
||
## Description
|
||
|
||
[Coturn](https://github.com/coturn/coturn) is a free and open-source **TURN (Traversal Using Relays around NAT)** and **STUN (Session Traversal Utilities for NAT)** server.
|
||
It enables real-time communication (RTC) applications such as **WebRTC** to work reliably across NATs and firewalls.
|
||
|
||
Without TURN/STUN, video calls, conferencing, and peer-to-peer connections often fail due to NAT traversal issues.
|
||
Coturn solves this by acting as a **relay server** and/or **discovery service** for public IP addresses.
|
||
|
||
More background:
|
||
* Wikipedia: [Traversal Using Relays around NAT](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT)
|
||
* Wikipedia: [Session Traversal Utilities for NAT](https://en.wikipedia.org/wiki/STUN)
|
||
* Official Coturn Docs: [https://github.com/coturn/coturn/wiki](https://github.com/coturn/coturn/wiki)
|
||
|
||
## Overview
|
||
|
||
This role deploys Coturn via Docker Compose using the `sys-stk-semi-stateless` stack.
|
||
It automatically configures:
|
||
- TURN and STUN listening ports
|
||
- Relay port ranges
|
||
- TLS certificates (via Let’s Encrypt integration)
|
||
- Long-term credentials and/or REST API secrets
|
||
|
||
Typical use cases:
|
||
- Nextcloud Talk
|
||
- Jitsi
|
||
- BigBlueButton
|
||
- Any WebRTC-based application
|
||
|
||
## Features
|
||
|
||
* Stateless container deployment (no database or persistent volume required)
|
||
* Automatic TLS handling via `sys-stk-front-base`
|
||
* TURN and STUN support over TCP and UDP
|
||
* Configurable relay port ranges for scaling
|
||
* Integration into Infinito.Nexus inventory/variable system
|
||
|
||
## Further Resources
|
||
|
||
* Coturn Project — [https://github.com/coturn/coturn](https://github.com/coturn/coturn)
|
||
* Coturn Wiki — [https://github.com/coturn/coturn/wiki](https://github.com/coturn/coturn/wiki)
|
||
* TURN on Wikipedia — [https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT](https://en.wikipedia.org/wiki/Traversal_Using_Relays_around_NAT)
|
||
* STUN on Wikipedia — [https://en.wikipedia.org/wiki/STUN](https://en.wikipedia.org/wiki/STUN)
|