File

mod_muc_webchat_url/README.markdown @ 5420:aa068449b0b6

mod_http_oauth2: Bail out of implicit flow on invalid or missing redirect Probably hasn't been tested, and maybe never will since it's disabled and more or less deprecated in OAuth 2.1
author Kim Alvefur <zash@zash.se>
date Sat, 06 May 2023 12:23:22 +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.