Mercurial > prosody-modules
annotate mod_limit_auth/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 |
|---|---|
| 1858 | 1 --- |
| 2 summary: Throttle authentication attempts with optional tarpit | |
| 3 ... | |
| 4 | |
| 5 Introduction | |
| 6 ============ | |
| 7 | |
| 8 This module lets you put a per-IP limit on the number of failed | |
| 9 authentication attempts. | |
| 10 | |
| 11 It features an optioanal | |
| 12 [tarpit](https://en.wikipedia.org/wiki/Tarpit_%28networking%29), i.e. | |
| 13 waiting some time before returning an "authentication failed" response. | |
| 14 | |
| 15 Configuration | |
| 16 ============= | |
| 17 | |
| 18 ``` {.lua} | |
| 19 modules_enabled = { | |
| 20 -- your other modules | |
| 21 "limit_auth"; | |
| 22 } | |
| 23 | |
| 24 limit_auth_period = 30 -- over 30 seconds | |
| 25 | |
| 26 limit_auth_max = 5 -- tolerate no more than 5 failed attempts | |
| 27 | |
|
2121
4916c1b6517f
Update READMEs to indicate that async requires trunk (dropped from prosody 0.10)
Kim Alvefur <zash@zash.se>
parents:
1858
diff
changeset
|
28 -- Will only work with Prosody trunk: |
| 1858 | 29 limit_auth_tarpit_delay = 10 -- delay answer this long |
| 30 ``` | |
| 31 | |
| 32 Compatibility | |
| 33 ============= | |
| 34 | |
|
2121
4916c1b6517f
Update READMEs to indicate that async requires trunk (dropped from prosody 0.10)
Kim Alvefur <zash@zash.se>
parents:
1858
diff
changeset
|
35 Requires 0.9 or later. The tarpit feature requires Prosody trunk. |
