Introduction to XenForo WebSockets

WebSockets is a protocol designed to exchange information in real time. With it, we can notify users about any events on the forum: alerts, messages, reactions, and so on.

This add-on allows developers to conveniently use this protocol in XenForo.
This means that by configuring this add-on once, other add-ons will be able to use its capabilities without the need for a separate websockets configuration.

Requirements

• PHP 8.1 or newer
• XenForo 2.2.0 or newer

To run websockets server in a docker container:

• Docker

To run native websockets server:

• Python 3.x
• GIT
• The gcc compiler and the dependencies for build
• NPM
• Node.js LTS (14.x, 16.x, 18.x, so on)

Setup

1. Install the add-on by first uploading the files to the server or using the "Install from archive" function in the control panel.
2. Set up a websocket server.
3. Grant "Use WebSockets" permission to groups that can connect to the websocket server.

Setup Service

Setting up a websocket server requires technical knowledge and a certain amount of effort for regular users, so we offer a service for installing and configuring XenForo WebSockets.
Service cost: $40.

How does this work?

The add-on is based on the Pusher protocol.
It uses the Pusher SDK to send messages from the server, and the laravel-echo library to receive messages on the client side.

Copyright

A copyright notice with a link to the developer's site will appear in your site's footer by default. To remove this link, a $100 fee applies. You can purchase the copyright removal here. Once payment is complete, simply disable the Show copyright option in the add-on options.