Openfire WebSocket Plugin Readme


This plugin extends Openfire to support WebSocket. The implementation follows the XMPP WebSocket subprotocol (RFC 7395) specification, which is a standard extension of the WebSocket protocol specification (RFC 6455).

Note that the BOSH (http-bind) capabilities of Openfire must be enabled and correctly configured as a prerequisite before installing this plugin. The WebSocket servlet is installed within the same context as the BOSH component, and will reuse the same HTTP/S port(s) when establishing the WebSocket connection.


Copy websocket.jar into the plugins directory of your Openfire installation. The plugin will then be automatically deployed. To upgrade to a new version, copy the new websocket.jar file over the existing file.

Upon installation, the WebSocket URI path will be /ws/ on the same server/port as the BOSH connector. To establish a secure WebSocket, modify the following URL as appropriate: