mod_conversejs

Introduction

This module serves a small snippet of HTML that loads Converse.js, 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.

Authentication

Authentication settings are used determine whether to configure Converse.js to use login or anonymous mode.

Connection methods

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

HTTP

The module is served on Prosody’s default HTTP ports at the path /conversejs. More details on configuring HTTP modules in Prosody can be found in our HTTP documentation.

Other

To pass other Converse.js options, or override the derived settings, one can set conversejs_options like this:

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

Loading resources

By default the module will load the main script and CSS from cdn.conversejs.org. For privacy or performance reasons you may want to load the scripts from somewhere else, simply use the conversejs_cdn option:

To select a specific version of Converse.js, you may override the version:

Note that versions other than the default may not have been tested with this module, and may include incompatible changes.

Finally, if you can override all of the above and just specify links directly to the CSS and JS files:

Additional tags

To add additional tags to the module, such as custom CSS or scripts, you may use the conversejs_tags option:

The example above uses the [[ and ]] syntax simply because it will not conflict with any embedded quotes.

Compatibility

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