annotate mod_listusers/README.md @ 6214:cc5c0f1dc89b

mod_muc_anonymize_moderation_actions: Fix mentioning Virtualhost for MUC, Compatibility section and License. diff --git a/mod_muc_anonymize_moderation_actions/README.md b/mod_muc_anonymize_moderation_actions/README.md --- a/mod_muc_anonymize_moderation_actions/README.md +++ b/mod_muc_anonymize_moderation_actions/README.md @@ -1,8 +1,10 @@ -<!-- -SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> -SPDX-License-Identifier: AGPL-3.0-only ---> -# mod_muc_anonymize_moderation_actions +--- +labels: +- 'Stage-Alpha' +summary: Anonymize moderator actions for participants +--- + +## Introduction This modules allows to anonymize affiliation and role changes in MUC rooms. @@ -11,13 +13,10 @@ When the feature is enabled, when a mode This is particularly usefull to prevent some revenge when a moderator bans someone. -This module is under AGPL-3.0 license. - -It was tested on Prosody 0.12.x. ## Configuration -Just enable the module on your MUC VirtualHost. +Just enable the module on your MUC Component. The feature will be accessible throught the room configuration form. You can tweak the position of the settings in the MUC configuration form using `anonymize_moderation_actions_form_position`. @@ -26,7 +25,20 @@ This value will be passed as priority fo By default, the field will be between muc#roomconfig_changesubject and muc#roomconfig_moderatedroom (default value is `78`). ``` lua -VirtualHost "muc.example.com" +Component "muc.example.com" "muc" modules_enabled = { "muc_anonymize_moderation_actions" } anonymize_moderation_actions_form_position = 96 ``` + +## Compatibility + + ------ ---------------------- + trunk Works as of 25-05-12 + 0.13 Works + 0.12 Works + ------ ---------------------- + +### License + +SPDX-FileCopyrightText: 2024 John Livingston <https://www.john-livingston.fr/> +SPDX-License-Identifier: AGPL-3.0-only
author Menel <menel@snikket.de>
date Mon, 12 May 2025 10:42:26 +0200
parents fe081789f7b5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5412
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
1 ---
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
2 labels:
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
3 - 'Stage-Obsolete'
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
4 ---
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
5
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
6 ::: {.alert .alert-warning}
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
7 As of Prosody 0.12.x, `prosodyctl shell user list HOST` can be used
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
8 instead of this module.
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
9 :::
b56a635220f6 mod_listusers: Obsolete, suggest prosodyctl shell instead
Kim Alvefur <zash@zash.se>
parents: 2323
diff changeset
10
2323
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 This module adds a command to `prosodyctl` for listing users.
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 ``` sh
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 prosodyctl mod_listusers
35ae59a8196d Add some documentation stubs
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 ```