History

nupplaPhil 75143e27b5 Move Config::set() to DI::config()->set()		2020-01-19 21:21:52 +01:00
..
config	[openstreetmap] Update config file style/name	2018-11-25 02:14:54 -05:00
lang	NL translation THX JeroenED	2018-08-25 21:12:02 +02:00
templates	OSM: Results are now cached, format limits to other networks are respected	2018-03-20 06:43:03 +00:00
README.md	[openstreetmap] Update config file style/name	2018-11-25 02:14:54 -05:00
openstreetmap.js	start porting openstreetmap plugin	2015-05-15 20:27:32 +02:00
openstreetmap.php	Move Config::set() to DI::config()->set()	2020-01-19 21:21:52 +01:00

README.md

OpenStreetMap Addon

by Mike Macgirvin
   Klaus Weidenbach

This addon allows you to use OpenStreetMap for displaying locations.

Requirements

To use this addon you need a tile Server that provides the maps. OpenStreetMap data is free for everyone to use. Their tile servers are not. Please take a look at their "Tile Usage Policy": http://wiki.openstreetmap.org/wiki/Tile_usage_policy You can run your own tile server or choose one from their list of public tile servers: http://wiki.openstreetmap.org/wiki/TMS Support the OpenStreetMap community and share the load.

Configuration

If you for any reason prefer to use a configuration file instead of the admin panels, please refer to the Alternative Configuration below.

Activate the addon from your admin panel.

You can now add a Tile Server and default zoom level in the addon settings page of your admin panel.

The Time Server URL points to the tile server you want to use. Use the full URL, with protocol (http/s) and trailing slash. You can configure the default zoom level on the map in the Default Zoom box. 1 will show the whole world and 18 is the highest zoom level available.

Alternative Configuration

Open the config/local.config.php file and add "openstreetmap" to the list of activated addons.

 'system' => [
     ...
     'addon' => '...,openstreetmap'
     ...
 ]

You can set configuration variables for the addon in the config/addon.config.php file:

'openstreetmap' => [
	'tmsserver' => 'https://www.openstreetmap.org',
	'nomserver' => 'https://nominatim.openstreetmap.org/search.php',
	'zoom' => 16,
	'marker' => 0,
],

The tmsserver points to the tile server you want to use. Use the full URL, with protocol (http/s) and trailing slash. You can configure the default zoom level on the map with zoom. 1 will show the whole world and 18 is the highest zoom level available.

Please see provided config/openstreetmap.php file for explanation on the additional configuration keys.