annotate mod_measure_lua/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 2ac5f459e097
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5584
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 This module provides two [metrics][doc:statistics]:
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 `lua_heap_bytes`
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 : Bytes of memory as reported by `collectgarbage("count")`{.lua}
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 `lua_info`
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 : Provides the current Lua version as a label
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 ``` openmetrics
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 # HELP lua_info Lua runtime version
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 # UNIT lua_info
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 # TYPE lua_info gauge
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 lua_info{version="Lua 5.4"} 1
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 # HELP lua_heap_bytes Memory used by objects under control of the Lua
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 garbage collector
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 # UNIT lua_heap_bytes bytes
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 # TYPE lua_heap_bytes gauge
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 lua_heap_bytes 8613218
2ac5f459e097 mod_measure_lua: Add brief README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 ```