Mercurial > prosody-modules
changeset 2878:ed5ad4fd5bdd
mod_conversejs: Add a readme
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 16 Feb 2018 03:52:51 +0100 (2018-02-16) |
parents | d6badf56ab5f |
children | 9d633d8f3451 |
files | mod_conversejs/README.markdown |
diffstat | 1 files changed, 30 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_conversejs/README.markdown Fri Feb 16 03:52:51 2018 +0100 @@ -0,0 +1,30 @@ +--- +depends: +- 'mod\_bosh' +- 'mod\_websocket' +provides: +- http +title: 'mod\_conversejs' +--- + +Introduction +============ + +This module serves a small snippet of HTML that loads +[Converse.js](https://conversejs.org/), configured to work with the +VirtualHost that it is loaded onto. + +Configuration +============= + +The module itself has no configuration. It uses +[authentication settings][doc:authentication] to determine whether to +configure Converse.js to use `login` or `anonymous` mode. + +It also determines the [BOSH][mod_bosh] and [WebSocket][mod_websocket] +URL automatically, see their respective documentation for how to configure +them. + +See Prosodys [HTTP configuration][doc:http] for HTTP related options. + +