prosody-modules: mod_conversejs/README.markdown@d2d0715f30d9 (annotated)

2882 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
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 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	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 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	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 ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	49
ed5ad4fd5bdd mod_conversejs: Add a readme Kim Alvefur <zash@zash.se> parents: diff changeset	50
2922 d2d0715f30d9 mod_conversejs/README: Expand config section Kim Alvefur <zash@zash.se> parents: 2882 diff changeset	51

author	Kim Alvefur <zash@zash.se>
	Sat, 10 Mar 2018 00:04:47 +0100
changeset 2922	d2d0715f30d9
parent 2882	ed5ad4fd5bdd
child 2923	0ea93da47db9
permissions	-rw-r--r--