view mod_measure_muc/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 39931d727c22
children
line wrap: on
line source

---
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
  ------- -------------