view mod_muc_rai/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents f14c862598a9
children
line wrap: on
line source

# Introduction

This module implements [XEP-xxxx: Room Activity Indicators](https://xmpp.org/extensions/inbox/room-activity-indicators.html).

## Requirements

This module currently depends on mod_muc_markers, so review the requirements for that module.

# Configuring

## Enabling

``` {.lua}
Component "rooms.example.net" "muc"
modules_enabled = {
    "muc_rai";
    "muc_markers";
    "muc_mam";
}
```

## Settings

|Name |Description |Default |
|-----|------------|--------|
|muc_rai_max_subscribers| Maximum number of active subscriptions allowed | 1024 |

# Compatibility

Requires Prosody trunk (2020-04-15+).