Mercurial > prosody-modules
annotate mod_muc_anonymize_moderation_actions/README.markdown @ 5941:d58e4c70feb2
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 |
rev | line source |
---|---|
5941
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
1 <!-- |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
2 SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
3 SPDX-License-Identifier: AGPL-3.0-only |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
4 --> |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
5 # mod_muc_anonymize_moderation_actions |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
6 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
7 This modules allows to anonymize affiliation and role changes in MUC rooms. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
8 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
9 Enabling this module on a MUC Virtualhost will add a settings in the roomconfig form. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
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. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
11 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
12 This is particularly usefull to prevent some revenge when a moderator bans someone. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
13 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
14 This module is under AGPL-3.0 license. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
15 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
16 It was tested on Prosody 0.12.x. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
17 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
18 ## Configuration |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
19 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
20 Just enable the module on your MUC VirtualHost. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
21 The feature will be accessible throught the room configuration form. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
22 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
23 You can tweak the position of the settings in the MUC configuration form using `anonymize_moderation_actions_form_position`. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
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. |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
25 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
26 By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom (default value is `78`). |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
27 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
28 ``` lua |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
29 VirtualHost "muc.example.com" |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
30 modules_enabled = { "muc_anonymize_moderation_actions" } |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
31 anonymize_moderation_actions_form_position = 96 |
d58e4c70feb2
mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff
changeset
|
32 ``` |