# osrm > The Open Source Routing Machine is a high performance routing engine written in C++14 designed to run on OpenStreetMap data. Latest version **5.26.0** (published 2021-09-21) · BSD-2-Clause license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install osrm pnpm add osrm yarn add osrm bun add osrm ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 5.26.0 | | Published | 2021-09-21 | | First published | 2014-01-16 | | Weekly downloads | 0 | | License | BSD-2-Clause | | TypeScript types | separate (@types/osrm) | | Module format | CommonJS | | Node | >=4.0.0 | | Dependencies | 5 | | Unpacked size | 4.7 MB | | Known vulnerabilities | 0 | | Install scripts | yes | | GitHub stars | 8124 | | Author | Project OSRM Team | | Maintainers | miccolis, springmeyer, jfirebaugh, lbud, danpaz, willwhite, karenzshea, jrpruit1, freenerd, bergwerkgis, themarex, mapsam, mapbox-admin, danpat, ghoshkaj, danieljh, mokob, oxidase, chaupow, allierowan, mapbox-npm | ## Links - npm: https://www.npmjs.com/package/osrm - Repository: https://github.com/Project-OSRM/osrm-backend - Issues: https://github.com/Project-OSRM/osrm-backend/issues - npm.io page: https://npm.io/package/osrm ## Dependencies (5) - [nan](https://npm.io/package/nan.md) ^2.14.2 - [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.5 - [rimraf](https://npm.io/package/rimraf.md) ^2.7.1 - [node-cmake](https://npm.io/package/node-cmake.md) ^2.5.1 - [@mapbox/node-pre-gyp](https://npm.io/package/@mapbox/node-pre-gyp.md) ^1.0.1 ## Recent versions - 5.26.0 (latest) — 2021-09-21 - 5.25.0-rc.2 (next) — 2021-05-17 - 5.22.0-customsnapping.3 (test) — 2019-02-16 - 5.20.0-alpha.2 (beta) — 2018-09-11 - 5.15.3 (patch) — 2018-02-24 - 5.5.0-rc.1 (latest-rc) — 2016-11-09 - 5.25.0 — 2021-05-17 - 5.24.0 — 2021-01-28 - 5.23.0 — 2020-10-14 - 5.23.0-rc.2 — 2020-10-09 - 5.23.0-rc.1 — 2020-10-08 - 5.21.0-customsnapping.11 — 2019-02-10 - 5.21.0-customsnapping.9 — 2019-02-10 - 5.21.0-customsnapping.8 — 2019-02-10 - 5.21.0-customsnapping.6 — 2019-02-09 - … 169 more at https://npm.io/package/osrm/versions ## README ## Open Source Routing Machine | Linux / macOS | Windows | Code Coverage | | ------------- | ------- | ------------- | | [![Travis](https://travis-ci.org/Project-OSRM/osrm-backend.png?branch=master)](https://travis-ci.org/Project-OSRM/osrm-backend) | [![AppVeyor](https://ci.appveyor.com/api/projects/status/4iuo3s9gxprmcjjh)](https://ci.appveyor.com/project/DennisOSRM/osrm-backend) | [![Codecov](https://codecov.io/gh/Project-OSRM/osrm-backend/branch/master/graph/badge.svg)](https://codecov.io/gh/Project-OSRM/osrm-backend) | High performance routing engine written in C++14 designed to run on OpenStreetMap data. The following services are available via HTTP API, C++ library interface and NodeJs wrapper: - Nearest - Snaps coordinates to the street network and returns the nearest matches - Route - Finds the fastest route between coordinates - Table - Computes the duration or distances of the fastest route between all pairs of supplied coordinates - Match - Snaps noisy GPS traces to the road network in the most plausible way - Trip - Solves the Traveling Salesman Problem using a greedy heuristic - Tile - Generates Mapbox Vector Tiles with internal routing metadata To quickly try OSRM use our [demo server](http://map.project-osrm.org) which comes with both the backend and a frontend on top. For a quick introduction about how the road network is represented in OpenStreetMap and how to map specific road network features have a look at [this guide about mapping for navigation](https://www.mapbox.com/mapping/mapping-for-navigation/). Related [Project-OSRM](https://github.com/Project-OSRM) repositories: - [osrm-frontend](https://github.com/Project-OSRM/osrm-frontend) - User-facing frontend with map. The demo server runs this on top of the backend - [osrm-text-instructions](https://github.com/Project-OSRM/osrm-text-instructions) - Text instructions from OSRM route response - [osrm-backend-docker](https://hub.docker.com/r/osrm/osrm-backend/) - Ready to use Docker images ## Documentation ### Full documentation - [Hosted documentation](http://project-osrm.org) - [osrm-routed HTTP API documentation](docs/http.md) - [libosrm API documentation](docs/libosrm.md) ## Contact - IRC: `irc.oftc.net`, channel: `#osrm` ([Webchat](https://webchat.oftc.net)) - Mailinglist: `https://lists.openstreetmap.org/listinfo/osrm-talk` ## Quick Start The easiest and quickest way to setup your own routing engine is to use Docker images we provide. There are two pre-processing pipelines available: - Contraction Hierarchies (CH) - Multi-Level Dijkstra (MLD) we recommend using MLD by default except for special use-cases such as very large distance matrices where CH is still a better fit for the time being. In the following we explain the MLD pipeline. If you want to use the CH pipeline instead replace `osrm-partition` and `osrm-customize` with a single `osrm-contract` and change the algorithm option for `osrm-routed` to `--algorithm ch`. ### Using Docker We base our Docker images ([backend](https://hub.docker.com/r/osrm/osrm-backend/), [frontend](https://hub.docker.com/r/osrm/osrm-frontend/)) on Debian and make sure they are as lightweight as possible. Download OpenStreetMap extracts for example from [Geofabrik](http://download.geofabrik.de/) wget http://download.geofabrik.de/europe/germany/berlin-latest.osm.pbf Pre-process the extract with the car profile and start a routing engine HTTP server on port 5000 docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-extract -p /opt/car.lua /data/berlin-latest.osm.pbf The flag `-v "${PWD}:/data"` creates the directory `/data` inside the docker container and makes the current working directory `"${PWD}"` available there. The file `/data/berlin-latest.osm.pbf` inside the container is referring to `"${PWD}/berlin-latest.osm.pbf"` on the host. docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-partition /data/berlin-latest.osrm docker run -t -v "${PWD}:/data" osrm/osrm-backend osrm-customize /data/berlin-latest.osrm Note that `berlin-latest.osrm` has a different file extension. docker run -t -i -p 5000:5000 -v "${PWD}:/data" osrm/osrm-backend osrm-routed --algorithm mld /data/berlin-latest.osrm Make requests against the HTTP server curl "http://127.0.0.1:5000/route/v1/driving/13.388860,52.517037;13.385983,52.496891?steps=true" Optionally start a user-friendly frontend on port 9966, and open it up in your browser docker run -p 9966:9966 osrm/osrm-frontend xdg-open 'http://127.0.0.1:9966' 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 After adding yourself to the `docker` group make sure to log out and back in again with your terminal. We support the following images on Docker Cloud: Name | Description -----|------ `latest` | `master` compiled with release flag `latest-assertions` | `master` compiled with with release flag, assertions enabled and debug symbols `latest-debug` | `master` compiled with debug flag `` | specific tag compiled with release flag `-debug` | specific tag compiled with debug flag ### Building from Source The following targets Ubuntu 16.04. For instructions how to build on different distributions, macOS or Windows see our [Wiki](https://github.com/Project-OSRM/osrm-backend/wiki). Install dependencies ```bash sudo apt install build-essential git cmake pkg-config \ libbz2-dev libxml2-dev libzip-dev libboost-all-dev \ lua5.2 liblua5.2-dev libtbb-dev ``` Compile and install OSRM binaries ```bash mkdir -p build cd build cmake .. cmake --build . sudo cmake --build . --target install ``` ### Request Against the Demo Server Read the [API usage policy](https://github.com/Project-OSRM/osrm-backend/wiki/Demo-server). Simple query with instructions and alternatives on Berlin: ``` curl "https://router.project-osrm.org/route/v1/driving/13.388860,52.517037;13.385983,52.496891?steps=true&alternatives=true" ``` ### Using the Node.js Bindings The Node.js bindings provide read-only access to the routing engine. We provide API documentation and examples [here](docs/nodejs/api.md). You will need a modern `libstdc++` toolchain (`>= GLIBCXX_3.4.20`) for binary compatibility if you want to use the pre-built binaries. For older Ubuntu systems you can upgrade your standard library for example with: ``` sudo add-apt-repository ppa:ubuntu-toolchain-r/test sudo apt-get update -y sudo apt-get install -y libstdc++-5-dev ``` You can install the Node.js bindings via `npm install osrm` or from this repository either via npm install which will check and use pre-built binaries if they're available for this release and your Node version, or via npm install --build-from-source to always force building the Node.js bindings from source. For usage details have a look [these API docs](docs/nodejs/api.md). An exemplary implementation by a 3rd party with Docker and Node.js can be found [here](https://github.com/door2door-io/osrm-express-server-demo). ## References in publications When using the code in a (scientific) publication, please cite ``` @inproceedings{luxen-vetter-2011, author = {Luxen, Dennis and Vetter, Christian}, title = {Real-time routing with OpenStreetMap data}, booktitle = {Proceedings of the 19th ACM SIGSPATIAL International Conference on Advances in Geographic Information Systems}, series = {GIS '11}, year = {2011}, isbn = {978-1-4503-1031-4}, location = {Chicago, Illinois}, pages = {513--516}, numpages = {4}, url = {http://doi.acm.org/10.1145/2093973.2094062}, doi = {10.1145/2093973.2094062}, acmid = {2094062}, publisher = {ACM}, address = {New York, NY, USA}, } ``` --- _Source: https://npm.io/package/osrm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._