Mercurial > prosody-modules

annotate mod_muc_slow_mode/README.markdown @ 5941:d58e4c70feb2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_anonymize_moderation_actions: first commit.
author John Livingston <git@john-livingston.fr>
date Fri, 26 Jul 2024 17:07:05 +0200
parents 83787415fc8d
children 22effe87fed2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5939
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
1 <!--
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
2 SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
3 SPDX-License-Identifier: AGPL-3.0-only
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
4 -->
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
5 # mod_muc_slow_mode
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
6
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
7 This module is a custom module that allows slow mode for MUC rooms.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
8
5940
83787415fc8d mod_muc_slow_mode: update readme file.
John Livingston <git@john-livingston.fr>
parents: 5939
diff changeset
9 This module is under AGPL-3.0 license.
5939
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
10
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
11 There will probably be a XEP proposal for this module behaviour. When done, this module will be published in the prosody-modules repository.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
12
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
13 ## Configuration
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
14
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
15 Just enable the module on your MUC component.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
16 The feature will be accessible throught the room configuration form.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
17
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
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).
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
19 The position in the room config form can be changed be setting the option `slow_mode_duration_form_position`.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
20 This value will be passed as priority for the "muc-config-form" hook.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
21 By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom.
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
22
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
23 ``` lua
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
24 VirtualHost "muc.example.com"
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
25 modules_enabled = { "muc_slow_mode" }
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
26 slow_mode_duration_form_position = 96
d7c207964aa5 mod_muc_slow_mode: initial commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
27 ```