Mercurial > prosody-modules
annotate mod_http_admin_api/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 | fc607d79765a |
| children |
| rev | line source |
|---|---|
|
5988
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
1 --- |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
2 summary: "admin api from the snikket projects web portal" |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
3 labels: |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
4 - 'Stage-Beta' |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
5 rockspec: |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
6 dependencies: |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
7 - mod_cloud_notify |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
8 - mod_lastlog2 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
9 - mod_groups_internal |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
10 ... |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
11 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
12 Introduction |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
13 ============ |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
14 |
|
5989
74c6fdf4d868
mod_http_admin_api: README.md update
Menel <menel@snikket.de>
parents:
5988
diff
changeset
|
15 ...to be done... |
|
5988
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
16 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
17 Configuration |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
18 ============= |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
19 There is no configuration for this module, just add it to |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
20 modules\_enabled as normal. |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
21 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
22 # Compatibility |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
23 |
|
5996
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
24 Depends on community modules: |
| 5994 | 25 |
|
5996
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
26 * [mod_cloud_notify] |
|
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
27 * [mod_lastlog2] |
|
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
28 * [mod_groups_internal] |
|
5988
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
29 |
| 5992 | 30 Prosody Version Support Status |
| 31 ---------------- ---------------- | |
| 32 trunk[^1] Works | |
| 33 0.12 unknown | |
| 34 ---------------- ---------------- | |
|
5989
74c6fdf4d868
mod_http_admin_api: README.md update
Menel <menel@snikket.de>
parents:
5988
diff
changeset
|
35 |
| 5991 | 36 [^1]: as of 2024-10-23 |
