# 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 7.4 or newer
- XenForo 2.2.0 or newer
To run websockets server in a docker container:
To run websockets server on the server directly:
- Python 3.x
- GIT
- The
gcccompiler and the dependencies for build - NPM
- Node.js LTS (14.x, 16.x, 18.x, so on)
# Installation
- Install the add-on by first uploading the files to the server or using the "Install from archive" function in the control panel.
- Set up a websocket server.
- Grant "Use WebSockets" permission to groups that can connect to the websocket server.
# Installation Service
If you do not want to bother with setting up a websocket server, but would like everything to work on your side without using third-party services, I can offer you a service for setting up a websocket server (opens new window). The cost of the service is $40.
# Technical Details
The add-on is based on the Pusher library.
It uses the Pusher SDK (opens new window) to send messages from the server, and the laravel-echo (opens new window) library to receive messages on the client side.
# Copyright
A copyright will be added to the footer of your site with a link to the developer's site.
Its removal is paid, its cost is $100. You can pay for the removal of the link here (opens new window).
After payment, just disable the Show copyright option in the add-on settings.