Software /
code /
prosody-modules
Annotate
mod_jsxc/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 |
rev | line source |
---|---|
5164 | 1 --- |
5165
f37d6adce06e
mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents:
5164
diff
changeset
|
2 rockspec: |
f37d6adce06e
mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents:
5164
diff
changeset
|
3 build: |
f37d6adce06e
mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents:
5164
diff
changeset
|
4 copy_directories: |
f37d6adce06e
mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents:
5164
diff
changeset
|
5 - templates |
f37d6adce06e
mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents:
5164
diff
changeset
|
6 dependencies: |
f37d6adce06e
mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents:
5164
diff
changeset
|
7 - mod_http_libjs |
5164 | 8 summary: JSXC demo |
9 --- | |
10 | |
11 Try out JSXC easily by serving it from Prosodys built-in HTTP server. | |
12 | |
5166 | 13 Uses [mod_http_libjs] to serve jQuery, on Debian you can `apt install |
14 libjs-jquery`. | |
15 | |
5164 | 16 # Configuration |
17 | |
18 mod_jsxc can be set up to either use resources from a separate HTTP | |
19 server or serve resources from Prosody's built-in HTTP server. | |
20 | |
21 ## Using CDN | |
22 | |
23 `jsxc_cdn` | |
24 : String. Base URL where JSXC resources are served from. Defaults to | |
25 empty string. | |
26 | |
27 `jsxc_version` | |
28 : String. Concatenated with the CDN URL. Defaults to empty string. | |
29 | |
30 ## Local resources | |
31 | |
32 Download a JSXC release archive and unpack it somewhere on your server. | |
33 | |
34 `jsxc_resources` | |
5167
272a8e54f0c8
mod_jsxc: Correct description of resources setting (thanks ham5urg)
Kim Alvefur <zash@zash.se>
parents:
5166
diff
changeset
|
35 : String. Path to the `dist` directory containing JSXC resources on |
272a8e54f0c8
mod_jsxc: Correct description of resources setting (thanks ham5urg)
Kim Alvefur <zash@zash.se>
parents:
5166
diff
changeset
|
36 the local file system. Disabled by default. |
5164 | 37 |
38 ## Other options | |
39 | |
40 `jquery_url` | |
41 : String. URL or relative path to jQuery. Defaults to | |
42 `"/share/jquery/jquery.min.js"` which will work with | |
43 [mod_http_libjs]. |