annotate mod_jsxc/README.markdown @ 5164:e6d623bd548e

mod_jsxc: Document config options
author Kim Alvefur <zash@zash.se>
date Thu, 16 Feb 2023 17:06:07 +0100
parents
children f37d6adce06e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5164
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: JSXC demo
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 ---
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 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
6
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 # Configuration
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 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
10 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
11
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 ## Using CDN
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 `jsxc_cdn`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 : 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
16 empty string.
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 `jsxc_version`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 : String. Concatenated with the CDN URL. Defaults to empty string.
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 ## Local resources
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 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
24
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 `jsxc_resources`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 : 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
27 directory should contain a `dist` directory. Disabled by default.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 ## Other options
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 `jquery_url`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 : String. URL or relative path to jQuery. Defaults to
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 `"/share/jquery/jquery.min.js"` which will work with
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 [mod_http_libjs].