Mercurial > prosody-modules

view mod_turncredentials/README.markdown @ 5668:ecfd7aece33b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
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)