| author | Kim Alvefur <zash@zash.se> |
| Sat, 10 Mar 2018 00:05:30 +0100 | |
| changeset 2923 | 0ea93da47db9 |
| parent 2922 | d2d0715f30d9 |
| child 2924 | 4d03ac2737ab |
| permissions | -rw-r--r-- |
| 2882 | 1 |
--- |
2 |
depends: |
|
3 |
- 'mod\_bosh' |
|
4 |
- 'mod\_websocket' |
|
5 |
provides: |
|
6 |
- http |
|
7 |
title: 'mod\_conversejs' |
|
8 |
--- |
|
9 |
||
10 |
Introduction |
|
11 |
============ |
|
12 |
||
13 |
This module serves a small snippet of HTML that loads |
|
14 |
[Converse.js](https://conversejs.org/), configured to work with the |
|
15 |
VirtualHost that it is loaded onto. |
|
16 |
||
17 |
Configuration |
|
18 |
============= |
|
19 |
||
|
2922
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
20 |
The module uses general Prosody options for basic configuration. It |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
21 |
should just work after loading it. |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
22 |
|
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
23 |
``` {.lua} |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
24 |
modules_enabled = { |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
25 |
-- other modules... |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
26 |
"conversejs"; |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
27 |
} |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
28 |
``` |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
29 |
|
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
30 |
Authentication |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
31 |
-------------- |
| 2882 | 32 |
|
|
2922
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
33 |
[Authentication settings][doc:authentication] are used determine |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
34 |
whether to configure Converse.js to use `login` or `anonymous` mode. |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
35 |
|
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
36 |
Connection methods |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
37 |
------------------ |
| 2882 | 38 |
|
|
2922
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
39 |
It also determines the [BOSH][mod_bosh] and |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
40 |
[WebSocket][mod_websocket] URL automatically, see their respective |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
41 |
documentation for how to configure them. Both connection methods are |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
42 |
loaded automatically. |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
43 |
|
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
44 |
HTTP |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
45 |
---- |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
46 |
|
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
47 |
See Prosodys [HTTP configuration][doc:http] for HTTP related |
|
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
48 |
options. |
| 2882 | 49 |
|
|
2923
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
50 |
Other |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
51 |
----- |
| 2882 | 52 |
|
|
2923
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
53 |
To pass [other Converse.js |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
54 |
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:
2922
diff
changeset
|
55 |
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:
2922
diff
changeset
|
56 |
this: |
|
2922
d2d0715f30d9
mod_conversejs/README: Expand config section
Kim Alvefur <zash@zash.se>
parents:
2882
diff
changeset
|
57 |
|
|
2923
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
58 |
``` {.lua} |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
59 |
converse_options = { |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
60 |
debug = true; |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
61 |
view_mode = "fullscreen"; |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
62 |
} |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
63 |
``` |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
64 |
|
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
65 |
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:
2922
diff
changeset
|
66 |
**overriding them may cause problems**: |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
67 |
|
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
68 |
- `authentication` *based on Prosodys authentication settings* |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
69 |
- `jid` *the current `VirtualHost`* |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
70 |
- `bosh_service_url` |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
71 |
- `websocket_url` *if `mod_websocket` is available* |
|
0ea93da47db9
mod_conversejs: Allow passing arbitrary options trough to Converse.js
Kim Alvefur <zash@zash.se>
parents:
2922
diff
changeset
|
72 |