OSRM cookbook

This cookbook can do the following things for you

• Install and configure the OSRM route daemon
• Download, extract, prepare map data and keep them up to date
  • (Uses the map data from Geofabrik)

To use the following recipes and providers, add the following to your metadata.rb

depends'osrm'

Recipes

default

Runs install_git

install_git

Clone and install the latest HEAD from Project-OSRM to node['osrm']['target'] (default /opt/osrm).

Providers

osrm_map

osrm_map is a shortcut that calls the other map providers in the following order

• osrm_map_download
• osrm_map_extract
• osrm_prepare

This example downloads, extracts and prepares the osrm map for Germany:

osrm_map'germany'

The following additional attributes are allowed:

osrm_map'europe'map_dir'/srv/my_map_data'# Where to put the maps (defaults to '/opt/osrm-data')# Path to the map (osm.pbf or osm.bz2) to use.# This is filled in automatically if the file is downloaded.# Only use it in case you are using a custom map.map'/path/to/map.osm.bpf'profile'car'# Profile to use (defaults to 'car')profile_dir'/srv/my_profiles'# Where to look for profiles (.lua files)extract_command'osrm-extract'# Path to osrm-extract binaryprepare_command'osrm-prepare'# Path to osrm-prepare binaryuser'my_osrm_user'# User to run commands ascwd'/srv/my_osrm'# Set working directory for osrm-extractthreads5# How many threads to use (defaults to number of cpu cores)cleanupfalse# Do not cleanup .osrm and .osrm.restrictions after preparingtimeout3600# Timeout in seconds for osrm-extract/osrm-prepare. Defaults to 24hstxxl_size150000# Size (in MB) of stxxl temporary file. Dynamically allocated by defaultstxxl_file'/tmp/stxxl'# Location of stxxl temporary file. Defaults to '/var/tmp/stxxl'# The files checksum can also be checked (defaults to true)# When set to true, it will use the default checksum set in the attributes (if existent)# When set to false, it doesn't check the checksum# When set to an ftp:// or http:// URL, retrieve the file and use the checksum in its content# When set to a string, use it as the checksumchecksum'http://url.to/checksum.md5'action:create_if_missing# :create and :create_if_missing are supportedend

osrm_map_download

Downloads map data for the specified region.

osrm_map_download'planet'osrm_map_download'europe'osrm_map_download'north-america'osrm_map_download'germany'osrm_map_download'us-west'

For a full list of supported regions, take a look at attributes/regions.rb. If necessary, it can be easily extended to support even more, feel free to file a pull request!

By default, the provider automatically re-downloads the file if it was changed on the server. You can prevent this behaviour when using the :download_if_missing action:

osrm_map_download'europe'doaction:download_is_missingend

Furthermore, you can specify the following attributes:

osrm_map_download'us-west'douser'my_osrm_user'map_dir'/srv/my_map_data'# Where to put the downloaded files (defaults to '/opt/osrm-data')# Manually specify url to download map from.# Defaults to the URL in the attributes (available for most regions)url'http://my.geoserver.com/map.osm.bpf'# The files checksum can also be checked (defaults to false)# When set to true, it will use the default checksum set in the attributes# When set to false, it doesn't check the checksum# When set to an ftp:// or http:// URL, use its contents as a checksum# When set to a string, use it as the checksumchecksum'http://url.to/checksum.md5'end

osrm_map_extract

Extracts downloaded map data, using osrm-extract.

Example:

osrm_map_extract'europe'

The following attributes are supported:

osrm_map_extract'europe'domap_dir'/srv/my_map_data'# Use the same directory you used in osrm_map_download# Path to the map (osm.pbf or osm.bz2) to use.# This is set automatically (via attributes),# if you use a map downloaded by osrm_map_download.# Only use it in case you are using a custom map.map'/path/to/map.osm.bpf'profile'car'# Profile to use (defaults to 'car')profile_dir'/srv/my_profiles'# Where to look for profiles (.lua files)command'osrm-extract'# Binary to useuser'my_osrm_user'cwd'/srv/my_osrm'# Set working directory for osrm-extractthreads5# How many threads to use (defaults to number of cpu cores)timeout3600# Timeout in seconds for osrm-extract. Defaults to 24hstxxl_size150000# Size (in MB) of stxxl temporary file. Dynamically allocated by defaultstxxl_file'/tmp/stxxl'# Location of stxxl temporary file. Defaults to '/var/tmp/stxxl'end

osrm_map_prepare

Prepares extracted map data, using osrm-prepare.

Example:

osrm_map_prepare'europe'

The following attribtues are supported:

osrm_map_prepare'europe'domap_dir'/srv/my_map_data'# Use the same directory you used in osrm_map_download# Path to the map (osm.pbf or osm.bz2) to use.# This is set automatically (via attributes),# if you use a map downloaded by osrm_map_download.# Only use it in case you are using a custom map.map'/path/to/map.osm.bpf'profile'car'# Profile to use (defaults to 'car')profile_dir'/srv/my_profiles'# Where to look for profiles (.lua files)command'osrm-prepare'# Binary to useuser'my_osrm_user'cwd'/srv/my_osrm'# Set working directory for osrm-preparethreads5# How many threads to use (defaults to number of cpu cores)cleanupfalse# Do not cleanup .osrm and .osrm.restrictions after preparingtimeout3600# Timeout in seconds for osrm-extract. Defaults to 24hend

osrm_routed

Sets up and starts osrm-routed (using upstart) for the specified region

Example:

osrm_routed'europe'

The following attributes are supported:

osrm_routed'europe'doconfig_dir'/etc/osrm-routed'# Where to put the configuration fileservice_name'osrm-routed-%s'# %s will be replaced with the selected region and profileprofile'car'# Profile for which to start the daemonuser'osrm-routed'# User to run the daemon as (will be created if not existent)home'/my/osrm-install'# Home directory of the osrm-routed userdaemon'/path/to/osrm-routed'map_dir'/srv/my_map_data'# Use the same directory you used in osrm_map_download)map_base'/path/to/map_base'# Base path of the (prepared) map# e.g. '/opt/osrm-data/europe/car/europe-lastest'# (skip the file extention, like .edges or .osm.bpf)threads16# How many threads to use (defaults to number of cpu cores)port5000# TCP port to bind tolisten'127.0.0.1'# TCP address to listen onend

Attributes

You can set the following attributes if you need settings that differ form the defaults

default

node['osrm']['repository']='git://github.com/DennisOSRM/Project-OSRM.git'node['osrm']['branch']='master'# use e.g. 'v0.3.5' for a stable versionnode['osrm']['target']='/opt/osrm'node['osrm']['map_dir']='/opt/osrm-data'node['osrm']['threads']=node['cpu']['total']

routed

node['osrm']['routed']['user']='osrm-routed'node['osrm']['routed']['service_name']='osrm-routed-%s'node['osrm']['routed']['config_dir']='/etc/osrm-routed'

regions

You can add custom regions like this

node['osrm']['map_data']['your-region']['profiles']=%w{car}node['osrm']['map_data']['your-region']['url']="http://download.geofabrik.de/your-region-latest.osm.pbf"node['osrm']['map_data']['your-region']['checksum']="#{node['osrm']['map_data']['your-region']['url']}.md5"

Contributing

Pull requests are very welcome!

1. Fork the repository on Github
2. Create a named feature branch (like add_component_x)
3. Write you change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github