Extension:WebChat

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
WebChat

Release status: stable

Mibbit Extension Screenshot.png
Implementation Special page
Description Adds a special page used to chat in real time with other wiki users.
Author(s) Robert Leverington, Marco 27 (RobertLtalk)
Latest version 1.2.0 (April 1, 2014; 3 months ago (2014-04-01))
MediaWiki 1.12 or higher
Database changes No
License GNU General Public License 2.0 or later
Download
Example translatewiki
Parameters
  • $wgWebChatServer
  • $wgWebChatChannel
  • $wgWebChatClient
Added rights

webchat

Translate the WebChat extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

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[edit | edit source]

  • Download and extract the file(s) in a directory called WebChat in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository using:
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/WebChat.git
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/WebChat/WebChat.php";
  • Configure as necessary
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration[edit | edit source]

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 freenodeChat web client.
$wgWebChatServer  = '';
// Channel to connect to.
$wgWebChatChannel = '';
// Which web chat client to use, 'freenodeChat' is required when connecting to freenode,
// but 'Mibbit' can be used for other networks.
$wgWebChatClient = '';
Example for freenode
require_once("$IP/extensions/WebChat/WebChat.php");
$wgWebChatServer  = '';
$wgWebChatChannel = '#freenode';
$wgWebChatClient = 'freenodeChat';

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

Usage[edit | edit source]

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

See also[edit | edit source]