Software `/` code `/` prosody-modules

Annotate

mod_conversejs/README.markdown @ 3243:ca856a892719

mod_pubsub_text_interface: A chat interface to PubSub This module lets you manage subscriptions to pubsub nodes via simple chat messages. Subscriptions are always added based on bare JID. The include_body flag is enabled so that a plain text body version of events can be included, where supported.

author	Kim Alvefur <zash@zash.se>
date	Mon, 20 Aug 2018 17:09:20 +0200
parent	2920:4d03ac2737ab
child	3304:27db90321e7b

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'
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	8 ---
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	9
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	10 Introduction
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	11 ============
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 This module serves a small snippet of HTML that loads
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	14 [Converse.js](https://conversejs.org/), configured to work with the
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	15 VirtualHost that it is loaded onto.
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 Configuration
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	18 =============
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	19
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 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: 2878 diff changeset	21 should just work after loading it.
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	22
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	23 ``` {.lua}
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	24 modules_enabled = {
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	25 -- other modules...
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	26 "conversejs";
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	27 }
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
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	30 Authentication
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	31 --------------
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	32
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	33 [Authentication settings][doc:authentication] are used determine
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 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: 2878 diff changeset	35
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	36 Connection methods
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 It also determines the [BOSH][mod_bosh] and
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	40 [WebSocket][mod_websocket] URL automatically, see their respective
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 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: 2878 diff changeset	42 loaded automatically.
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	43
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	44 HTTP
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	45 ----
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	46
d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 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: 2878 diff changeset	48 options.
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	49
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	50 Other
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	51 -----
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	52
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 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: 2918 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: 2918 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: 2918 diff changeset	56 this:
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	57
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	58 ``` {.lua}
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	59 converse_options = {
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	60 debug = true;
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	61 view_mode = "fullscreen";
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	62 }
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	63 ```
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	64
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 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: 2918 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: 2918 diff changeset	67
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 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: 2918 diff changeset	69 - `jid` the current `VirtualHost`
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	70 - `bosh_service_url`
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 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: 2918 diff changeset	72
2920 4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	73 Compatibility
4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	74 =============
4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	75
4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	76 Should work with Prosody 0.9 and later. Websocket support requires 0.10.

prosody-modules

ca856a892719

mod_conversejs/README.markdown

Software / code / prosody-modules

Annotate

mod_conversejs/README.markdown @ 3243:ca856a892719

Software `/` code `/` prosody-modules