Mercurial > prosody-modules
comparison mod_muc_slow_mode/README.markdown @ 5939:d7c207964aa5
mod_muc_slow_mode: initial commit.
| author | John Livingston <git@john-livingston.fr> |
|---|---|
| date | Fri, 26 Jul 2024 15:47:18 +0200 |
| parents | |
| children | 83787415fc8d |
comparison
equal
deleted
inserted
replaced
| 5938:959382fac20c | 5939:d7c207964aa5 |
|---|---|
| 1 <!-- | |
| 2 SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> | |
| 3 SPDX-License-Identifier: AGPL-3.0-only | |
| 4 --> | |
| 5 # mod_muc_slow_mode | |
| 6 | |
| 7 This module is a custom module that allows slow mode for MUC rooms. | |
| 8 | |
| 9 This module is part of peertube-plugin-livechat, and is under the same LICENSE. | |
| 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. | |
| 12 | |
| 13 ## Configuration | |
| 14 | |
| 15 Just enable the module on your MUC component. | |
| 16 The feature will be accessible throught the room configuration form. | |
| 17 | |
| 18 Depending on your application, it is possible that the slow mode is more important than other fields (for example for a video streaming service). | |
| 19 The position in the room config form can be changed be setting the option `slow_mode_duration_form_position`. | |
| 20 This value will be passed as priority for the "muc-config-form" hook. | |
| 21 By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom. | |
| 22 | |
| 23 ``` lua | |
| 24 VirtualHost "muc.example.com" | |
| 25 modules_enabled = { "muc_slow_mode" } | |
| 26 slow_mode_duration_form_position = 96 | |
| 27 ``` |