Extension:WebChat

MediaWiki extensions manual - list

WebChat Release status: stable
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.1.0 (2012-08-02)
MediaWiki	1.12 or higher
Database changes	no
License	GNU General Public License 2.0 or later
Download	Download snapshot (Git master) Git [?]: repo summary tree code changes
Example	Strategywiki translatewiki
Parameters $wgWebChatServer $wgWebChatChannel $wgWebChatClient
Added rights webchat
Translate the WebChat extension if possible
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.

Download

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

• Go to the tags list
• Click the name of the tag you want to download
• Click "snapshot"

The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

• Go to the branches list
• Click the branch name
• Click "snapshot"

A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

• Download snapshot

After you've got the code, save it into the extensions/WebChat directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/WebChat.git

Installation

1. Download the extension files and install them as advised.
2. Edit LocalSettings.php and add the following line:

   require_once("$IP/extensions/WebChat/WebChat.php");
   

3. Configure the extension as described below.
4. Go to Special:WebChat to chat.

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 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

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

See also

• Extension:Chat