Mercurial > prosody-modules
annotate mod_nodeinfo2/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 |
|---|---|
|
3785
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
1 --- |
|
5899
694b62d8a82f
various/README: Fix 'labels' metadata, should be a list
Kim Alvefur <zash@zash.se>
parents:
4595
diff
changeset
|
2 labels: |
|
694b62d8a82f
various/README: Fix 'labels' metadata, should be a list
Kim Alvefur <zash@zash.se>
parents:
4595
diff
changeset
|
3 - Stage-Alpha |
|
3785
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
4 --- |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
5 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
6 Introduction |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
7 ============ |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
8 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
9 This module exposes a [nodeinfo2](https://git.feneas.org/jaywink/nodeinfo2) |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
10 .well-known URL for use e.g. from |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
11 [the-federation.info](https://the-federation.info). |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
12 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
13 Configuration |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
14 ============= |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
15 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
16 Enable the `nodeinfo` module in your global `modules_enabled` section: |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
17 ``` |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
18 modules_enabled = { |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
19 ... |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
20 "nodeinfo2" |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
21 ... |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
22 } |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
23 ``` |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
24 |
|
3792
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
25 Set the `nodeinfo2_expose_users` option to false if you don’t want to expose |
|
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
26 statistics about the amount of users you host: |
|
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
27 ``` |
|
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
28 nodeinfo2_expose_users = false |
|
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
29 ``` |
|
aec772bbd558
mod_nodeinfo2: Only expose amount of accounts if nodeinfo2_expose_users isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3789
diff
changeset
|
30 |
|
3789
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3785
diff
changeset
|
31 Set the `nodeinfo2_expose_posts` option to false if you don’t want to expose |
|
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3785
diff
changeset
|
32 statistics about the amount of messages being exchanged by your users: |
|
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3785
diff
changeset
|
33 ``` |
|
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3785
diff
changeset
|
34 nodeinfo2_expose_posts = false |
|
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3785
diff
changeset
|
35 ``` |
|
e3b673df3906
mod_nodeinfo2: Only expose message stats if nodeinfo2_expose_posts isn’t set to false
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
3785
diff
changeset
|
36 |
|
3830
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3792
diff
changeset
|
37 This module depends on |
|
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3792
diff
changeset
|
38 [mod\_lastlog](https://modules.prosody.im/mod_lastlog.html) to calculate user |
|
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3792
diff
changeset
|
39 activity, and [mod\_http](https://prosody.im/doc/http). Most of its |
|
63d8072dc864
mod_nodeinfo2: Mention mod_lastlog as a dep in the README
Maxime “pep” Buquet <pep@bouah.net>
parents:
3792
diff
changeset
|
40 configuration actually happens in this dependency. |
|
3785
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
41 |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
42 Compatibility |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
43 ============= |
|
6273705e3830
mod_nodeinfo2: Add a README
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
diff
changeset
|
44 |
|
4595
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
45 ------- -------------------- |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
46 trunk Does not work [^1] |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
47 0.11 Should work |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
48 ------- -------------------- |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
49 |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
50 [^1]: not after |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3830
diff
changeset
|
51 [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5) |
