view mod_conversejs/README.markdown @ 2953:0092bcceda0a

mod_component_http: Update README to include config snippet example
author Matthew Wild <mwild1@gmail.com>
date Mon, 26 Mar 2018 14:01:00 +0100
parents 4d03ac2737ab
children 27db90321e7b
line wrap: on
line source

---
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 uses general Prosody options for basic configuration. It
should just work after loading it.

``` {.lua}
modules_enabled = {
    -- other modules...
    "conversejs";
}
```

Authentication
--------------

[Authentication settings][doc:authentication] are used determine
whether to configure Converse.js to use `login` or `anonymous` mode.

Connection methods
------------------

It also determines the [BOSH][mod_bosh] and
[WebSocket][mod_websocket] URL automatically, see their respective
documentation for how to configure them. Both connection methods are
loaded automatically.

HTTP
----

See Prosodys [HTTP configuration][doc:http] for HTTP related
options.

Other
-----

To pass [other Converse.js
options](https://conversejs.org/docs/html/configuration.html), or
override the derived settings, one can set `conversejs_options` like
this:

``` {.lua}
converse_options = {
    debug = true;
    view_mode = "fullscreen";
}
```

Note that the following options are automatically provided, and
**overriding them may cause problems**:

-   `authentication` *based on Prosodys authentication settings*
-   `jid` *the current `VirtualHost`*
-   `bosh_service_url`
-   `websocket_url` *if `mod_websocket` is available*

Compatibility
=============

Should work with Prosody 0.9 and later. Websocket support requires 0.10.