Software /
code /
prosody-modules
File
mod_muc_webchat_url/README.md @ 6052:451ec67f2dd3
mod_s2s_idle_timeout: Reword README
'HG:' are removed. HG: Leave message empty to abort
commit. HG: -- HG: user: Menel <menel@snikket.de>
mod_s2s_idle_timeout/README.md
author | Menel <menel@snikket.de> |
---|---|
date | Mon, 11 Nov 2024 23:19:33 +0100 |
parent | 6003:fe081789f7b5 |
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.