Content
Dateianzeige für coturn (1.0.2)
usr/share/doc/coturn/coturn.txt
Das coturn-Paket
Die Einleitung
Bei coTURN ([1]https://github.com/coturn/coturn
) handelt es sich um eine freie Open Source Implementierung eines TURN-
und STUN-Servers.
Ein TURN-Server (Traversal Using Relays around NAT) im Internet,
ermöglicht es zwei Klienten, Daten ohne eine direkte Verbindung
auszutauschen. Dies wird notwendig, wenn es keine Möglichkeit gibt eine
direkte Klient-zu-Klient-Verbindung aufzubauen, weil sich z.B. einer
der Klienten hinter einer Firewall befindet.
Ein STUN-Server (Session Traversal Utilities for NAT) erlaubt es einem
rufenden Klienten im LAN dem angerufenen Klienten außerhalb des LAN
mitteilen, welche IPv4-Adresse (und Portnummer) verwendet werden kann
um eine direkte Kommunikation mit ihm zu ermöglichen ("Peer-to-Peer"
Verbindung).
Die Funktionen
Das coturn-Paket besteht aus folgender Komponente:
* coTURN - Die coTURN-Programmdateien.
([2]https://github.com/coturn/coturn/)
Die Voraussetzungen
Zur Nutzung des Programms werden keine weiteren Programmpakete
benötigt.
Die Installation
Das coturn-Paket wird über das Setup-Menü installiert. Wird eine ältere
Paketversion vorgefunden, so wird diese deinstalliert bevor die neuen
Programmdateien installiert werden.
Das Menü im Setup-Programm
Das Menü im Setup-Programm ist wie folgt aufgebaut:
* View documentation: Anzeigen der Dokumentation
* Edit configuration: Bearbeiten der Konfiguration
* Advanced configuration file handling: Konfigurationen verwalten
* Show status: Status der coTRUN-Dienstes anzeigen
* Start service: Starten des coTRUN-Dienstes
* Stop service: Stoppen des coTRUN-Dienstes
* Restart service: Neustarten des coTRUN-Dienstes
* View log files: Die Logmeldungen anzeigen
* Return: Untermenü verlassen
Die Menüpunkte dürften selbsterklärend sein, da sie keinerlei weitere
Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht
weiter eingegangen.
Die Änderung der Konfiguration
Die Konfiguration kann über den Menüpunkt 'Edit configuration' geändert
werden. Standardmäßig wird der Editor aufgerufen, der in der
Environment-Konfiguration über die Variable 'EDITOR' festgelegt wurde.
Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration
aktiviert werden soll. Wird dies bestätigt, werden über ein Skript die
Anpassungen umgehend wirksam gemacht.
Die Konfigurationsdatei
In der Konfigurationsdatei, die über das Menü zugänglich ist, sind
folgende Parameter vorhanden; wer sie von Hand editieren will findet
sie unter /etc/config.d/coturn.
Die Parameter
START_COTURN
Für die Aktivierung des coTURN-Dienstes muss diese Variable
lediglich auf den Wert `yes' gestellt werden. Die Einstellung
'no' deaktiviert den coTURN-Dienst.
Gültige Werte: yes, no
Standardeinstellung: START_COTURN='no'
COTURN_SERVER_NAME
Über diesen Parameter wird der vollständige Domainname des
Servers (FQDN) festgelegt, unter welchem dieser zukünftig über
das Internet erreicht werden kann. Dieser Name wird u.a. auch
zum Setzen des Realm verwendet. Wird dieser Parameter nicht
gesetzt, so wird automatisch der aktuelle Hostname des Servers
verwendet.
Gültige Werte: vollständige Domainname des Servers (FQDN)
Beispiel: COTURN_SERVER_NAME='mein-coturn.server.de'
COTURN_SERVER_CERT_NAME (optionaler Parameter)
Über diesen Parameter kann ein individuelles Serverzertifikat
für den coTURN-Dienst festgelegt werden. Wird dieser Parameter
nicht gesetzt, so wird standardmäßig nach einem Zertifikat
gesucht welches dem Servernamen (COTURN_SERVER_NAME) entspricht.
Gültige Werte: Serverzertifikat
Beispiel: COTURN_SERVER_CERT_NAME='coturn.local.lan'
COTURN_STATIC_AUTH_SECRET
Über diesen Parameter wird ein statisches
Authentifizierungsgeheimnis festgelegt, welches von der TURN
REST API verwendet wird. Wird dieser Parameter nicht gesetzt, so
wird automatisch `dynamic' angenommen, sodass ein in der
Benutzerdatenbank gespeicherter Wert zur Anwendung kommt. Dieser
kann dann mittels eines separaten Programms ön-the-fly" gesetzt
werden.
Gültige Werte: Authentifizierungsgeheimnis
Beispiel: COTURN_STATIC_AUTH_SECRET='geheim'
COTURN_TELNET_CLI_ENABLED
Um den coTURN-Dienst über die Telnet-Schnittstelle steuern zu
können, muss der Wert dieses Parameters auf `yes' gesetzt
werden, 'no' deaktiviert die Schnittstelle.
Gültige Werte: yes, no
Standardeinstellung: COTURN_TELNET_CLI_ENABLED='no'
COTURN_TELNET_CLI_PASS
Über diesen Parameter wird das Kennwort festgelegt, welches zur
Anmeldung an der Telnet-Schnittstelle des coTURN-Dienstes
verwendet werden soll.
Gültige Werte: Kennwort
Standardeinstellung: COTURN_TELNET_CLI_PASS=”
COTURN_LOG_COUNT
Über diesen Parameter wird eingestellt, wie viele Logdateien
vorgehalten werden sollen. Wird dieser Wert überschritten, so
wird die älteste Logdatei gelöscht.
Gültige Werte: Zahl
Standardeinstellung: COTURN_LOG_COUNT='10'
COTURN_LOG_INTERVAL
Über diesen Parameter wird eingestellt, in welchen Intervallen
die Logdateien archiviert werden sollen. Zur Auswahl stehen die
Schlüsselwörter `daily' - täglich, `weekly' - wöchentlich und
`monthly - monatlich.
Gültige Werte: daily, weekly, monthly
Standardeinstellung: COTURN_LOG_INTERVAL='weekly'
Verschiedenes
Port-Weiterleitungen im Internet-Router einrichten
Um aus dem Internet auf den TURN- und STUN-Dienst zugreifen zu können,
ist es erforderlich Port-Weiterleitungen für TCP und UDP einzurichten.
Folgende eingehende Verbindungen aus dem Internet sind zuzulassen:
3478/tcp # coTRUN (stun-turn)
3478/udp # coTRUN (stun-turn)
5349/tcp # coTRUN (stun-turn-tls)
5349/udp # coTRUN (stun-turn-tls)
Nextcloud-Talk-App konfigurieren
Damit die Talk-App den TURN- und STUN-Dienst verwenden kann, muss man
diese der Software bekannt machen. Hierzu öffnet man die Konfiguration
der App (Einstellungen->Verwaltung->Talk) und nimmt folgende
Einstellungen vor:
ACHTUNG
Der vollständige Servername (FQDN) sollte dem Namen entsprechen, der
über den Parameter [3]COTURN_SERVER_NAME gesetzt wurde.
ACHTUNG
Das TURN-Geheimnis sollte dem Kennwort entsprechen, welches über den
Parameter [4]COTURN_STATIC_AUTH_SECRET gesetzt wurde.
STUN-Server : mein-coturn.server.de:5349
TURN-Server : mein-coturn.server.de:3478
TURN-Geheimnis : statisches Authentifizierungsgeheimnis
TURN-Protokolle: UDP und TCP
Das Glossar
* FQDN - Fully Qualified Domain Name
* STUN - Session Traversal Utilities for NAT
* TURN - Traversal Using Relays around NAT
__________________________________________________________________
References
1. https://github.com/coturn/coturn
2. https://github.com/coturn/coturn/
3. file:///data/home_work/jed/svn/eis-trunk/doc/output/coturn/coturn.tmp#COTURNSERVERNAME
4. file:///data/home_work/jed/svn/eis-trunk/doc/output/coturn/coturn.tmp#COTURNSTATICAUTHSECRET