annotate mod_query_client_ver/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
2994
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # Introduction
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module sends a [version query][xep0092] to clients when they
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 connect, and logs the response, allowing statistics of client usage to
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 be recorded.
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 Note that since this is per connection, there will be a bias towards
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 mobile clients on bad connections.
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 ## Example
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
9842979f3034 mod_query_client_ver: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 info Running Running Swift version 4.0