File

mod_muc_webchat_url/README.markdown @ 5955:07f32bf41303

mod_register_apps: Update Conversations Android version Source: - https://codeberg.org/iNPUTmice/Conversations/src/commit/4eee26e7d381f59a4402db30abbc640efeaf3980/build.gradle#L105 - https://apilevels.com/ Noticed thanks to https://mastodon.sdf.org/@itokoi/112745327733761311
author Kim Alvefur <zash@zash.se>
date Mon, 08 Jul 2024 10:47:07 +0200
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.