mod_jsxc/README.markdown
author Kim Alvefur <zash@zash.se>
Thu, 16 Feb 2023 17:17:05 +0100
changeset 5170 442a6ced3333
parent 5169 f37d6adce06e
child 5171 272a8e54f0c8
permissions -rw-r--r--
mod_jsxc: Words about jQuery
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5168
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
---
5169
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5168
diff changeset
     2
rockspec:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5168
diff changeset
     3
  build:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5168
diff changeset
     4
    copy_directories:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5168
diff changeset
     5
    - templates
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5168
diff changeset
     6
  dependencies:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5168
diff changeset
     7
  - mod_http_libjs
5168
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
summary: JSXC demo
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
---
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
Try out JSXC easily by serving it from Prosodys built-in HTTP server.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
5170
442a6ced3333 mod_jsxc: Words about jQuery
Kim Alvefur <zash@zash.se>
parents: 5169
diff changeset
    13
Uses [mod_http_libjs] to serve jQuery, on Debian you can `apt install
442a6ced3333 mod_jsxc: Words about jQuery
Kim Alvefur <zash@zash.se>
parents: 5169
diff changeset
    14
libjs-jquery`.
442a6ced3333 mod_jsxc: Words about jQuery
Kim Alvefur <zash@zash.se>
parents: 5169
diff changeset
    15
5168
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
# Configuration
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
mod_jsxc can be set up to either use resources from a separate HTTP
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
server or serve resources from Prosody's built-in HTTP server.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
## Using CDN
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
`jsxc_cdn`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
:   String. Base URL where JSXC resources are served from. Defaults to
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
    empty string.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    27
`jsxc_version`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    28
:   String. Concatenated with the CDN URL. Defaults to empty string.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    29
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    30
## Local resources
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    31
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    32
Download a JSXC release archive and unpack it somewhere on your server.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    33
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    34
`jsxc_resources`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    35
:   String. Path to JSXC resources on the local file system. The target
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    36
    directory should contain a `dist` directory. Disabled by default.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    37
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    38
## Other options
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    39
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    40
`jquery_url`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    41
:   String. URL or relative path to jQuery. Defaults to
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    42
    `"/share/jquery/jquery.min.js"` which will work with
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    43
    [mod_http_libjs].