Extension:WebChat

From MediaWiki.org

Jump to: navigation, search

             

Manual on MediaWiki Extensions
List of MediaWiki Extensions
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)
Last Version  1.0.0
MediaWiki  1.12 or higher
License GNU General Public License 2.0 or later
Download Download snapshot

Subversion [Help]
Browse source code

check usage (experimental)

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.

The client can be configured to work with a variety of different servers, simply by selecting the server name and a channel on the server. Additionally if no value is given for the server, the client will assume the freenode servers.

For example, the following, placed within LocalSettings.php will set up the client to work with the freenode irc server on channel #freenode.

require_once( "extensions/WebChat/WebChat.php" );
$wgWebChatServer  = '';
$wgWebChatChannel = '#freenode';
$wgWebChatClient = 'freenodeChat';

[edit] Installation

  1. Download the extension files and install them as advised.
  2. Add require_once( "extensions/WebChat/WebChat.php" ); to LocalSettings.php.
  3. Enjoy!

[edit] 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 = '';

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

[edit] Usage

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