openstreetmap/README.md

   1 OpenStreetMap Addon
   2 ===
   3
   4         by Mike Macgirvin
   5            Klaus Weidenbach
   6
   7 This addon allows you to use OpenStreetMap for displaying locations.
   8
   9 ## Requirements
  10
  11 To use this addon you need a tile Server that provides the maps.
  12 OpenStreetMap data is free for everyone to use. Their tile servers are not.
  13 Please take a look at their "Tile Usage Policy":
  14 http://wiki.openstreetmap.org/wiki/Tile_usage_policy
  15 You can run your own tile server or choose one from their list of public
  16 tile servers: http://wiki.openstreetmap.org/wiki/TMS
  17 Support the OpenStreetMap community and share the load.
  18
  19 ## Configuration
  20
  21 If you for any reason prefer to use a configuration file instead
  22 of the admin panels, please refer to the Alternative Configuration below.
  23
  24 Activate the addon from your admin panel.
  25
  26 You can now add a Tile Server and default zoom level in the addon settings
  27 page of your admin panel.
  28
  29 The Time Server URL points to the tile server you want to use. Use the full URL,
  30 with protocol (http/s) and trailing slash. You can configure the default zoom
  31 level on the map in the Default Zoom box.  1 will show the whole world and 18 is the highest
  32 zoom level available.
  33
  34
  35 ## Alternative Configuration
  36
  37 Open the `config/node.config.php` file and add "openstreetmap" to the list of activated addons.
  38
  39         'addons' => [
  40                 ...
  41                 'openstreetmap' => [
  42                         admin => true,
  43                 ],
  44         ]
  45
  46 You can set configuration variables for the addon in the `config/openstreetmap.config.php` file:
  47
  48         return [
  49                 'openstreetmap' => [
  50                         'tmsserver' => 'https://www.openstreetmap.org',
  51                         'nomserver' => 'https://nominatim.openstreetmap.org/search.php',
  52                         'zoom' => 16,
  53                         'marker' => 0,
  54                 ],
  55         ];
  56
  57 The *tmsserver* points to the tile server you want to use. Use the full URL,
  58 with protocol (http/s) and trailing slash. You can configure the default zoom
  59 level on the map with *zoom*. 1 will show the whole world and 18 is the highest
  60 zoom level available.
  61
  62 Please see provided `config/openstreetmap.php` file for explanation on the additional configuration keys.