view mod_turncredentials/README.markdown @ 4476:125279f4a5b8

mod_rest: Restructure API spec To make referencing individual fields easier, apparently some things don't like references to individual properties of an object.
author Kim Alvefur <zash@zash.se>
date Sun, 28 Feb 2021 18:55:18 +0100
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)