Skip to content

Latest commit

 

History

History
135 lines (106 loc) · 3.78 KB

INSTALL.md

File metadata and controls

135 lines (106 loc) · 3.78 KB

Maps installation

These are the installation and configuration instructions for the Maps extension.

Versions

Status Release date Git branch
Maps 3.1.x Development version Future master
Maps 3.0.1 Stable release 2014-03-27 3.0.1
Maps 2.0.x Legacy release 2012 2.0.x
Maps 1.0.5 Legacy release 2011-11-30 1.0.5

Platform compatibility

PHP MediaWiki Composer Validator
Maps 3.1.x 5.3.2 - 5.6.x 1.18 - 1.23 Required 2.x (handled by Composer)
Maps 3.0.x 5.3.2 - 5.6.x 1.18 - 1.23 Required 1.x (handled by Composer)
Maps 2.0.x 5.3.2 - 5.5.x 1.18 - 1.23 Not supported 0.5.1
Maps 1.0.5 5.2.0 - 5.3.x 1.17 - 1.19 Not supported 0.4.13 or 0.4.14

When installing Maps 2.x, see the installation instructions that come bundled with it. Also make use of Validator 0.5.x. More recent versions of Validator will not work.

Database support

All current versions of Maps have full support for all databases that can be used with MediaWiki.

Download and installation

The recommended way to download and install Maps is with Composer using MediaWiki 1.22 built-in support for Composer. MediaWiki versions prior to 1.22 can use Composer via the Extension Installer extension.

Step 1

If you have MediaWiki 1.22 or later, go to the root directory of your MediaWiki installation, and go to step 2. You do not need to install any extensions to support composer.

For MediaWiki 1.21.x and earlier you need to install the Extension Installer extension.

Once you are done installing the Extension Installer, go to its directory so composer.phar is installed in the right place.

cd extensions/ExtensionInstaller

Step 2

If you have previously installed Composer skip to step 3.

To install Composer:

wget http://getcomposer.org/composer.phar

Step 3

Now using Composer, install Maps

php composer.phar require mediawiki/maps "*"

Verify installation success

As final step, you can verify Maps got installed by looking at the Special:Version page on your wiki and verifying the Maps extension is listed.

Custom image layers support (experimental)

For support of the experimental custom image layers feature you have to run the MediaWiki update script.

php maintenance/update.php

Configuration

See the Maps settings file for the available configuration options.