diff mod_turncredentials/README.md @ 5975:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_turncredentials/README.markdown@cf1304ad2336
children e37473232b0d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_turncredentials/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,23 @@
+# Introduction
+
+[XEP-0215] implementation for [time-limited TURN
+credentials](https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00).
+
+# Configuration
+
+  Option                    Type     Default
+  ------------------------- -------- ------------
+  turncredentials\_secret   string   *required*
+  turncredentials\_host     string   *required*
+  turncredentials\_port     number   `3478`
+  turncredentials\_ttl      number   `86400`
+
+# Compatible TURN / STUN servers.
+
+-   [coturn](https://github.com/coturn/coturn) - [setup guide][doc:coturn]
+-   [restund](http://www.creytiv.com/restund.html)
+-   [eturnal](https://eturnal.net/)
+
+# Compatibility
+
+Incompatible with [mod_extdisco](https://modules.prosody.im/mod_extdisco.html)