mod_turncredentials/README.markdown
author Kim Alvefur <zash@zash.se>
Mon, 16 May 2022 19:47:09 +0200
changeset 4945 e7b9bc629ecc
parent 4059 cf1304ad2336
permissions -rw-r--r--
mod_rest: Add special handling to catch MAM results from remote hosts Makes MAM queries to remote hosts works. As the comment says, MAM results from users' local archives or local MUCs are returned via origin.send() which is provided in the event and thus already worked. Results from remote hosts go via normal stanza routing and events, which need this extra handling to catch. This pattern of iq-set, message+, iq-result is generally limited to MAM. Closest similar thing might be MUC join, but to really handle that you would need the webhook callback mechanism.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4006
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4005
diff changeset
     1
# Introduction
2477
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
4006
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4005
diff changeset
     3
[XEP-0215] implementation for [time-limited TURN
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4005
diff changeset
     4
credentials](https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00).
2477
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
4006
9e84a9cc3415 mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents: 4005
diff changeset
     6
# Configuration
2477
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
4007
b6fdd7e24bcc mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4006
diff changeset
    15
# Compatible TURN / STUN servers.
2477
fa8fe2ab332f mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
4007
b6fdd7e24bcc mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4006
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: 4006
diff changeset
    18
-   [restund](http://www.creytiv.com/restund.html)
4059
cf1304ad2336 mod_turncredentials/README: Link to eturnal (thanks Holger)
Kim Alvefur <zash@zash.se>
parents: 4024
diff changeset
    19
-   [eturnal](https://eturnal.net/)
4024
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4009
diff changeset
    20
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4009
diff changeset
    21
# Compatibility
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4009
diff changeset
    22
4b47c8eeca22 mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents: 4009
diff changeset
    23
Incompatible with [mod_extdisco](https://modules.prosody.im/mod_extdisco.html)