Mercurial > prosody-modules

comparison mod_muc_slow_mode/README.markdown @ 5947:22effe87fed2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_slow_mode: adding more context in the README.
author John Livingston <git@john-livingston.fr>
date Mon, 29 Jul 2024 23:07:09 +0200
parents 83787415fc8d
children
comparison
equal deleted inserted replaced
5946:bfb8d7b53954 5947:22effe87fed2
6 6
7 This module is a custom module that allows slow mode for MUC rooms. 7 This module is a custom module that allows slow mode for MUC rooms.
8 8
9 This module is under AGPL-3.0 license. 9 This module is under AGPL-3.0 license.
10 10
11 There will probably be a XEP proposal for this module behaviour. When done, this module will be published in the prosody-modules repository. 11 There will probably be a XEP proposal for this module behaviour.
12
13 ## Slow mode definition
14
15 There are some contexts in which you want to be able to rate limit MUC messages. This could have multiple motivations: avoid flooding, garantee a better readability of the room when there are hundreds of active users, …
16
17 This module propose a new option for MUC rooms, allowing room owners to fix a duration that users must wait between two messages.
18
19 There is a draft XEP for this feature, that you can find here: https://github.com/JohnXLivingston/xeps/blob/xep-slow-mode/xep-slow-mode.xml
20
21 There is a more human-readable version of this XEP here: https://livingston.frama.io/peertube-plugin-livechat/technical/slow_mode/
12 22
13 ## Configuration 23 ## Configuration
14 24
15 Just enable the module on your MUC component. 25 Just enable the module on your MUC component.
16 The feature will be accessible throught the room configuration form. 26 The feature will be accessible throught the room configuration form.