diff mod_muc_rai/README.markdown @ 3974:f14c862598a9

mod_muc_rai: New module to implement Room Activity Indicators
author Matthew Wild <mwild1@gmail.com>
date Wed, 15 Apr 2020 21:19:45 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_rai/README.markdown	Wed Apr 15 21:19:45 2020 +0100
@@ -0,0 +1,30 @@
+# 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+).
\ No newline at end of file