Extension:WebChat

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

Release status:Extension status stable

Mibbit Extension Screenshot.png
ImplementationTemplate:Extension#type Special page
DescriptionTemplate:Extension#description Adds a special page used to chat in real time with other wiki users.
Author(s)Template:Extension#username Robert Leverington, Marco 27 (RobertLtalk)
Latest versionTemplate:Extension#version 1.3.0 (March 23, 2016; 4 months ago (2016-03-23))
MediaWikiTemplate:Extension#mediawiki 1.25 or higher
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ExampleTemplate:Extension#example translatewiki
ParametersTemplate:Extension#parameters
  • $wgWebChatServer
  • $wgWebChatChannel
  • $wgWebChatClient
Added rightsTemplate:Extension#rights

webchat

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

Check usage and version matrix.

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]

  • Download and place the file(s) in a directory called WebChat in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/WebChat/WebChat.php";
  • Configure as necessary
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

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]

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

See also[edit]