Skip to content

Latest commit

聽

History

History
228 lines (193 loc) 路 5.82 KB

INSTALL.md

File metadata and controls

228 lines (193 loc) 路 5.82 KB
Raw

Maps installation

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

Table of contents

Download and installation

Maps is installed and upgraded via Composer. For a detailed explanation see installing MediaWiki extensions with Composer.

In short:

  • Edit composer.local.json (preferred) or composer.json by adding mediawiki/maps to the require section
  • Choose the version constraint. Typically you want to pick ~x.y, where x.y is the latest minor version of Maps receiving only backwards-compatible code changes
  • Run composer update or php composer.phar update depending on how you installed Composer.

For upgrading, simply edit the composer.local.json or composer.json and update the version constraint. Then run composer update.

Example for a require section just with Maps:

    "require": {
        "mediawiki/maps": "~4.3"
    }

If you would also like to make use of the semantic functionality Maps provides you also need to install Semantic MediaWiki. In this case the example require section with both Maps and Semantic MediaWiki looks like this:

    "require": {
        "mediawiki/maps": "~4.3",
	"mediawiki/semantic-media-wiki": "~2.5"
    }

You will need a comma behind each version constraint except the last one.

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.

If you want to use the Semantic MediaWiki integration, you will also need to install Semantic MediaWiki.

Configuration

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.

Required configuration for Google Maps

$GLOBALS['egMapsGMaps3ApiKey'] = 'your-api-key';

Not using Google Maps by default

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.

Platform compatibility and release status

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.5.x 5.6 - 7.2+ 1.27 - 1.30+ TBD - 3.0+ In development
Maps 4.4.x 5.6 - 7.1 1.27 - 1.29 2.1 - 2.5 Stable release
Maps 4.3.x 5.6 - 7.1 1.27 - 1.29 2.1 - 2.5 Obsolete release
Maps 4.2.x 5.5 - 7.1 1.23 - 1.29 2.1 - 2.5 Obsolete release
Maps 4.1.x 5.5 - 7.1 1.23 - 1.28 2.1 - 2.5 Obsolete release
Maps 4.0.x 5.5 - 7.0 1.23 - 1.28 2.1 - 2.4 Obsolete release

Older obsolete versions:

PHP MediaWiki Composer Validator
Maps 3.8.x 5.5 - 7.0 1.23 - 1.27 Required Handled by Composer
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.2.x 5.3.2 - 5.6.x 1.18 - 1.24 Required Handled by Composer
Maps 3.1.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

Database support

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