prosody-modules
d194d1012fd3
mod_jsxc/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_jsxc/README.markdown @ 5931:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parent 5167:272a8e54f0c8
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
5166
442a6ced3333 mod_jsxc: Words about jQuery
Kim Alvefur <zash@zash.se>
parents: 5165
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: 5165
diff changeset
14 libjs-jquery`.
442a6ced3333 mod_jsxc: Words about jQuery
Kim Alvefur <zash@zash.se>
parents: 5165
diff changeset
15
5164
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`
5167
272a8e54f0c8 mod_jsxc: Correct description of resources setting (thanks ham5urg)
Kim Alvefur <zash@zash.se>
parents: 5166
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: 5166
diff changeset
36 the local file system. Disabled by default.
5164
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].