Skip to content

Latest commit

 

History

History
307 lines (187 loc) · 15.3 KB

INSTALL.md

File metadata and controls

307 lines (187 loc) · 15.3 KB
Raw

Installation Instructions

Dependencies

Required versions:

  • PostgreSQL >= 9.3
  • osm2pgsql >= 0.90.0

CentOS:

$ yum update
$ yum install gzip zlib zlib-devel bzip2-devel zip postgresql postgresql-server postgresql-libs postgresql-contrib postgresql-common postgresql-devel postgis unzip librsvg2 librsvg2-devel gnome-python2-rsvg pygobject2 pygobject2-devel cairo cairo-devel cairomm-devel libjpeg-turbo-devel pango pango-devel pangomm pangomm-devel giflib-devel npm nodejs git python wget python-ply python-imaging pycairo python-cairosvg pygtk2 pygtk2-devel make cmake boost-devel expat-devel geos-devel proj-devel proj-epsg lua-devel gcc-c++ libjpeg-turbo-devel giflib-devel

Debian/Ubuntu:

$ apt-get install --no-install-recommends postgresql-9.5-postgis-2.2
$ apt-get install gzip postgresql-common php-gettext unzip python-ply python-imaging python-cairo python-cairosvg librsvg2-2 librsvg2-dev libpango1.0-dev libcairo2-dev libcairomm-1.0-dev libjpeg-turbo8-dev libpangomm-1.4-1 libpangomm-1.4-dev npm nodejs wget zlib1g-dev osm2pgsql php5-pgsql
$ apt-get install git libgif-dev build-essential g++ make zip
$ apt-get install nodejs-legacy # see https://stackoverflow.com/questions/21168141/can-not-install-packages-using-node-package-manager-in-ubuntu for the reason
# in case you want to build osm2pgsql from sources
$ apt-get install cmake

For system-specific installation of Cairo also have a look at the node-canvas Wiki.

Installation

Move to your favorite directory and clone this repository:

$ git clone https://github.com/rurseekatze/node-tileserver.git
$ cd node-tileserver

Not that this is the current developing stage, which may contain bugs and can lead to crashes. Therefore it is recommended to download a stable version.

After that you can install all necessary NodeJS modules with npm:

$ npm install

Install osm2pgsql (Ubuntu and Debian users may use their osm2pgsql package provided by their distribution instead):

$ git clone https://github.com/openstreetmap/osm2pgsql.git
$ cd osm2pgsql
$ cmake
$ make
$ sudo make install
$ cd ..
$ rm -fr osm2pgsql

Set up the PostgreSQL database with PostGIS and hstore extensions:

$ sudo -u postgres createuser openrailwaymap
$ sudo -u postgres createdb -E UTF8 -O openrailwaymap openrailwaymap

$ sudo -u postgres psql -d openrailwaymap -c "CREATE EXTENSION postgis;"
$ sudo -u postgres psql -d openrailwaymap -c "CREATE EXTENSION hstore;"

$ sudo service postgresql-9.5 initdb
$ sudo service postgresql-9.5 start
$ sudo chkconfig postgresql-9.5 on

For authentication to the database, we are using md5 method. Edit your pg_hba.conf to use md5 authentication for local unix sockets and local TCP/IP connections from your host.

The database password is managed in a pgpass file. Create a pgpass file (or edit the existing one) in the home directory of the user that will be used for running the processes of API, tileserver and import/update scripts:

$ vim ~/.pgpass

Add a line with this format:

hostname:port:database:username:password

in this example (replace YOURPASSWORD by the password you entered in the createuser command):

localhost:5432:openrailwaymap:openrailwaymap:YOURPASSWORD

Then set the correct file permissions:

$ chmod 600 ~/.pgpass

Now you can load some data into your database. All tags which are used by the MapCSS style sheet have to be in a hstore column called "tags".

$ osm2pgsql --create --database openrailwaymap --username openrailwaymap --prefix openrailwaymap --slim --style railmap.style --hstore-all --hstore-add-index railways.osm

Have a look at an example toolchain for an example of using osm2pgsql with filtered data.

Now you can begin to write your own rendering styles. node-tileserver processes rendering styles written in MapCSS. Have a look at the following websites for an introduction, examples and specifications:

You need MapCSS converter to compile your MapCSS styles to JavaScript. Go to your styles directory and compile all your MapCSS styles in one run (you have to do this after every change of your stylesheets):

$ for stylefile in *.mapcss ; do python mapcss_converter.py --mapcss "$stylefile" --icons-path . ; done

Note that you have to recompile the stylesheets every time you change the MapCSS files to apply the changes. It is also necessary to restart the tileserver to reload the stylesheets.

