Mercurial > prosody-modules
view mod_alias/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 | 4ac59707bcfb |
| children |
line wrap: on
line source
--- summary: "Point alias accounts or domains to correct XMPP user" labels: - 'Stage-Alpha' ... Introduction ============ This module allows you to set up aliases that alert people who try to contact them or add them to their roster what your actual JID is. This is useful for changing JIDs, or just in the case where you own both example.com and example.net, and want people who contact you@example.com to be alerted to contact you at you@example.net instead. This type of aliasing is well supported in the email world, but very hard to handle with XMPP, this module sidesteps all the hard problems by just sending the user a helpful message, requiring humans to decide what they actually want to do. This doesn't require any special support on other clients or servers, just the ability to receive messages. Configuration ============= Add the module to the `modules_enabled` list. modules_enabled = { ... "alias"; } Then set up your list of aliases, aliases can be full or bare JIDs, or hosts: aliases = { ["old@example.net"] = "new@example.net"; ["you@example.com"] = "you@example.net"; ["conference.example.com"] = "conference.example.net"; } You can also set up a custom response, by default it is: alias_response = "User $alias can be contacted at $target"; A script named mod_alias_postfixadmin.sh is included in this directory to generate the aliases array directly from a postfixadmin MySQL database. Instructions for use are included in the script. Compatibility ============= ------------–---------- -------------- trunk as of 2024-10-22 Works 0.12 Works ----------------------- --------------
