📦 openrouteservice/ GIScience

Installation

You can easily run openrouteservice yourself!

tl;dr: We suggest using docker to install and launch openrouteservice. In short, a machine with a working docker installation will get everything done for you.

Change to the directory where you want to install your local openrouteservice and first create some directories, where openrouteservice will persist its data:

mkdir -p ors-docker/config ors-docker/elevation_cache ors-docker/graphs ors-docker/files ors-docker/logs

Only use nightly (main branch) if you know what you do. We recommend running docker compose with the latest release version.

wget https://github.com/GIScience/openrouteservice/releases/latest/download/docker-compose.yml

Start openrouteservice in the background:

docker compose up -d

This will pull the openrouteservice docker image of the selected version and start it up using an example setup and the provided test OSM file for Heidelberg/Germany and surrounding area.

To see the container's logs, run:

docker compose logs 

Stop the container with:

docker compose down

Usage

The above mentioned endpoints will be available on port 8080:

• http://localhost:8080/ors/v2/directions
• http://localhost:8080/ors/v2/isochrones
• http://localhost:8080/ors/v2/matrix
• http://localhost:8080/ors/v2/snap
• http://localhost:8080/ors/v2/export
• http://localhost:8080/ors/v2/health
• http://localhost:8080/ors/v2/status

You can find more information in the endpoint documentation pages linked above.

On the API Reference there is also a description how you can use the Swagger-UI and the API Playground for local instances of openrouteservice.