File

mod_muc_webchat_url/README.markdown @ 5719:66986f5271c3

mod_storage_s3: Skip archive items matching on date but not full datetime Since it only encodes dates in paths, it would have returned items from outside the specified start..end range if they were from earlier or later in the same (UTC) day.
author Kim Alvefur <zash@zash.se>
date Sat, 11 Nov 2023 22:26:39 +0100
parent 3674:8ee5816363b0
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.