Extension:WhiteList/Installation

Install Extension:Usage Statistics
By default, the WhiteList extension will try to use pretty calendar entry shown in the screenshot above. To enable the calendar widget in the Whitelist Access Editor, install Extension:Usage Statistics. Note: In the installation instructions for usage statistics, installing gnuplot is recommended, but not required. Since UsageStatistics is only needed for one function within Whitelist, you don't actually have to install the gnuplot extension if you don't want to. Moreover, the requirement for the Usage Statistics extension is optional and can be disabled via the $wgWhitelistUsePrettyCalendar variable (see below).

Update Common.css/.js
In your MediaWiki installation, verify that pages MediaWiki:Common.css and MediaWiki:Common.js contain the appropriate sections found on Manual:NavFrame. If those sections do not exist, copy the sections from Manual:NavFrame to your MediaWiki installation's MediaWiki:Common.css and MediaWiki:Common.js. (You can type MediaWiki:Common.css and MediaWiki:Common.js in your MediaWiki installation's search bar to open and edit the pages. Please take a look at the talk page if you have trouble with this).

If you edit these files, you will probably have to clear the cache on your browser, restart the browser, and possibly truncate the MySQL table storing the cached versions of the pages. Take a look at MediaWiki documentation on caching problems for more information.

Install Extension:Whitelist
Download all extension files from SVN and place them in the extensions/WhiteListEdit/ directory.

Create the MySQL table
To create a MySQL table, you need to have console access to your server. First, open up your console. Type: use nameofyourdatabase

The database will now be selected. Paste the following text into the console and press enter. Make sure to use the appropriate $wgPrefix. In this example, we used wiki_ as the $wgPrefix. ''Note: Newer versions of mediawiki use $wgDBprefix instead of $wgPrefix. If you are unsure, take a look at your LocalSettings.php.'' The MySQL code for this table is also defined in the WhiteListEdit.sql file in this extension.

Setup the system messages
Go to your Special:Allmessages page and set an appropriate message for
 * badaccess-group1
 * badaccess-group2
 * badaccess-groups

These are the messages displayed by MediaWiki when Extension:WhiteList denies page access to a restricted user.

Enable the extension
Add the following text to your LocalSettings.php If you receive an error message, that the class "SpecialPage" cannot be found, you should place a before this line.

Configure Users
Before the extension can be used, a sysop has to add the desired users to the manager group. Note, by default, a sysop will not have the necessary permissions to see the manager's Special:WhiteListEdit page. So, it might be a good idea to add your sysops to the manager group also.

Next, assign whomever you want to restrict to the restricted group. Now, your managers can create and modify the restricted users' whitelists using Special:WhitelistEdit.

Important Note
There have been numerous bug and backward compatibility improvements made to the extension. A number of topics discussed in the extension talk page are outdated. Use the material obtained there at your own risk!

Advanced Extension Configuration
The following variables can be defined in LocalSettings.php to modify the behavior of Extension:Whitelist: