MediaWiki extensions manual

WebChat Release status: stableCategory:Stable extensions
Implementation	Special page Category:Special page extensions
Description	Adds a special page used to chat in real time with other wiki users.
Author(s)	Robert Leverington Marco 27 (RobertLtalk)
Latest version	2021-06-15 (Continuous updates)
MediaWiki	1.34+Category:Extensions with manual MediaWiki version
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control
Example	translatewiki
Parameters $wgWebChatServer $wgWebChatChannel $wgWebChatClient
Added rights webchat Category:Extensions which add rights
Quarterly downloads	9 (Ranked 107th)
Translate the WebChat extension if it is available at translatewiki.net

The WebChat extension adds a special page used to chat in real time with other wiki users using a web-based IRC client. Once installed, it will be available via "Special:WebChat".

Installation

• Download and move the extracted WebChat folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WebChat
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'WebChat' );
  

• Configure as necessary
• Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

There are several variables to be set in LocalSettings.php , to be added after the line of code containing require_once(...) described above.

// IRC Server to connect to, not required when using the Libera.Chat web client.
$wgWebChatServer  = '';
// Channel to connect to.
$wgWebChatChannel = '';
// Which web chat client to use, 'liberaChat' is required when connecting to Libera.Chat,
// but 'Mibbit' can be used for other networks.
$wgWebChatClient = '';

Example for LiberaChat

wfLoadExtension( 'WebChat' );
$wgWebChatChannel = '#libera';
$wgWebChatClient = 'LiberaChat';

The "webchat" permission can be used to specify what user groups can access it, by default only logged in users have access.

Usage

Go to "Special:WebChat", type a username if one is not already chosen, then press the connect button.

See also

• Extension:MediaWikiChat

This extension is included in the following wiki farms/hosts and/or packages: Miraheze Category:Extensions included in Miraheze WikiForgeCategory:Extensions included in WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.