Mercurial > prosody-modules
annotate mod_auth_http_async/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 | 7b693a5539ad |
| rev | line source |
|---|---|
|
1933
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
1 --- |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
2 labels: |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
3 - Stage-Alpha |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
4 ... |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
5 |
| 1888 | 6 Introduction |
| 7 ============ | |
| 8 | |
| 9 This is an experimental authentication module that does an asynchronous | |
| 10 HTTP call to verify username and password. | |
| 11 | |
| 12 Details | |
| 13 ======= | |
| 14 | |
| 15 When a user attempts to authenticate to Prosody, this module takes the | |
| 16 username and password and does a HTTP GET request with [Basic | |
| 17 authentication][rfc7617] to the configured `http_auth_url`. | |
| 18 | |
| 19 Configuration | |
| 20 ============= | |
| 21 | |
|
1933
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
22 ``` lua |
| 1888 | 23 VirtualHost "example.com" |
| 24 authentication = "http_async" | |
| 25 http_auth_url = "http://example.com/auth" | |
| 26 ``` | |
| 27 | |
|
1933
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
28 Compatibility |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
29 ============= |
|
afba0821f058
mod_auth_http_async/README: Add compatibility info
Kim Alvefur <zash@zash.se>
parents:
1888
diff
changeset
|
30 |
|
2121
4916c1b6517f
Update READMEs to indicate that async requires trunk (dropped from prosody 0.10)
Kim Alvefur <zash@zash.se>
parents:
1933
diff
changeset
|
31 Requires Prosody trunk |
