mod_jsxc/README.markdown
author Kim Alvefur <zash@zash.se>
Sun, 03 Mar 2024 11:23:40 +0100
changeset 5857 97c9b76867ca
parent 5171 272a8e54f0c8
permissions -rw-r--r--
mod_log_ringbuffer: Detach event handlers on logging reload (thanks Menel) Otherwise the global event handlers accumulate, one added each time logging is reoladed, and each invocation of the signal or event triggers one dump of each created ringbuffer.
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`
5171
272a8e54f0c8 mod_jsxc: Correct description of resources setting (thanks ham5urg)
Kim Alvefur <zash@zash.se>
parents: 5170
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: 5170
diff changeset
    36
the local file system. Disabled by default.
5168
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].