mod_bosh
- Details
- Usage
- Configuration
- Example

mod_bosh

BOSH allows clients to use HTTP to communicate with XMPP servers. Often used to allow browser based webclients to connect to an XMPP server, BOSH is also useful in situations where a user is behind a firewall or NAT is preventing connections to the required server ports.

Details

mod_bosh implements XEP-0124 and XEP-0206. For more advanced configuration options see setting up bosh.

Usage

    modules_enabled = {
        -- Other modules
        "bosh"; -- Enable mod_bosh
    }

Configuration

Option	Default	Notes
bosh_ports	{ 5280 }	List of ports to listen for BOSH requests on
bosh_max_inactivity	60	Maximum amount of time in seconds a client may remain silent for, with no requests
bosh_max_pause	300	Longest session pause a client may request, in seconds
consider_bosh_secure	false	If true then BOSH connections will be allowed when requiring encryption, even if unencrypted
cross_domain_bosh	false	Set to true to enable cross-domain requests from websites, or a list like { “http://jabber.org”, “http://prosody.im” }
These advanced options are best left at their defaults unless you know what you are doing
bosh_default_hold	1	Maximum number of requests the server will hold open for a client
bosh_max_requests	2	Maximum number of requests a client may make to the server at a time

Example

    modules_enabled = {
        -- Other modules
        "bosh"; -- Enable mod_bosh
    }
 
    bosh_default_hold = 1
    bosh_max_inactivity = 60
    bosh_max_requests = 2
    bosh_max_pause = 300
    bosh_ports = { 5280 }