Install MediaWiki
MediaWiki is the most popular wiki package and is the open source software that powers Wikipedia, among a great many other sites. This article covers installing MediaWiki to a UNPM Server.
This article assumes that MediaWiki is to be installed to a sub-directory called /wiki/, though it can be installed to a sub-directory of any name or depth (additional sub-directories) or even to the site's root directory.
Nginx configuration
Package-configs files
Create the package-configs files mediadwiki.conf and mediawiki_https.conf:
username@servername:~$ sudo nano /etc/nginx/package-configs/mediawiki.conf
Add to the new file:
location /wiki/ {
rewrite ^/wiki/([^?]*)(?:\?(.*))? /wiki/index.php?title=$1&$2 last;
location ~* ^/images/.*.(html|htm|shtml|php|js)$ {
types { }
default_type text/plain;
}
location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
try_files $uri /wiki/index.php;
expires max;
log_not_found off;
}
location ~ (index|load|api).*\.php$ {
include global-configs/php.conf;
}
location ~ \.php$ { deny all; }
}
username@servername:~$ sudo nano /etc/nginx/package-configs/mediawiki_https.conf
Add to the new file:
location /wiki/ {
rewrite ^/wiki/([^?]*)(?:\?(.*))? /wiki/index.php?title=$1&$2 last;
location ~* ^/images/.*.(html|htm|shtml|php|js)$ {
types { }
default_type text/plain;
}
location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
try_files $uri /wiki/index.php;
expires max;
log_not_found off;
}
location ~ (index|load|api).*\.php$ {
include global-configs/php_https.conf;
}
location ~ \.php$ { deny all; }
}
Sites-available file
Open the sites-available file for the domain:
username@servername:~$ sudo nano /etc/nginx/sites-available/example.com
In the HTTP server block, add:
include package-configs/mediawiki.conf;
In the HTTPS server block, add:
include package-configs/mediawiki_https.conf;
404 error_page
Note that if the error_page directive is being used to redirect 404 errors, be sure it is in the location / block:
location / {
try_files $uri $uri/ =404;
error_page 404 /404.html;
}
If it is directly in the server block, MediaWiki will not attempt to create pages when a wrong page is requested.
Create MediaWiki database and database user
Create a MediaWiki database and database user:
username@servername:~$ sudo mysql -uroot -p MariaDB [(none)]> create database databasename default character set utf8 default collate utf8_general_ci; MariaDB [(none)]> grant all on databasename.* to 'databasenameusername'@'localhost' identified by 'databasenameusernamepassword'; MariaDB [(none)]> exit
Note that the databasename, databasenameusername and databasenameusernamepassword will be required for the MediaWiki configuration process.
Install Mediawiki
Mediawiki will require a few packages to be installed to run:
username@servername:~$ sudo aptitude install imagemagick php5-intl
Make a couple of PHP configuration edits:
username@servername:~$ sudo nano /etc/php5/fpm/conf.d/suhosin.ini
Uncomment (by removing ;) and change:
suhosin.get.max_value_length = 1024
username@servername:~$ sudo nano /etc/php5/fpm/php-fpm.conf
Add to the file:
security.limit_extensions = .php .html .php5
Test nginx and restart services:
username@servername:~$ sudo nginx -t username@servername:~$ sudo service php5-fpm restart username@servername:~$ sudo service nginx restart
Download Mediawiki:
username@servername:~$ wget http://download.wikimedia.org/mediawiki/1.22/mediawiki-1.23.6.tar.gz username@servername:~$ tar -xzf mediawiki-1.23.6.tar.gz username@servername:~$ mv mediawiki-1.23.6/ /var/www/example.com/public/wiki username@servername:~$ find /var/www/example.com/public/wiki/ -type d | xargs chmod 775 username@servername:~$ find /var/www/example.com/public/wiki/ -type f | xargs chmod 664 username@servername:~$ sudo chown -R www-data:www-data /var/www/example.com/public/wiki/ username@servername:~$ rm mediawiki-1.23.6.tar.gz
Navigate to secure https://www.example.com/wiki and complete the Mediawiki installation. Most admins will prefer to use the 'Authorized editors only' option under 'User rights profile:'. Select 'PHP object caching (APC, XCache or WinCache)' in the Advanced Configuration options and be sure to sign up for update notifications.
LocalSettings.php
After completing the online setup, MediaWiki will prompt to download the LocalSettings.php file. This is the main configuration file for MediaWiki. It is easiest to open the file in a text editor and then copy and paste the contents into the LocalSettings.php file on the server. However, before doing that, the file still requires at least a few edits.
To support loading MediaWiki in non-secure sessions, but require secure session for logging in, change:
$wgserver = "//www.example.com";
To create a user rights management system better suited to smaller wikis, change:
$wgGroupPermissions['*']['createaccount'] = true;
Then, just below the permissions created by MediaWiki, add:
# The following permissions were added to allow user account creation without # granting new users the ability to edit. The admin accounts may elevate new # users to the added editor role to grant permission to edit $wgGroupPermissions['*']['createtalk'] = false; $wgGroupPermissions['*']['createpage'] = false; $wgGroupPermissions['*']['writeapi'] = false; $wgGroupPermissions['user']['edit'] = false; $wgGroupPermissions['user']['createtalk'] = false; $wgGroupPermissions['user']['createpage'] = false; $wgGroupPermissions['user']['minoredit'] = false; $wgGroupPermissions['user']['move'] = false; $wgGroupPermissions['user']['movefile'] = false; $wgGroupPermissions['user']['move-subpages'] = false; $wgGroupPermissions['user']['move-rootuserpages'] = false; $wgGroupPermissions['user']['reupload-shared'] = false; $wgGroupPermissions['user']['reupload'] = false; $wgGroupPermissions['user']['purge'] = false; $wgGroupPermissions['user']['sendemail'] = false; $wgGroupPermissions['user']['upload'] = false; $wgGroupPermissions['user']['writeapi'] = false; $wgGroupPermissions['editor'] = $wgGroupPermissions['user']; $wgGroupPermissions['editor']['edit'] = true; $wgGroupPermissions['editor']['createtalk'] = true; $wgGroupPermissions['editor']['createpage'] = true; $wgGroupPermissions['editor']['minoredit'] = true; $wgGroupPermissions['editor']['move'] = true; $wgGroupPermissions['editor']['move-subpages'] = true; $wgGroupPermissions['editor']['upload'] = true; $wgGroupPermissions['editor']['reupload'] = true; $wgGroupPermissions['editor']['sendemail'] = true; $wgGroupPermissions['sysop']['edit'] = true; $wgGroupPermissions['sysop']['createpage'] = true; $wgGroupPermissions['sysop']['createtalk'] = true; $wgGroupPermissions['sysop']['minoredit'] = true; $wgWikiEditorModules['toolbar']['global'] = true; $wgWikiEditorModules['toolbar']['user'] = false; $wgGroupPermissions['bureaucrat']['usermerge'] = true;
The * user group means all users, including anonymous users.
Below that, add:
# Enable requirement for secure login: $wgSecureLogin = true; # Enable pretty URLs $wgUsePathInfo = true; $wgArticlePath = "/wiki/$1";
Now paste the entire contents from the computer's text editor to the LocalSettings.php file on the server:
username@servername:~$ nano /var/www/example.com/public/wiki/LocalSettings.php
Note that depending on the operating system and editor used, the code may paste in without things such as returns between paragraphs. This does happen with Notepad++ in Windows 7, but can easily be fixed by first pasting into a new Notepad++ tab and copying from there.
Configuring MediaWiki
MediaWiki configuration is different from most of the popular PHP packages. Configuring is done through the LocalSettings.php file, extensions, which must be installed server-side with accompanied LocalSettings.php entries, and various different hard-to-find pages in the web interface. The MediaWiki Manual is an invaluable resource. Below are some simple and common extension and configuration settings.
Sidebar
To edit the MediaWiki Sidebar, while logged in with an admin account, simply navigate to https://www.example.com/wiki/MediaWiki:Sidebar.
Disable page counts
By default, MediaWiki will display page counts at the bottom of every page. This can be disabled with the following:
username@servername:~$ nano /var/www/example.com/public/wiki/LocalSettings.php
Add to the bottom of the file:
# Disables page counters $wgDisableCounters = true;
Change logo image
The logo image location is set in LocalSettings.php with the $wgLogo directive, for which the default is "$wgStylePath/common/images/wiki.png";. Replacing wiki.png with a different image while using the same name will be overwritten when updating MediaWiki, so it is better to use a file in a different location. MediaWiki updates generally ignore anything in the /images directory, so putting the logo there and setting $wgLogo = "$wgScriptPath/images/filename"; is a reasonable solution, though other locations may work just as well.
MobileFrontend extension
Although there are options to automatically detect mobile devices and display a mobile-friendly theme, the disadvantage of this feature is it requires disabling caching. A compromise is to install the MobileFrontend extension which creates a Mobile view link at the bottom of every page.
username@servername:~$ wget -O MobileFrontend-2e0af84.tar.gz https://codeload.github.com/wikimedia/mediawiki-extensions-MobileFrontend/legacy.tar.gz/REL1_22 username@servername:~$ tar -xzf MobileFrontend-2e0af84.tar.gz username@servername:~$ mv wikimedia-mediawiki-extensions-MobileFrontend-2e0af84/ /var/www/example.com/public/wiki/extensions/MobileFrontend username@servername:~$ find /var/www/example.com/public/wiki/extensions/MobileFrontend/ -type d | xargs chmod 775 username@servername:~$ find /var/www/example.com/public/wiki/extensions/MobileFrontend/ -type f | xargs chmod 664 username@servername:~$ sudo chown -R www-data:www-data /var/www/example.com/public/wiki/extensions/MobileFrontend/ username@servername:~$ rm MobileFrontend-2e0af84.tar.gz username@servername:~$ nano /var/www/example.com/public/wiki/LocalSettings.php
Add to the bottom of the file:
# Enables MobileFrontend extension require_once __DIR__ . "/extensions/MobileFrontend/MobileFrontend.php";
Tracking users in Mobile view with Piwik
Due to a bug in MediaWiki, the Piwik Integration extension cannot be used to track users who view MediaWiki in Mobile view. Instead, the MediaWiki:Common.js functionality must be used. Navigate to https://www.example.com/wiki/MediaWiki:Common.js and enter the site's Piwik javascript tracking code. Note that the image tracking code cannot be placed here. Edit LocalSettings.php.
username@servername:~$ nano /var/www/example.com/wiki/LocalSettings.php
Disable the Piwik Integration Extension, if installed, by commenting out the entries, then add:
# Use the site's JavaScript (MediaWiki:Common.js) $wgUseSiteJS = true;
Piwik Integration extension
The configuration below is intended to work on servers running Piwik as configured in this wiki's Piwik article. Due to the aforementioned bug in MediaWiki, this extension will not track users in Mobile view.
username@servername:~$ wget https://codeload.github.com/DaSchTour/piwik-mediawiki-extension/zip/master username@servername:~$ unzip master username@servername:~$ mv piwik-mediawiki-extension-master/ /var/www/example.com/public/wiki/extensions/Piwik username@servername:~$ find /var/www/example.com/public/wiki/extensions/Piwik/ -type d | xargs chmod 775 username@servername:~$ find /var/www/example.com/public/wiki/extensions/Piwik/ -type f | xargs chmod 664 username@servername:~$ sudo chown -R www-data:www-data /var/www/example.com/public/wiki/extensions/Piwik username@servername:~$ rm master username@servername:~$ nano /var/www/example.com/public/wiki/extensions/Piwik/Piwik.hooks.php
Change these 3 lines:
_paq.push(["setTrackerUrl", u+"js/"]);
g.defer=true; g.async=true; g.src=u+"js/"; s.parentNode.insertBefore(g,s);
<noscript></noscript>
username@servername:~$ nano /var/www/example.com/public/wiki/LocalSettings.php
Add to the bottom of the file:
# Enable Piwik Integration extension require_once __DIR__ . "/extensions/Piwik/Piwik.php"; $wgPiwikURL = "www.example.com/randomsymlink"; $wgPiwikIDSite = "1";
Note that if the path to Piwik has no subdomain or a different subdomain than the example, that should be used and $wgPiwikIDSite should be set to the site ID of the site being tracked.
Upgrading MediaWiki
Upgrading MediaWiki is done through the command line. For minor version upgrades, a patch file may be made available, otherwise a complete reinstall from backup is essentially performed. The best way to find the locations of an update's files and options is from the announcement email, presumably subscribed to during the setup process.
Maintenance mode
To prevent user edits to the wiki during upgrade, which might be saved to the old database, place the following statement at the bottom of LocalSettings.php.
username@servername:~$ nano /var/www/example.com/public/wiki/LocalSettings.php
# Use $wgReadOnly to prevent changes to the database. # Text in "" maybe changed as desired # The database will be locked from edits as long as the line below # is uncommented. $wgReadOnly="We are upgrading MediaWiki, please be patient. This wiki will be back shortly.";
Upgrading via patch
The first step is to backup the database. Log in to phpMyAdmin as the root MySQL user. Select the database used by MediaWiki and navigate to the Operations page. Enter the name of the backup database in the Copy database to: field, leaving the default selections for copying and select Go. It may be a good idea to include the MediaWiki version number in the backup name for future reference.
Backup the /wiki/ directory, download the patch from the location stated in the update notification email, decompress to the /wiki/ directory, run a dry run to see what files are modified, backup any files to be changed by the patch that have been customized, then run the patch. Thea actual location of the patch will depend on current version and the version to be upgraded to and can be found somewhere in this directory.
username@servername:~$ cp -p /var/www/example.com/public/wiki/ /var/www/example.com/public/wiki-backup/ username@servername:~$ wget https://releases.wikimedia.org/mediawiki/1.22/mediawiki-1.23.6.patch.gz username@servername:$ zcat mediawiki-1.23.6.patch.gz > /var/www/example.com/public/wiki/mediawiki-1.23.6.patch username@servername:~$ cd /var/www/example.com/public/wiki/ username@servername:/var/www/example.com/public/wiki$ patch -p1 --dry-run < mediawiki-1.23.6.patch username@servername:/var/www/example.com/public/wiki$ patch -p1 < mediawiki-1.23.6.patch username@servername:/var/www/example.com/public/wiki$ cd ~ username@servername:~$ sudo su www-data $ php /var/www/example.com/public/wiki/maintenance/update.php $ exit
After verifying the wiki is functioning properly, archive the original wiki.
username@servername:~$ mkdir /var/www/example.com/backup/wiki username@servername:~$ mv /var/www/example.com/public/wiki-backup /var/www/example.com/backup/wiki/mediawiki-1.22.2
Upgrade without patch
To upgrade to versions without a patch, near complete reinstallation is performed.
Install new version to new directory
username@servername:~$ wget https://releases.wikimedia.org/mediawiki/1.23/mediawiki-1.23.6.tar.gz username@servername:~$ tar -xzf mediawiki-1.23.6.tar.gz -C /var/www/example.com/public/ username@servername:~$ find /var/www/example.com/public/mediawiki-1.23.6/ -type d | xargs chmod 775 username@servername:~$ find /var/www/example.com/public/mediawiki-1.23.6/ -type f | xargs chmod 664 username@servername:~$ sudo chown -R www-data:www-data /var/www/example.com/public/mediawiki-1.23.6/ username@servername:~$ cp -p /var/www/example.com/public/wiki/LocalSettings.php /var/www/example.com/public/mediawiki-1.23.6/LocalSettings.php username@servername:~$ cp -rpfu /var/www/example.com/public/wiki/extensions/* /var/www/example.com/public/mediawiki-1.23.6/extensions username@servername:~$ cp -rpfu /var/www/example.com/public/wiki/images/* /var/www/example.com/public/mediawiki-1.23.6/images username@servername:~$ cp -rpfu /var/www/example.com/public/wiki/skins/* /var/www/example.com/public/mediawiki-1.23.6/skins
Note that any other additional files not a part of the MediaWiki package should also be copied to the new directory. Files that have been customized should be customized again using the file in the new installation.
Copy database to new database
Log in to phpMyAdmin as the root MySQL user. Select the database used by MediaWiki and navigate to the Operations page. Enter the name of the new database in the Copy database to: field, leaving the default selections for copying and select Go
Navigate to phpMyAdmin home page and select Users. Click Edit privileges next to the user assigned to the original MediaWiki database. Under Database-specific privileges, select the new database in the Add privileges on the following database: drop-down menu. In the following page, click Check all, then uncheck GRANT and click Go.
Now update the name of the database in the new LocalSettings.php file:
username@servername:~$ nano /var/www/example.com/public/wiki/LocalSettings.php
Change:
$wgDBname = "newdatabasename";
Archive the original /wiki/ installation, install the new installation in its place and run the update script:
username@servername:~$ mkdir /var/www/example.com/backup/wiki/ username@servername:~$ mv /var/www/example.com/public/wiki /var/www/example.com/backup/wiki/mediawiki-1.22.2 username@servername:~$ mv mediawiki-1.23.6/ /var/www/example.com/public/wiki username@servername:~$ sudo su www-data $ php /var/www/example.com/public/wiki/maintenance/update.php $ exit
Navigate to the wiki and verify it is functioning properly. If it is not functioning properly and the problem cannot repaired, then restore the archived version until the update can be successfully performed.