Mercurial > prosody-modules
changeset 5164:e6d623bd548e
mod_jsxc: Document config options
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 16 Feb 2023 17:06:07 +0100 |
parents | 41fbed2de482 |
children | f37d6adce06e |
files | mod_jsxc/README.markdown |
diffstat | 1 files changed, 34 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_jsxc/README.markdown Thu Feb 16 17:06:07 2023 +0100 @@ -0,0 +1,34 @@ +--- +summary: JSXC demo +--- + +Try out JSXC easily by serving it from Prosodys built-in HTTP server. + +# 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 JSXC resources on the local file system. The target + directory should contain a `dist` directory. 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].