Mercurial > prosody-modules

comparison mod_muc_anonymize_moderation_actions/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
children
comparison
equal deleted inserted replaced
5940:83787415fc8d 5941:d58e4c70feb2
1 <!--
2 SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
3 SPDX-License-Identifier: AGPL-3.0-only
4 -->
5 # mod_muc_anonymize_moderation_actions
6
7 This modules allows to anonymize affiliation and role changes in MUC rooms.
8
9 Enabling this module on a MUC Virtualhost will add a settings in the roomconfig form.
10 When the feature is enabled, when a moderator changes the role or affiliation of an occupant (kick, ban, ...) their name will be removed from the broadcasted message, to not disclose who did the moderation action.
11
12 This is particularly usefull to prevent some revenge when a moderator bans someone.
13
14 This module is under AGPL-3.0 license.
15
16 It was tested on Prosody 0.12.x.
17
18 ## Configuration
19
20 Just enable the module on your MUC VirtualHost.
21 The feature will be accessible throught the room configuration form.
22
23 You can tweak the position of the settings in the MUC configuration form using `anonymize_moderation_actions_form_position`.
24 This value will be passed as priority for the "muc-config-form" hook, so you can move field up by increasing the value, or down by decreasing the value.
25
26 By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom (default value is `78`).
27
28 ``` lua
29 VirtualHost "muc.example.com"
30 modules_enabled = { "muc_anonymize_moderation_actions" }
31 anonymize_moderation_actions_form_position = 96
32 ```