monogramm/docker-osrm-frontend repository overview

⁠osrm-frontend

This is the frontend served at https://map.project-osrm.org⁠. This frontend builds heavily on top of Leaflet Routing Machine⁠. If you need a simple OSRM integration in your webpage, you should start from there.

⁠Using Docker

The easiest and quickest way to setup your own routing engine backend is to use Docker images we provide. We base our Docker images⁠ on Alpine Linux and make sure they are as lightweight as possible.

Serves the frontend at http://localhost:9966 running queries against the routing engine backend:

docker run -p 9966:9966 osrm/osrm-frontend

Per default routing requests are made against the backend at http://localhost:5000. You can change the backend by using -e OSRM_BACKEND='http://localhost:5001' in the docker run command.

Per default address requests are made against the Nominatim demo at https://nominatim.openstreetmap.org. You can change the Nominmatim instance by using -e NOMINATIM_URL='http://localhost:8080' in the docker run command.

In case Docker complains about not being able to connect to the Docker daemon make sure you are in the docker group.

sudo usermod -aG docker $USER

To build the docker image locally:

docker build . -f docker/Dockerfile -t osrm-frontend
docker run -p 9966:9966 osrm-frontend

⁠Development

Install dependencies via

npm install

Then compile assets and start the local server with

npm start

On Windows with no Unix tools installed (bash, sed, cp) the server could be started with two other commands executed by npm start internally:

npm run compile
npm run start-index

⁠Changing Backends

In src/leaflet_options.js adjust:

services: [{
  label: 'Car (fastest)',
  path: 'http://localhost:5000/route/v1'
}],

For debug tiles showing speeds and small components available at /debug adjust in debug/index.html

"osrm": {
  "type": "vector",
  "tiles" : ["http://localhost:5000/tile/v1/car/tile({x},{y},{z}).mvt"]
}