prosody-modules: mod_conversejs/README.markdown annotate

annotate mod_conversejs/README.markdown @ 3330:426447d8f82e

Mention auto_register_muc_nickname setting from Converse

author	JC Brand <jc@opkode.com>
date	Mon, 24 Sep 2018 14:41:37 +0000
parents	5b3347056f07
children	04e5e34893e1

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
3311 5b3347056f07 mod_conversejs/README: Fix links to mod_bosh and mod_websocket (thanks jubalh) Kim Alvefur <zash@zash.se> parents: 3304 diff changeset	39 It also determines the [BOSH][doc:modules:mod_bosh] and
5b3347056f07 mod_conversejs/README: Fix links to mod_bosh and mod_websocket (thanks jubalh) Kim Alvefur <zash@zash.se> parents: 3304 diff changeset	40 [WebSocket][doc:modules:mod_websocket] URL automatically, see their
5b3347056f07 mod_conversejs/README: Fix links to mod_bosh and mod_websocket (thanks jubalh) Kim Alvefur <zash@zash.se> parents: 3304 diff changeset	41 respective documentation for how to configure them. Both connection
5b3347056f07 mod_conversejs/README: Fix links to mod_bosh and mod_websocket (thanks jubalh) Kim Alvefur <zash@zash.se> parents: 3304 diff changeset	42 methods are loaded automatically.
2918 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
3304 27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	47 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	48 `/conversejs`. More details on configuring HTTP modules in Prosody can
27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	49 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	50
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	51 Other
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	52 -----
2878 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	53
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	54 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	55 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	56 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	57 this:
2918 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2878 diff changeset	58
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	59 ``` {.lua}
3304 27db90321e7b Fix README of mod_conversejs t2d <td@tem.li> parents: 2920 diff changeset	60 conversejs_options = {
2919 0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	61 debug = true;
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	62 view_mode = "fullscreen";
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
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	66 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	67 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	68
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	69 - `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	70 - `jid` the current `VirtualHost`
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	71 - `bosh_service_url`
0ea93da47db9 mod_conversejs: Allow passing arbitrary options trough to Converse.js Kim Alvefur <zash@zash.se> parents: 2918 diff changeset	72 - `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	73
2920 4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	74 Compatibility
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
4d03ac2737ab mod_conversejs/README: Add compatibility section Kim Alvefur <zash@zash.se> parents: 2919 diff changeset	77 Should work with Prosody 0.9 and later. Websocket support requires 0.10.

Mercurial > prosody-modules

annotate mod_conversejs/README.markdown @ 3330:426447d8f82e