If you plan to run another webserver like Apache parallel to the tileserver, you need a proxy that routes incoming requests. Apache can be used to forward incoming requests to the port of the tileserver.

The configuration is placed at /etc/apache2/sites-available/ on Ubuntu/Debian. Other distros use /etc/apache/vhosts.d/ or just another directory. Log files will be saved to /var/log/apache2/ You should change this path if you are using other systems, e.g. to /var/log/httpd/ on CentOS/RHEL.

Vhost configuration of the API (tiles.example.com.conf) looks like this:

<VirtualHost *:80>
ServerName tiles.example.com
ServerAlias  a.tiles.example.com b.tiles.example.com c.tiles.example.com
ProxyPreserveHost On
ProxyPass / http://localhost:9000/
ProxyPassReverse / http://localhost:9000/
ErrorLog /var/log/apache2/tiles.example.com.error.log
LogLevel warn
CustomLog /var/log/apache2/tiles.example.com.access.log combined
</VirtualHost>

Make sure that your server does not accept requests on port 9000 from outside (to circumvent the proxy and its logging).

Now you are almost ready to run the tileserver. You just need to check the configuration.

Configuration

You can set various options to configure your tileserver:

  • tileSize Size of tiles in pixels. Usually it is not necessary to change this value, but you can increase or decrease it for higher rendering performance or faster map generation. Consider that the bitmap tiles are rendered in "retina" quality, so the actual tile size is twice as high (Supersampling). Default: 256

  • prefix The prefix used for osm2pgsql tables. Depends on the parameters you are using in osm2pgsql. Default: openrailwaymap

  • database The name of the used database. Depends on the parameters you are using in osm2pgsql. Default: openrailwaymap

  • username The username to be used for database requests. Depends on the parameters you are using in osm2pgsql. Default: openrailwaymap

  • tiledir Relative or absolute path to the directory where bitmap and vector tiles are stored in separate directories. Default: /var/www/orm/OpenRailwayMap

  • expiredtilesdir Relative or absolute path to the list of expired tiles. Default: /var/www/orm/OpenRailwayMap/import

  • styledir Relative or absolute path to the directory containing (compiled) MapCSS styles. Default: ../styles

  • zoomOffset Zoom offset. Default: 0

  • minZoom Lowest allowed zoomlevel for tiles. Change this value if you do not want to serve lowzoom tiles. Default: 0

  • maxZoom Highest allowed zoomlevel for tiles. Change this value if you do not want to serve highzoom tiles. Default: 20

  • styles List of available rendering styles. Please add the filenames of rendering styles in the styles directory to this list. Note that vector is already in use for serving vector tiles. Default: standard, maxspeed, signals

  • intscalefactor Scale factor. You do not need to change this value. Default: 10000

  • geomcolumn Name of the geometry column used in the database. You will not need to change this value. Default: way

  • pxtolerance Pixel tolerance used for simplifying vector data. You do not need to change this value. Default: 1.8

  • maxPrerender Highest zoomlevel in which tiles are prerendered in initial rendering run. Tiles in higher zoomlevels will be rendered just on request. Change this value to increase or decrease the load for your system. As higher the value, as more tiles have to be rendered. If your selected value is too low, tile requests will be slow, so you should find a value that balances system load and request times. Default: 8

  • maxCached Highest zoomlevel in which tiles are cached. Tiles in higher zoomlevels will be rendered just on request and removed from the filesystem cache instead of rerendering if they are expired. Change this value to increase or decrease the load for your system. As higher the value, as faster the tile access. But you should also note that cached tiles will need a lot of storage. It can occur that a volume is full even if there is still storage left, because all inodes of the file system are in use. On the other hand, if your selected value is too low, tile requests will be slow, so you should find a value that balances system load, request times and storage consumption. Default: 16

  • minExpiring Lowest zoomlevel in which tiles are only marked as expired if they are affected by an edit. Tiles in lower zoomlevels will be marked as expired only by a manual expiring (such as in an update script). Change this value to increase or decrease the load for your system. As lower the value is, as more tiles have to be rerendered. If your selected value is too high, too many not-affected tiles will be marked as expired, so you should find a value that balances system load and request times. Default: 10

  • maxsockets Maximum number of concurring http connections. The optimal value depends on your environment (hardware, operating system, system settings, ...), so you should try some values to get the optimal performance. Default: 100

  • tileserverPort Port on which the tileserver is listening. Change this value if you have conflicts with other applications. Default: 9000

  • tileBoundTolerance Extend the bounding box of the requested data by this number of pixels to avoid cutted icons at tile bounds. Default: 60

  • filterconditions For higher performance and smaller tiles it is possible to set some hardcoded SQL filter conditions

