Mercurial > prosody-modules
view mod_muc_webchat_url/README.markdown @ 4298:020dd0a59f1f
mod_muc_markers: Add option for @id rewriting, default off (may break some clients)
XEP-0333 was updated to clarify that stanza-id should be used
instead of the 'id' attribute when in a MUC. Some clients still
use the id attribute, which is why we were rewriting it.
Rewriting is bad because mod_muc advertises stable_id, indicating
that Prosody does *not* rewrite ids. Recent versions of Conversations
actually depend on this being true.
All clients should migrate to using stanza-id for markers. See XEP-0333.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Mon, 14 Dec 2020 12:09:25 +0000 |
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.