Software /
code /
prosody-modules
File
mod_s2s_status/README.md @ 6112:4c0e3fe57e92
mod_compliance_latest: Gracefull error logging on missing dependency.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
--- a/mod_compliance_latest/README.md
+++ b/mod_compliance_latest/README.md
@@ -9,13 +9,15 @@ rockspec:
# Introduction
-This module will always require and load to the lastest compliance tester we have in the community modules.
-Currently this is [mod_compliance_2023].
+This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023]. See the linked module for further details.
+
+If you do not use the *Prosody plugin installer* this module will likely have limited value to you.
+You can also just install the current compliance tester manually.
# Configuration
-Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
-See the linked module for further details.
+Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*.
# Compatibility
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
--- a/mod_compliance_latest/mod_compliance_latest.lua
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -1,1 +1,6 @@
-module:depends("compliance_2023");
+local success, err = pcall(function() module:depends("compliance_2023") end)
+
+if not success then
+ module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?")
+ return 1, "Error: Couldn't load dependency mod_compliance_2023."
+end
author | Menel <menel@snikket.de> |
---|---|
date | Mon, 23 Dec 2024 12:58:03 +0100 |
parent | 6003:fe081789f7b5 |
line wrap: on
line source
--- labels: - 'Stage-Alpha' summary: 'Track the status and health of s2s connections' ... Introduction ============ Prosody already gives some insight into current s2s connections, e.g. via the `s2s:show()` command in the console. This will tell you about all current s2s connections. However sometimes this is not enough. For example if an s2s connection fails to establish, it won't show up - you have to go digging through the log file looking for the errors instead. This module maintains a record of recent connection attempts to a remote domain. You can use this module to answer questions such as: - Why did the last connection attempt to `example.com` fail? - When did I last have a successful connection with `example.com`? - Are my s2s connections generally stable? **Note:** At the time of writing, this module is not yet finished, and should be considered a proof-of-concept. # Configuration Just load the module as normal: ``` {.lua} modules_enabled = { ... "s2s_status"; ... } ``` # Compatibility trunk (0.12) and later, e.g. due to [60676b607b6d](https://hg.prosody.im/trunk/rev/60676b607b6d).