Mercurial > prosody-modules
annotate mod_http_admin_api/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 | fc607d79765a |
| children |
| rev | line source |
|---|---|
|
5988
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
1 --- |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
2 summary: "admin api from the snikket projects web portal" |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
3 labels: |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
4 - 'Stage-Beta' |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
5 rockspec: |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
6 dependencies: |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
7 - mod_cloud_notify |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
8 - mod_lastlog2 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
9 - mod_groups_internal |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
10 ... |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
11 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
12 Introduction |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
13 ============ |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
14 |
|
5989
74c6fdf4d868
mod_http_admin_api: README.md update
Menel <menel@snikket.de>
parents:
5988
diff
changeset
|
15 ...to be done... |
|
5988
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
16 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
17 Configuration |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
18 ============= |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
19 There is no configuration for this module, just add it to |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
20 modules\_enabled as normal. |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
21 |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
22 # Compatibility |
|
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
23 |
|
5996
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
24 Depends on community modules: |
| 5994 | 25 |
|
5996
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
26 * [mod_cloud_notify] |
|
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
27 * [mod_lastlog2] |
|
fc607d79765a
mod_http_admin_api: README.md add links
Menel <menel@snikket.de>
parents:
5994
diff
changeset
|
28 * [mod_groups_internal] |
|
5988
e2e387e83ded
mod_http_admin_api: README.md initial stub file
Menel <menel@snikket.de>
parents:
diff
changeset
|
29 |
| 5992 | 30 Prosody Version Support Status |
| 31 ---------------- ---------------- | |
| 32 trunk[^1] Works | |
| 33 0.12 unknown | |
| 34 ---------------- ---------------- | |
|
5989
74c6fdf4d868
mod_http_admin_api: README.md update
Menel <menel@snikket.de>
parents:
5988
diff
changeset
|
35 |
| 5991 | 36 [^1]: as of 2024-10-23 |
