Skip to content

README.md

Latest commit

 

History

History
29 lines (18 loc) · 1.84 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.84 KB

priobike-overpass

We use this repository to build our own Overpass image. It is configurable, what OSM file is used. Through this, it is possible for our PrioBike project, to build separate images for both map data foundations (OSM and OSM-DRN).

This service is built in such a way that it takes the OSM file from an existing image. Therefore, we need an image where a ready-to-use OSM file is stored. In our projekt, we use the GraphHopper images for this purpose.

Learn more about PrioBike

Quickstart

Run using Docker:

docker build -t priobike-overpass . && docker run -p 80:80 --rm priobike-overpass

Via the following build arguments, the build can be configured:

  • BASE_IMAGE: Which image should be used as a base image. In the image has to be an OSM file.
  • OSM_FILE_PATH: Where is the OSM file located in the base image.
  • OVERPASS_PLANET_PREPROCESS: What commands should be executed as a preprocessing step. Depending on the format of the OSM file it may need to be converted to be used by Overpass. More information about this can be found in the Overpass documentation. You might also want to take a look at the .github/workflows files to find out how we build our images.

Contributing

We highly encourage you to open an issue or a pull request. You can also use our repository freely with the MIT license.

Every service runs through testing before it is deployed in our release setup. Read more in our PrioBike deployment readme to understand how specific branches/tags are deployed.

Anything unclear?

Help us improve this documentation. If you have any problems or unclarities, feel free to open an issue.