Mercurial > prosody-modules

annotate mod_jsxc/README.markdown @ 5165:f37d6adce06e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
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 ---
5165
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5164
diff changeset
2 rockspec:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5164
diff changeset
3 build:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5164
diff changeset
4 copy_directories:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5164
diff changeset
5 - templates
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5164
diff changeset
6 dependencies:
f37d6adce06e mod_jsxc: Add plugin installer metadata
Kim Alvefur <zash@zash.se>
parents: 5164
diff changeset
7 - mod_http_libjs
5164
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
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 # Configuration
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 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
16 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
17
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 ## Using CDN
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 `jsxc_cdn`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 : 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
22 empty string.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 `jsxc_version`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 : String. Concatenated with the CDN URL. Defaults to 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 ## Local resources
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 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
30
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 `jsxc_resources`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 : 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
33 directory should contain a `dist` directory. Disabled by default.
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 ## Other options
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 `jquery_url`
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 : String. URL or relative path to jQuery. Defaults to
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 `"/share/jquery/jquery.min.js"` which will work with
e6d623bd548e mod_jsxc: Document config options
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 [mod_http_libjs].