view mod_jsxc/README.markdown @ 5165:f37d6adce06e

mod_jsxc: Add plugin installer metadata Needed since this module has extra resources and dependencies
author Kim Alvefur <zash@zash.se>
date Thu, 16 Feb 2023 17:06:23 +0100
parents e6d623bd548e
children 442a6ced3333
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.

# 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].