Mercurial > prosody-modules
comparison mod_muc_webchat_url/README.markdown @ 3672:b8bcea17ccd6
mod_muc_webchat_url: Advertise the URL to a webchat in disco#info
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 17 Sep 2019 17:12:59 +0200 |
| parents | |
| children | 8ee5816363b0 |
comparison
equal
deleted
inserted
replaced
| 3671:73c456d9ec67 | 3672:b8bcea17ccd6 |
|---|---|
| 1 # Introduction | |
| 2 | |
| 3 Many projects have a support room accessible via a web chat. This module | |
| 4 allows making the URL to such a web chat discoverable via the XMPP | |
| 5 service discovery protocol, enabling e.g. [search | |
| 6 engines](https://search.jabbercat.org/) to index and present these. | |
| 7 | |
| 8 # Configuring | |
| 9 | |
| 10 ## Enabling | |
| 11 | |
| 12 ``` {.lua} | |
| 13 Component "rooms.example.net" "muc" | |
| 14 modules_enabled = { | |
| 15 "muc_webchat_url"; | |
| 16 } | |
| 17 ``` | |
| 18 | |
| 19 ## Settings | |
| 20 | |
| 21 The URL is configured using the in-band MUC room configuration protocol. | |
| 22 | |
| 23 The module can optionally be configured to give all public (not | |
| 24 members-only, hidden or password protected) rooms gain a default value | |
| 25 based on a template: | |
| 26 | |
| 27 ``` {.lua} | |
| 28 muc_webchat_url = "https://chat.example.com/join?room={node}" | |
| 29 ``` | |
| 30 | |
| 31 The following variables will be subsituted with room address details: | |
| 32 | |
| 33 `{jid}` | |
| 34 : The complete room address, eg `room@muc.example.com`ยท | |
| 35 | |
| 36 `{node}` | |
| 37 : The local part (before the `@`) of the room JID. | |
| 38 | |
| 39 `{host}` | |
| 40 : The domain name part of the room JID. |