view mod_turncredentials/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents cf1304ad2336
children
line wrap: on
line source

# 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)