Diff

mod_muc_activity/README.md @ 6138:9db1529c06c2

Merge upstream
author tmolitor <thilo@eightysoft.de>
date Sun, 05 Jan 2025 17:50:02 +0100
parent 6133:a0429c322454
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_activity/README.md	Sun Jan 05 17:50:02 2025 +0100
@@ -0,0 +1,17 @@
+---
+summary: 'XEP-0502 (MUC Activity Indicator) implementation'
+...
+
+This module provides an implementation of [XEP-0502 (MUC Activity Indicator)](https://xmpp.org/extensions/xep-0502.html) for Prosody.
+
+To enable it, load it on a MUC host, for example:
+
+```lua
+Component "chat.domain.example" "muc"
+    modules_enabled = { "muc_activity" }
+```
+
+When this module is loaded, it will expose the average number of messages per hour for all public MUCs.
+The number is calculated over a 24 hour window.
+
+Note that this module may impact server performance on servers with many MUCs.