Getting started

Share
What the chat does, and how to install it. · Last updated:

Overview

Real Time Chat adds a real-time chat to the forum, split into rooms. Messages appear for every visitor without reloading the page, with reactions, replies, mentions, attachments, an indication of who is typing and the list of online members.

Good to know from the start:
  • There is no "Chat" page on the forum. The chat only appears in a widget that the administrator places wherever they want (home page, sidebar, forum page…). There is no public list of rooms and no "Chat" menu entry.
  • Nothing is allowed by default. The add-on grants no permission when it is installed: until the administrator gives some, nobody sees the chat (see 4.3).
  • On installation, a General room is created and set as the default room.

Installation

  1. Upload the files of the add-on to the server.
  2. In the ACP, install the add-on [Xen-Soluce] Real Time Chat.
  3. The installation creates the tables, generates the secret keys, creates the General room and makes it the default. No permission is granted.
  4. Give the permissions (4.3), place the widget (4.4), choose the transport (4.6).
With the default configuration (the SSE transport), the chat works without installing anything else.

Two scheduled tasks are installed: Real Time Chat: prune old events (purges the event log) and Remove the expired notices of the chat (removes the announcements and bans that have run out). Make sure the XenForo cron is running.
Back
Top Bottom