diff mod_conversejs/README.markdown @ 2919:0ea93da47db9

mod_conversejs: Allow passing arbitrary options trough to Converse.js
author Kim Alvefur <zash@zash.se>
date Sat, 10 Mar 2018 00:05:30 +0100
parents d2d0715f30d9
children 4d03ac2737ab
line wrap: on
line diff
--- a/mod_conversejs/README.markdown	Sat Mar 10 00:04:47 2018 +0100
+++ b/mod_conversejs/README.markdown	Sat Mar 10 00:05:30 2018 +0100
@@ -47,5 +47,26 @@
 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*
+