Mercurial > prosody-modules
annotate mod_log_messages_sql/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 |
|---|---|
|
2406
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
1 # Introduction |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
2 |
|
3438
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
3 ::: {.alert .alert-danger} |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
4 Consider using [mod_mam][doc:modules:mod_mam] together with |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
5 [mod_readonly] instead. |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
6 ::: |
|
b74c86d137c9
mod_log_messages_sql/README: Add pointer towards mod_mam + mod_readonly
Kim Alvefur <zash@zash.se>
parents:
2406
diff
changeset
|
7 |
| 2323 | 8 This module logs messages to a SQL database. |
| 9 | |
| 10 SQL connection options are configured in a `message_log_sql` option, | |
| 11 which has the same syntax as the `sql` option for | |
| 12 [mod_storage_sql][doc:modules:mod_storage_sql]. | |
| 13 | |
|
2406
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
14 # Usage |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
15 |
| 2323 | 16 You will need to create the following table in the configured database: |
| 17 | |
| 18 ``` sql | |
| 19 CREATE TABLE `prosodyarchive` ( | |
| 20 `host` TEXT, | |
| 21 `user` TEXT, | |
| 22 `store` TEXT, | |
| 23 `id` INTEGER PRIMARY KEY AUTOINCREMENT, | |
| 24 `when` INTEGER, | |
| 25 `with` TEXT, | |
| 26 `resource` TEXT, | |
| 27 `stanza` TEXT); | |
| 28 ``` | |
|
2406
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
29 |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
30 # Compatibility |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
31 |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
32 Does *NOT* work with 0.10 due to a conflict with the new archiving |
|
a216be9b1d6e
mod_log_messages_sql/README: Point out incompatibility with 0.10
Kim Alvefur <zash@zash.se>
parents:
2323
diff
changeset
|
33 support in `mod_storage_sql`ยท |
