Mercurial > prosody-modules
annotate mod_debug_omemo/README.md @ 6084: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 |
| parents | fe081789f7b5 |
| children |
| rev | line source |
|---|---|
|
4682
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 summary: "Generate OMEMO debugging links" |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 labels: |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 - 'Stage-Alpha' |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 ... |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 Introduction |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 ============ |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 This module allows you to view advanced information about OMEMO-encrypted messages, |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 and can be helpful to diagnose decryption problems. |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 It generates a link to itself and adds this link to the plaintext contents of |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 encrypted messages. This will be shown by clients that do not support OMEMO, |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 or are unable to decrypt the message. |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 This module depends on a working HTTP setup in Prosody, and honours the [usual |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 HTTP configuration options](https://prosody.im/doc/http). |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 Configuration |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 ============= |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 There is no configuration for this module, just add it to |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 modules\_enabled as normal. |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 Compatibility |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 ============= |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 ----- ------- |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 0.11 Hopefully works |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 trunk Works |
|
e4e5474420e6
mod_debug_omemo: OMEMO debugging tool
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 ----- ------- |
