Mercurial > prosody-modules
annotate mod_atom/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 |
|---|---|
| 3257 | 1 # Introduction |
| 2 | |
| 3 This module exposes users [microblogging][xep277] on Prosodys built-in HTTP server. | |
| 4 | |
|
3574
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
5 # Usage |
|
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
6 |
|
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
7 With default HTTP settings, the microblog of `user@example.com` would be |
|
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
8 seen at `https://example.com:5281/atom/user`. |
|
f478e325529e
mod_atom/README: Add some text about where to look for the atom feed
Kim Alvefur <zash@zash.se>
parents:
3257
diff
changeset
|
9 |
| 3257 | 10 # Configuration |
| 11 | |
| 12 The module itself has no options. However it uses the access control | |
| 13 mechanisms in PubSub, so users must reconfigure their microblogging node | |
| 14 to allow access, by setting `access_model` to `open`. | |
| 15 E.g. Gajim has UI for this, look for "Personal Events" → "Configure | |
| 16 services". | |
| 17 |
