Mercurial > prosody-modules
view mod_muc_webchat_url/README.markdown @ 4838:fd2e48d4ac94
mod_bookmarks2: Advertise XEP-0049 support
In the case mod_private isn’t loaded, some clients (like poezio) won’t even
attempt to use Private XML Storage unless this feature is advertised. This is
on the domain JID and not on the account JID!
author | Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> |
---|---|
date | Sun, 26 Dec 2021 14:51:35 +0100 |
parents | 8ee5816363b0 |
children |
line wrap: on
line source
# Introduction Many projects have a support room accessible via a web chat. This module allows making the URL to such a web chat discoverable via the XMPP service discovery protocol, enabling e.g. [search engines](https://search.jabbercat.org/) to index and present these. # Configuring ## Enabling ``` {.lua} Component "rooms.example.net" "muc" modules_enabled = { "muc_webchat_url"; } ``` ## Settings The URL is configured using the in-band MUC room configuration protocol. The module can optionally be configured to give all public (not members-only, hidden or password protected) rooms gain a default value based on a template: ``` {.lua} muc_webchat_baseurl = "https://chat.example.com/join?room={node}" ``` The following variables will be subsituted with room address details: `{jid}` : The complete room address, eg `room@muc.example.com`· `{node}` : The local part (before the `@`) of the room JID. `{host}` : The domain name part of the room JID.