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