Mercurial > prosody-modules

annotate mod_muc_anonymize_moderation_actions/README.md @ 6562:5da6fb562df9 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_unified_push: Fix push error handling (fixes #2000) Use the error object that send_iq() passes as an argument to it's reject callback instead of attempting and failing to do the parsing in the callback itself.
author kmq
date Mon, 06 Jul 2026 14:23:57 +0200
parents 86989059de5b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6214
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
1 ---
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
2 labels:
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
3 - 'Stage-Alpha'
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
4 summary: Anonymize moderator actions for participants
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
5 ---
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
6
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
7 ## Introduction
5941
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 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
10
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
11 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
12 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
13
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
14 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
15
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
16
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
17 ## Configuration
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
18
6214
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
19 Just enable the module on your MUC Component.
5941
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
20 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
21
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
22 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
23 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
24
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
25 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
26
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
27 ``` lua
6214
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
28 Component "muc.example.com" "muc"
5941
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
29 modules_enabled = { "muc_anonymize_moderation_actions" }
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
30 anonymize_moderation_actions_form_position = 96
d58e4c70feb2 mod_muc_anonymize_moderation_actions: first commit.
John Livingston <git@john-livingston.fr>
parents:
diff changeset
31 ```
6214
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
32
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
33 ## Compatibility
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
34
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
35 ------ ----------------------
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
36 trunk Works as of 25-05-12
6224
86989059de5b :multibe Readme.md: correct prosody 0.13 to 13
Menel <menel@snikket.de>
parents: 6214
diff changeset
37 13 Works
6214
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
38 0.12 Works
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
39 ------ ----------------------
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
40
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
41 ### License
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
42
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
43 SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/>
cc5c0f1dc89b mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License.
Menel <menel@snikket.de>
parents: 5975
diff changeset
44 SPDX-License-Identifier: AGPL-3.0-only