Note: For some parameters it is also necessary to change the modify the options in kothic-leaflet.js!

Run the server

In case your system uses systemd you can install the unit file for the API server:

$ cd api
$ sudo make install-systemd

The user and group the service will run defaults to "openrailwaymap", you can change this in the makefile or by passing the ORM_USER or ORM_GROUP variables to make.

If you are not using systemd either write an init script or start the server in a screen session.

Start the API server:

$ sudo systemctl start orm-tileserver.service

Optionally enable autostart:

$ sudo systemctl enable orm-tileserver.service

Before the tileserver is being used for delivering tiles, you should start the initial rendering of tiles. This will take some time, so it is recommended to start the script in a screen session:

$ screen -R init-rendering
$ ./init.sh
$ [Ctrl][A][D]

Usage

Bitmap tiles

The URL to load the bitmap tiles with Leaflet or Openlayers:

http://tiles.YOURDOMAIN.org/STYLENAME/z/x/y.png

Leaflet example:

...
map = L.map('mapFrame');
railmap = new L.TileLayer('http://{s}.tiles.YOURDOMAIN.org/standard/{z}/{x}/{y}.png',
{
    minZoom: 2,
    maxZoom: 19,
    tileSize: 256
}).addTo(map);
...

If you have more than one rendering style, you can change between them by changing the source url:

...
railmap._url = 'http://{s}.tiles.YOURDOMAIN.org/'+style+'/{z}/{x}/{y}.png';
railmap.redraw();
...

Vector tiles

URL to access vector tiles for using in Leaflet and KothicJS:

http://tiles.YOURDOMAIN.org/vector/z/x/y.json

Leaflet example:

Include all javascript files from kothic/src and kothic/dist and your compiled MapCSS styles into your website.

...
map = L.map('mapFrame');
railmap = new L.TileLayer.Kothic('http://{s}.tiles.YOURDOMAIN.org/vector/{z}/{x}/{y}.json',
{
    minZoom: 2,
    maxZoom: 19
});

MapCSS.onImagesLoad = function()
{
    map.addLayer(railmap);

    map.on('zoomend', function(e)
    {
        railmap.redraw();
    });

    setStyle("standard");
};

var styles = ["standard", "signals", "maxspeeds"]
for (var i=0; i<styles.length; i++)
    MapCSS.preloadSpriteImage(styles[i], "styles/"+styles[i]+".png");

If you have more than one rendering style, you can change between them:

...
for (var i=0; i<MapCSS.availableStyles.length; i++)
    if (MapCSS.availableStyles[i] != style)
        railmap.disableStyle(MapCSS.availableStyles[i]);

railmap.enableStyle(style);
railmap.redraw();
...

There is also the possibility to force the rerendering of a single tile. Just add /dirty at the end of a tile URL. Example:

http://tiles.YOURDOMAIN.org/STYLENAME/z/x/y.png/dirty

or

http://tiles.YOURDOMAIN.org/vector/z/x/y.json/dirty

Update database and tiles

Use osm2pgsql to update your database. To rerender all expired tiles, you need a file that contains a list of expired tiles. Such a command could look like this:

$ osm2pgsql --database openrailwaymap --username openrailwaymap --append --prefix openrailwaymap --slim --style railmap.style --hstore --cache 512 --expire-tiles 0-15 --expire-output expired_tiles changes.osc

Note that the value of the parameter --expire-tiles should have the format minZoom-(maxCached minus 2).

Also have a look at an example toolchain on how to update a database containing filtered data.

Run

$ node expire-tiles.js path/to/expired_tiles

to load the list of expired tiles and to mark all these tiles as expired. They will be rerendered on their next request or deleted from cache if they are highzoom tiles.

Note: It is not efficient to go through this list for all zoom levels, so by default only tiles zoom>=maxPrerender and zoom<=maxCached are marked as expired. For other zoomlevels you can mark all affected tiles by executing

$ cd /path/to/your/vector/tiles
$ find <zoom> -exec touch -t 197001010000 {} \;

You can also execute these commands to expire all tiles after a change of your stylesheet.

MapCSS extension

node-tileserver extends the used KothicJS renderer with a new MapCSS rule. Set

kothicjs-ignore-layer: true;

to ignore the layer=* tag.

This can be useful for some purposes when you want to override the built-in layering of KothicJS.

Example: You want to render maxspeeds by colouring each line dependent on the maxspeed=* tag. If lines are overlapping, ones with higher values should be drawn on the top of lines with lower values. Without -x-ignore-layer, it may happen that a line with a higher value of maxspeed is hidden by a line with a lower values of maxspeed, because the lowspeed way is a bridge and has a higher value of layer=*.