view mod_turncredentials/README.markdown @ 4004:56a13ba59b28

mod_turncredentials/README: Hide reTURNManager until it's confirmed to support the rest API
author Kim Alvefur <zash@zash.se>
date Fri, 01 May 2020 00:51:56 +0200
parents b6fdd7e24bcc
children fe6cb37ac180
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)

<!--
TODO Check if this one actually suppors the rest credentials api
-   [reTURNManager](https://github.com/thisisdingo/reTURNManager)
-->