prosody-modules: mod_conversejs/README.markdown annotate

annotate mod_conversejs/README.markdown @ 4579:b305814bd930

mod_muc_dicebot: A thing to roll dice Do you see what happens, Jitsi? Do you see what happens when you make it hard for me to use a proper bot? This is what happens, Jitsi. This is what happens when you meet a stranger in the alps! Ahem. In all seriousness, this is more of a quick hack than anything else. It will look for `.r` in MUC messages and if it finds it, it'll interpret it as an instruction to roll a few dice. Injects the results in the body of the message. Eats the message alive if it is malformed.

author	Jonas Schäfer <jonas@wielicki.name>
date	Sat, 29 May 2021 15:17:05 +0200
parents	b74d6a3f0c3f
children	d6eb2b722b90

rev	line source
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	1 ---
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	2 depends:
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	3 - 'mod\_bosh'
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	4 - 'mod\_websocket'
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	5 provides:
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	6 - http
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	7 title: 'mod\_conversejs'
4166 7678b4880719 mod_conversejs: Hint that templates should be copied into packages Kim Alvefur <zash@zash.se> parents: 4147 diff changeset	8 rockspec:
7678b4880719 mod_conversejs: Hint that templates should be copied into packages Kim Alvefur <zash@zash.se> parents: 4147 diff changeset	9 build:
7678b4880719 mod_conversejs: Hint that templates should be copied into packages Kim Alvefur <zash@zash.se> parents: 4147 diff changeset	10 copy_directories:
7678b4880719 mod_conversejs: Hint that templates should be copied into packages Kim Alvefur <zash@zash.se> parents: 4147 diff changeset	11 - templates
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	12 ---
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	13
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	14 Introduction
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	15 ============
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	16
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	17 This module serves a small snippet of HTML that loads
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	18 [Converse.js](https://conversejs.org/), configured to work with the
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	19 VirtualHost that it is loaded onto.
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	20
3958 cacd753848b2 mod_conversejs/README: Add an example of the URL to open Kim Alvefur <zash@zash.se> parents: 3711 diff changeset	21 It becomes available on an URL like `https://example.com:5281/conversejs`
cacd753848b2 mod_conversejs/README: Add an example of the URL to open Kim Alvefur <zash@zash.se> parents: 3711 diff changeset	22
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	23 Configuration
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	24 =============
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	25
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	26 The module uses general Prosody options for basic configuration. It
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	27 should just work after loading it.
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	28
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	29 ``` {.lua}
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	30 modules_enabled = {
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	31 -- other modules...
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	32 "conversejs";
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	33 }
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	34 ```
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	35
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	36 Authentication
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	37 --------------
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	38
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	39 [Authentication settings][doc:authentication] are used determine
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	40 whether to configure Converse.js to use `login` or `anonymous` mode.
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	41
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	42 Connection methods
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	43 ------------------
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	44
4206 432e948cd50e mod_conversejs: Tweak wording Kim Alvefur <zash@zash.se> parents: 4166 diff changeset	45 mod_conversejs also determines the [BOSH][doc:setting_up_bosh] and
3362 af085e8b9d48 mod_conversejs: Link to BOSH and WebSockets setup instructions instead of module pages Kim Alvefur <zash@zash.se> parents: 3334 diff changeset	46 [WebSocket][doc:websocket] URL automatically, see their respective
af085e8b9d48 mod_conversejs: Link to BOSH and WebSockets setup instructions instead of module pages Kim Alvefur <zash@zash.se> parents: 3334 diff changeset	47 documentation for how to configure them. Both connection methods are
af085e8b9d48 mod_conversejs: Link to BOSH and WebSockets setup instructions instead of module pages Kim Alvefur <zash@zash.se> parents: 3334 diff changeset	48 loaded automatically.
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	49
4207 e8fbc0773141 mod_conversejs/README: Add text about preventing auto-load of mod_bosh/ws Kim Alvefur <zash@zash.se> parents: 4206 diff changeset	50 Auto-loading of `mod_bosh` or `mod_websocket` can be prevented by adding
e8fbc0773141 mod_conversejs/README: Add text about preventing auto-load of mod_bosh/ws Kim Alvefur <zash@zash.se> parents: 4206 diff changeset	51 it to `modules_disabled` but note that at least one of them must be
e8fbc0773141 mod_conversejs/README: Add text about preventing auto-load of mod_bosh/ws Kim Alvefur <zash@zash.se> parents: 4206 diff changeset	52 allowed for Converse.js to work.
e8fbc0773141 mod_conversejs/README: Add text about preventing auto-load of mod_bosh/ws Kim Alvefur <zash@zash.se> parents: 4206 diff changeset	53
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	54 HTTP
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	55 ----
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	56
3304 27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	57 The module is served on Prosody's default HTTP ports at the path
27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	58 `/conversejs`. More details on configuring HTTP modules in Prosody can
27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	59 be found in our [HTTP documentation](http://prosody.im/doc/http).
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	60
3598 1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	61 ## Templates
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	62
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	63 The HTML and JS can be customized either by editing the included
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	64 `template.html` and `template.js` files or configuring your own like:
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	65
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	66 ```lua
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	67 conversejs_html_template = "/path/to/my-template.html"
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	68 conversejs_js_template = "/path/to/my-template.js"
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	69 ```
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	70
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	71 The HTML template uses Prosodys
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	72 [`util.interpolation`][doc:developers:util:interpolation] template
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	73 library while the JS template has `%s` where generated settings are
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	74 injected.
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	75
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	76 Other
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	77 -----
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	78
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	79 To pass [other Converse.js
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	80 options](https://conversejs.org/docs/html/configuration.html), or
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	81 override the derived settings, one can set `conversejs_options` like
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	82 this:
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	83
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	84 ``` {.lua}
3304 27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	85 conversejs_options = {
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	86 debug = true;
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	87 view_mode = "fullscreen";
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	88 }
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	89 ```
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	90
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	91 Note that the following options are automatically provided, and
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	92 overriding them may cause problems:
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	93
3334 04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	94 - `authentication` based on Prosody's authentication settings
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	95 - `bosh_service_url`
3495 5567098a7f91 mod_conversejs/README: Update text about mod_bosh and mod_websocket Kim Alvefur <zash@zash.se> parents: 3362 diff changeset	96 - `websocket_url`
4208 b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	97 - `discover_connection_methods` Disabled since we provide this
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	98 - `assets_path`
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	99 - `allow_registration` based on whether registration is enabled
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	100 - These settings are set to the current `VirtualHost`:
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	101 - `jid`
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	102 - `default_domain`
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	103 - `domain_placeholder`
b74d6a3f0c3f mod_conversejs/README: Complete list of auto-injected settings Kim Alvefur <zash@zash.se> parents: 4207 diff changeset	104 - `registration_domain`
3495 5567098a7f91 mod_conversejs/README: Update text about mod_bosh and mod_websocket Kim Alvefur <zash@zash.se> parents: 3362 diff changeset	105
5567098a7f91 mod_conversejs/README: Update text about mod_bosh and mod_websocket Kim Alvefur <zash@zash.se> parents: 3362 diff changeset	106 `mod_bosh` and/or `mod_websocket` are automatically enabled if available
5567098a7f91 mod_conversejs/README: Update text about mod_bosh and mod_websocket Kim Alvefur <zash@zash.se> parents: 3362 diff changeset	107 and the respective endpoint is included in the generated options.
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	108
4147 3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	109 ## Loading resources
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	110
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	111 By default the module will load the main script and CSS from
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	112 cdn.conversejs.org. For privacy or performance reasons you may want to
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	113 load the scripts from somewhere else.
3334 04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	114
4147 3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	115 To use a local distribution or build of Converse.js set
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	116 conversejs_resources to the local path of "dist" directory:
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	117
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	118 ``` {.lua}
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	119 conversejs_resources = "/usr/src/conversejs/dist";
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	120 ```
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	121
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	122 To use a different web server or CDN simply use the conversejs_cdn
3a06dea21ea1 mod_conversejs: Enable serving resources from built-in http server Kim Alvefur <zash@zash.se> parents: 3958 diff changeset	123 option:
3334 04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	124
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	125 ``` {.lua}
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	126 conversejs_cdn = "https://cdn.example.com"
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	127 ```
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	128
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	129 To select a specific version of Converse.js, you may override the version:
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	130
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	131 ``` {.lua}
3643 740870196b97 mod_http_stats_stream: Make global to simplify Kim Alvefur <zash@zash.se> parents: 3598 diff changeset	132 conversejs_version = "5.0.0"
3334 04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	133 ```
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	134
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	135 Note that versions other than the default may not have been tested with this module, and may include incompatible changes.
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	136
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	137 Finally, if you can override all of the above and just specify links directly to the CSS and JS files:
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	138
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	139 ``` {.lua}
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	140 conversejs_script = "https://example.com/my-converse.js"
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	141 conversejs_css = "https://example.com/my-converse.css"
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	142 ```
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	143
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	144 Additional tags
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	145 ---------------
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	146
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	147 To add additional tags to the module, such as custom CSS or scripts, you may use the conversejs_tags option:
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	148
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	149 ``` {.lua}
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	150 conversejs_tags = {
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	151 -- Load custom CSS
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	152 [[<link rel="stylesheet" href="https://example.org/css/custom.css">]];
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	153
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	154 -- Load libsignal-protocol.js for OMEMO support (GPLv3; be aware of licence implications)
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	155 [[<script src="https://cdn.conversejs.org/3rdparty/libsignal-protocol.min.js"></script>]];
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	156 }
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	157 ```
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	158
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	159 The example above uses the `[[` and `]]` syntax simply because it will not conflict with any embedded quotes.
04e5e34893e1 mod_conversejs: Update README Matthew Wild <mwild1@gmail.com> parents: 3311 diff changeset	160
2920 4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	161 Compatibility
4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	162 =============
4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	163
3598 1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	164 Prosody version state
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	165 ----------------- ---------------
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	166 0.9 Does not work
1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	167 0.10 Should work
3711 309fa523c424 mod_conversejs: Update compatibility section, pretty sure it works with 0.11 Kim Alvefur <zash@zash.se> parents: 3643 diff changeset	168 0.11 Works
3598 1921ae4449b8 mod_conversejs: Separate out templates into separate configurable files (breaks 0.9 compat) Kim Alvefur <zash@zash.se> parents: 3495 diff changeset	169 trunk Works

Mercurial > prosody-modules

annotate mod_conversejs/README.markdown @ 4579:b305814bd930