File

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
line wrap: on
line source

---
rockspec:
  build:
    copy_directories:
    - templates
  dependencies:
  - mod_http_libjs
summary: JSXC demo
---

Try out JSXC easily by serving it from Prosodys built-in HTTP server.

Uses [mod_http_libjs] to serve jQuery, on Debian you can `apt install
libjs-jquery`.

# Configuration

mod_jsxc can be set up to either use resources from a separate HTTP
server or serve resources from Prosody's built-in HTTP server.

## Using CDN

`jsxc_cdn`
:   String. Base URL where JSXC resources are served from. Defaults to
    empty string.

`jsxc_version`
:   String. Concatenated with the CDN URL. Defaults to empty string.

## Local resources

Download a JSXC release archive and unpack it somewhere on your server.

`jsxc_resources`
:   String. Path to the `dist` directory containing JSXC resources on
the local file system. Disabled by default.

## Other options

`jquery_url`
:   String. URL or relative path to jQuery. Defaults to
    `"/share/jquery/jquery.min.js"` which will work with
    [mod_http_libjs].