Mercurial > prosody-modules

comparison mod_conversejs/README.markdown @ 2878:ed5ad4fd5bdd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_conversejs: Add a readme
author Kim Alvefur <zash@zash.se>
date Fri, 16 Feb 2018 03:52:51 +0100
parents
children d2d0715f30d9
comparison
equal deleted inserted replaced
2877:d6badf56ab5f 2878:ed5ad4fd5bdd
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
20 The module itself has no configuration. It uses
21 [authentication settings][doc:authentication] to determine whether to
22 configure Converse.js to use `login` or `anonymous` mode.
23
24 It also determines the [BOSH][mod_bosh] and [WebSocket][mod_websocket]
25 URL automatically, see their respective documentation for how to configure
26 them.
27
28 See Prosodys [HTTP configuration][doc:http] for HTTP related options.
29
30