Installation
This page is for wiki administrators that want to install the Maps extension. This is only possible with server access.
Installation
Maps is installed using Composer with MediaWiki's built-in support for Composer.
Step 1/2: composer update
Change to the base directory of your MediaWiki installation and execute these two commands:
COMPOSER=composer.local.json composer require --no-update mediawiki/maps:~7.0
composer update mediawiki/maps --no-dev -o
Step 2/2: composer update
Add the following line to the end of your "LocalSettings.php" file:
wfLoadExtension( 'Maps' );
Verify installation success
Check the "Special:Version" page on your wiki. If it lists Maps, then installation was successful.
Configuration
Maps works out of the box without any configuration work being required. Below are some key configuration options that you might want to change. For a comprehensive overview of all settings, see Maps Configuration.
Mapping service
The Maps extension supports displaying maps using multiple mapping services, including Google Maps, Leaflet and OpenLayers. At present the default is Leaflet, while in older versions of the extension it was Google Maps.
If you do not wish to use the default, use the $egMapsDefaultService configuration parameter. Examples:
- For Google Maps:
$egMapsDefaultService = 'googlemaps3';
- For Leaflet:
$egMapsDefaultService = 'leaflet';
When using Google Maps, you will need to provide your Google API key:
$egMapsGMaps3ApiKey = 'your-api-key';
Geocoding service
The Maps extension supports geocoding, the conversion of human readable addresses to coordinates. This is done via a webservice used for each map displayed on your wiki. By default Maps uses Nominatim. To use a different geocoding service, use the $egMapsDefaultGeoService.
$egMapsDefaultGeoService = 'google';
Upgrading
When upgrading from Maps older than 6.0 to Maps 6.0 or later, you will need to load Maps in your "LocalSettings.php" file. This is done using the standard MediaWiki extension activation method. If you are using customized settings, you will also need to include the default settings. See the configuration instructions. See the examples shown above for installing this extension.
Platform compatibility
See the compatibility table on GitHub.
