File

mod_muc_webchat_url/README.md @ 6159:82a10e21b7f9

mod_anti_spam: prosody 0.12 compat diff --git a/mod_anti_spam/trie.lib.lua b/mod_anti_spam/trie.lib.lua --- a/mod_anti_spam/trie.lib.lua +++ b/mod_anti_spam/trie.lib.lua @@ -1,4 +1,4 @@ -local bit = require "prosody.util.bitcompat"; +local bit = require "util.bitcompat"; local trie_methods = {}; local trie_mt = { __index = trie_methods };
author Menel <menel@snikket.de>
date Sun, 19 Jan 2025 09:48:10 +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.