Mercurial > prosody-modules
changeset 1889:46c49cff1023
mod_extdisco: Add a README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 01 Oct 2015 20:53:42 +0200 (2015-10-01) |
parents | 3483381c5e46 |
children | 2eac15ab605e |
files | mod_extdisco/README.markdown |
diffstat | 1 files changed, 56 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_extdisco/README.markdown Thu Oct 01 20:53:42 2015 +0200 @@ -0,0 +1,56 @@ +--- +summary: External Service Discovery +... + +Introduction +============ + +This module adds support for [XEP-0215: External Service Discovery], +which lets Prosody advertise non-XMPP services. + +Configuration +============= + +Example services from the XEP: + +``` {.lua} +modules_enabled = { + -- other modules ... + "extdisco"; +} + +external_services = { + ["stun.shakespeare.lit"] = { + port="9998"; + transport="udp"; + type="stun"; + }; + ["relay.shakespeare.lit"] = { + password="jj929jkj5sadjfj93v3n"; + port="9999"; + transport="udp"; + type="turn"; + username="nb78932lkjlskjfdb7g8"; + }; + ["192.0.2.1"] = { + port="8888"; + transport="udp"; + type="stun"; + }; + ["192.0.2.1"] = { + port="8889"; + password="93jn3bakj9s832lrjbbz"; + transport="udp"; + type="turn"; + username="auu98sjl2wk3e9fjdsl7"; + }; + ["ftp.shakespeare.lit"] = { + name="Shakespearean File Server"; + password="guest"; + port="20"; + transport="tcp"; + type="ftp"; + username="guest"; + }; +} +```