diff mod_measure_muc/README.markdown @ 3969:39931d727c22

mod_measure_muc: Collect statistics on Grout Chat
author kaliko <kaliko@azylum.org>
date Tue, 07 Apr 2020 18:48:04 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_measure_muc/README.markdown	Tue Apr 07 18:48:04 2020 +0200
@@ -0,0 +1,38 @@
+---
+labels:
+- Statistics
+summary: Collect statistics on Grout Chat
+...
+
+Description
+===========
+
+This module collects statistics from group chat component.
+
+It collects current count of hidden, persistent, archive-enabled, password
+protected rooms. The current count of room is also exposed (hidden+public).
+
+
+Configuration
+=============
+
+mod\_measure\_muc must be load on MUC components (not globally):
+
+```lua
+Component "conference.example.com" "muc"
+		modules_enabled = {
+			"measure_muc";
+		}
+```
+
+See also the documentation of Prosody’s [MUC module](https://prosody.im/doc/modules/mod_muc).
+
+Compatibility
+=============
+
+  ------- -------------
+  trunk   Works
+  0.11    Works
+  0.10    Unknown
+  0.9     Does not work
+  ------- -------------