These are the installation and configuration instructions for the Maps extension.
Table of contents
Go to the root directory of your MediaWiki installation.
If you have previously installed Composer skip to step 2.
To install Composer, just download http://getcomposer.org/composer.phar into your current directory.
wget http://getcomposer.org/composer.phar
Now using Composer, install Maps
php composer.phar require mediawiki/maps "*"
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.
If you want to use the Semantic MediaWiki integration, you will also need to install Semantic MediaWiki.
At present, minimal configuration is needed to get Maps running. Configuration is done like in most MediaWiki extensions, by placing some simple snippets of PHP code at the bottom of MediaWiki's LocalSettings.php.
As of June 2016, Google requires you to provide an API key when you where not already using their maps API. This means that you will either need to configure this key, or use another of the supported mapping services.
$GLOBALS['egMapsGMaps3ApiKey'] = 'your-api-key';
For OpenLayers:
$GLOBALS['egMapsDefaultService'] = 'openlayers';
For Leaflet:
$GLOBALS['egMapsDefaultService'] = 'leaflet';
You might also want to fully disable Google Maps by placing a copy of the egMapsAvailableServices
setting in LocalSettings, and removing the googlemaps3 line.
See the Maps settings file for all available configuration options.
The PHP and MediaWiki version ranges listed are those in which Maps is known to work. It might also work with more recent versions of PHP and MediaWiki, though this is not guaranteed. Increases of minimum requirements are indicated in bold. For a detailed list of changes, see the release notes.
| PHP | MediaWiki | Semantic MediaWiki | Release status | |
|---|---|---|---|---|
| Maps 4.1.x | 5.6 - TBD | TBD - 1.29+ | TBD - 2.5+ | In development |
| Maps 4.0.x | 5.5 - 7.0 | 1.23 - 1.28 | 2.1 - 2.4 | Stable release |
| Maps 3.8.x | 5.5 - 7.0 | 1.23 - 1.27 | Not applicable | Legacy release |
Older versions (no longer supported):
| PHP | MediaWiki | Composer | Validator | |
|---|---|---|---|---|
| Maps 3.7.x | 5.5 - 7.0 | 1.23 - 1.27 | Required | Handled by Composer |
| Maps 3.6.x | 5.5 - 7.0 | 1.23 - 1.27 | Required | Handled by Composer |
| Maps 3.5.x | 5.3.2 - 7.0 | 1.18 - 1.27 | Required | Handled by Composer |
| Maps 3.4.x | 5.3.2 - 7.0 | 1.18 - 1.27 | Required | Handled by Composer |
| Maps 3.3.x | 5.3.2 - 5.6.x | 1.18 - 1.25 | Required | Handled by Composer |
| Maps 3.1.x & 3.2.x | 5.3.2 - 5.6.x | 1.18 - 1.24 | Required | Handled by Composer |
| Maps 3.0.x | 5.3.2 - 5.6.x | 1.18 - 1.23 | Required | 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 |
All current versions of Maps have full support for all databases that can be used with MediaWiki.