Software /
code /
prosody-modules
File
mod_conversejs/README.markdown @ 3092:0f63e999d0e4
mod_slack_webhooks: Remove unused locals [luacheck]
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 02 Jun 2018 14:58:28 +0200 (2018-06-02) |
parent | 2920:4d03ac2737ab |
child | 3304: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.