Mercurial > prosody-modules
annotate mod_list_active/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 |
| rev | line source |
|---|---|
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 Description |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 =========== |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 |
| 2638 | 4 This module lists those users, who **have** used their account in a |
| 5 defined time-frame, basically the inverse of [mod_list_inactive]. | |
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 Dependencies |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 ============ |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
|
2190
0c01444f8bc2
mod_list_inactive/README: Describe what the dependency does
Kim Alvefur <zash@zash.se>
parents:
2189
diff
changeset
|
10 [mod_lastlog] must be enabled to collect the data used by this module. |
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 Usage |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 ===== |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 |
| 2638 | 15 prosodyctl mod_list_active example.com time [format] |
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 |
|
2189
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
17 Time is a number followed by 'day', 'week', 'month' or 'year' |
|
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
18 |
|
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
19 Formats are: |
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 |
|
2189
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
21 --------- ------------------------------------------------ |
|
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
22 default `user@example.com` |
|
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
23 event `user@example.com last action` |
|
093b1180aa42
mod_list_inactive/README: Fixup markdown
Kim Alvefur <zash@zash.se>
parents:
2188
diff
changeset
|
24 --------- ------------------------------------------------ |
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 Example |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 ======= |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 |
| 2638 | 29 prosodyctl mod_list_active example.com 1year |
|
2187
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 Help |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 ==== |
|
287f37e6b6e1
mod_list_inactive: Add README.md (fixes issue #684 - thanks t2d2!)
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 |
| 2638 | 34 prosodyctl mod_list_active |
