annotate mod_turncredentials/README.markdown @ 5498:1fa1545ebc40

misc/lnav: Add a README with installation instructions
author Kim Alvefur <zash@zash.se>
date Wed, 31 May 2023 19:31:45 +0200
parents cf1304ad2336
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4002
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4001
diff changeset
1 # Introduction
2473
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
4002
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4001
diff changeset
3 [XEP-0215] implementation for [time-limited TURN
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4001
diff changeset
4 credentials](https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00).
2473
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
4002
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4001
diff changeset
6 # Configuration
2473
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 Option Type Default
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 ------------------------- -------- ------------
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 turncredentials\_secret string *required*
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 turncredentials\_host string *required*
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 turncredentials\_port number `3478`
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 turncredentials\_ttl number `86400`
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
4003
b6fdd7e24bcc mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4002
diff changeset
15 # Compatible TURN / STUN servers.
2473
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
4003
b6fdd7e24bcc mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4002
diff changeset
17 - [coturn](https://github.com/coturn/coturn) - [setup guide][doc:coturn]
b6fdd7e24bcc mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4002
diff changeset
18 - [restund](http://www.creytiv.com/restund.html)
4055
cf1304ad2336 mod_turncredentials/README: Link to eturnal (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4020
diff changeset
19 - [eturnal](https://eturnal.net/)
4020
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4005
diff changeset
20
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4005
diff changeset
21 # Compatibility
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4005
diff changeset
22
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4005
diff changeset
23 Incompatible with [mod_extdisco](https://modules.prosody.im/mod_extdisco.html)