Mercurial > prosody-modules
annotate mod_turncredentials/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 | 78418e86c003 |
| children |
| rev | line source |
|---|---|
|
5983
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
1 --- |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
2 summary: Implement XEP-0215 |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
3 labels: |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
4 - 'Stage-Obsolete' |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
5 ... |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
6 |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
7 ::: {.alert .alert-warning} |
|
5986
78418e86c003
mod_turncredentials: fix copy error.
Menel <menel@snikket.de>
parents:
5983
diff
changeset
|
8 A similar module is already included in prosody since 0.12, see [mod_turn_external][doc:modules:mod_turn_external] making this module obsolete. |
|
5983
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
9 ::: |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
10 |
|
4002
9e84a9cc3415
mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents:
4001
diff
changeset
|
11 # Introduction |
|
2473
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 |
|
4002
9e84a9cc3415
mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents:
4001
diff
changeset
|
13 [XEP-0215] implementation for [time-limited TURN |
|
9e84a9cc3415
mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents:
4001
diff
changeset
|
14 credentials](https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00). |
|
2473
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
|
4002
9e84a9cc3415
mod_turncredentials/README: Markdown syntax normalization
Kim Alvefur <zash@zash.se>
parents:
4001
diff
changeset
|
16 # Configuration |
|
2473
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 Option Type Default |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 ------------------------- -------- ------------ |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 turncredentials\_secret string *required* |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 turncredentials\_host string *required* |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 turncredentials\_port number `3478` |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 turncredentials\_ttl number `86400` |
|
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 |
|
4003
b6fdd7e24bcc
mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents:
4002
diff
changeset
|
25 # Compatible TURN / STUN servers. |
|
2473
fa8fe2ab332f
mod_turncredentials: Add a stub README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 |
|
4003
b6fdd7e24bcc
mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents:
4002
diff
changeset
|
27 - [coturn](https://github.com/coturn/coturn) - [setup guide][doc:coturn] |
|
b6fdd7e24bcc
mod_turncredentials/README: Link to some stun/turn implementations (thanks Holger)
Kim Alvefur <zash@zash.se>
parents:
4002
diff
changeset
|
28 - [restund](http://www.creytiv.com/restund.html) |
|
4055
cf1304ad2336
mod_turncredentials/README: Link to eturnal (thanks Holger)
Kim Alvefur <zash@zash.se>
parents:
4020
diff
changeset
|
29 - [eturnal](https://eturnal.net/) |
|
4020
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
4005
diff
changeset
|
30 |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
4005
diff
changeset
|
31 # Compatibility |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
4005
diff
changeset
|
32 |
|
4b47c8eeca22
mod_extdisco, mod_turncredentials: Note incompatibility in readmes.
tastytea <tastytea@tastytea.de>
parents:
4005
diff
changeset
|
33 Incompatible with [mod_extdisco](https://modules.prosody.im/mod_extdisco.html) |
|
5983
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
34 |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
35 ------- -------------- |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
36 0.12 Works |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
37 0.11 Works |
|
e37473232b0d
mod_turncredentials: marking obsolete
Menel <menel@snikket.de>
parents:
5975
diff
changeset
|
38 ------- -------------- |
