Mercurial > prosody-modules
annotate mod_admin_blocklist/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 | 0e0c6618e154 |
| children | 1661f6a74141 |
| rev | line source |
|---|---|
| 1855 | 1 --- |
| 6075 | 2 summary: Block s2s connections based on admin blocklist |
|
5976
bd0b4d8aa94e
mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
3 labels: |
|
bd0b4d8aa94e
mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
4 - 'Stage-Beta' |
| 1855 | 5 ... |
| 6 | |
| 7 This module uses the blocklists set by admins for blocking s2s | |
| 8 connections. | |
| 9 | |
|
2315
212564152060
mod_admin_blocklist/README: Autolinks!
Kim Alvefur <zash@zash.se>
parents:
2314
diff
changeset
|
10 So if an admin blocks a bare domain using [Blocking Command][xep191] |
|
2316
2a2de19413e7
mod_admin_blocklist/README: Turns out autolink.lua doesn't know about official modules
Kim Alvefur <zash@zash.se>
parents:
2315
diff
changeset
|
11 via [mod\_blocklist][doc:modules:mod_blocklist] then no s2s connections |
|
2a2de19413e7
mod_admin_blocklist/README: Turns out autolink.lua doesn't know about official modules
Kim Alvefur <zash@zash.se>
parents:
2315
diff
changeset
|
12 will be allowed to or from that domain. |
|
5017
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
13 |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
14 # Configuring |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
15 |
|
5976
bd0b4d8aa94e
mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
16 The role or roles that determine whether a |
|
5017
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
17 particular users blocklist is used can be configured: |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
18 |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
19 ```lua |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
20 -- This is the default: |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
21 admin_blocklist_roles = { "prosody:operator", "prosody:admin" } |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
22 ``` |
|
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
23 |
| 6075 | 24 # Compatibility |
|
5017
96e83b4a93f7
mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents:
2316
diff
changeset
|
25 |
| 6075 | 26 Prosody-Version Status |
| 27 --------------- ------ | |
| 28 trunk* Works | |
| 29 0.12 Works | |
|
5976
bd0b4d8aa94e
mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
30 |
| 6075 | 31 *as of 2024-12-21 |
