Warning
This repository has been archived. The code moved to upstream, see https://github.com/valhalla/valhalla/docker/README.md. However, do note, some things changed:
do_admins
& do_timezones
& use_default_speeds_config
default to "True"
instead of "False"
VALHALLA_UID
& VALHALLA_GID
A hyper-flexible Docker image for the excellent Valhalla routing framework.
# download a file to custom_files and start valhalla mkdir custom_files wget -O custom_files/andorra-latest.osm.pbf https://download.geofabrik.de/europe/andorra-latest.osm.pbf docker run -dt --name valhalla_gis-ops -p 8002:8002 -v $PWD/custom_files:/custom_files ghcr.io/nilsnolde/docker-valhalla/valhalla:latest # or let the container download the file for you docker run -dt --name valhalla_gis-ops -p 8002:8002 -v $PWD/custom_files:/custom_files -e tile_urls=https://download.geofabrik.de/europe/andorra-latest.osm.pbf ghcr.io/nilsnolde/docker-valhalla/valhalla:latest
This image aims at being user-friendly and most efficient with your time and resources. Once built, you can easily change Valhalla's configuration, the underlying OSM data graphs are built from, accompanying data (like Admin Areas, elevation tiles) or even pre-built graph tiles. Upon docker restart <container>
those changes are taken into account via hashed files, and, if necessary, new graph tiles will be built automatically.
Our package registry provides the following:
latest
, updated from Valhalla Github repository every Saturday morningIf you want to build the image yourself, be aware that you might need to adapt the base image in the Dockerfile
to reflect the version of Valhalla you'd like to build. You can find the tags of the ghcr.io/valhalla/valhalla
images here: https://github.com/valhalla/valhalla/pkgs/container/valhalla. On top of the Valhalla base image we support the following build arguments (see notes on user management):
VALHALLA_UID
: specify the user UID for the container-internal valhalla
user. Either leave this blank or, most usually, specify your current user's UID.VALHALLA_GID
: specify the group GID for the container-internal valhalla
user. Either leave this blank or, most usually, specify the group's GID whose members you want to have write access to the container-generated files.Note
before Valhalla version 3.1.0
the building scheme was completely different.
Then it's a simple
docker build -t ghcr.io/nilsnolde/docker-valhalla/valhalla:latest .
This image respects the following custom environment variables to be passed during container startup:
Environment Variable Default Descriptiontile_urls
Add as many (space-separated) URLs as you like, e.g. https://download.geofabrik.de/europe/andorra-latest.osm.pbf use_tiles_ignore_pbf
True
True
uses a local tile.tar file and skips building. force_rebuild
False
True
forces a rebuild of the routing tiles and sets build_tar
to Force
. build_elevation
False
True
downloads elevation tiles which are covering the routing graph.
Force
will do the same, but first delete any existing elevation tiles. build_admins
False
True
builds the admin db needed for things like border-crossing penalties and detailed routing responses.
Force
will do the same, but first delete the existing db. build_time_zones
False
True
builds the timezone db which is needed for time-dependent routing.
Force
will do the same, but first delete the existing db. build_transit
False
True
will attempt to build transit tiles if none exist yet.
Force
will remove existing transit and routing tiles. build_tar
(since 29.10.2021/v3.1.5
) True
True
creates a tarball of the tiles including an index which allows for extremely faster graph loading after reboots.
Force
will do the same, but first delete the existing tarball. server_threads
value of nproc
How many threads valhalla_build_tiles
will use and valhalla_service
will run with.
path_extension
''
This path will be appended to the container-internal /custom_files
(and by extension to the docker volume mapped to that path) and will be the directory where all files will be created.
serve_tiles
True
True
starts the valhalla service. tileset_name
valhalla_tiles
The name of the resulting graph on disk.
traffic_name
traffic.tar
The name of the traffic.tar
.
""
) will cause no traffic archive to be built.
update_existing_config
True
True
updates missing keys in existing valhalla.json
.
use_default_speeds_config
False
True
loads a JSON file used to enhance default speeds (or falls back to an existing custom_files/default_speeds.json
) and sets the respective config entry. Read more here. default_speeds_config_url
this url Remote location of the default_speeds_config
JSON.
For the following instructions to work, you'll need to have the image locally available already, either from Github Docker registry or from local.
Start a background container from that image:
docker run -dt -v $PWD/custom_files:/custom_files -p 8002:8002 --name valhalla ghcr.io/nilsnolde/docker-valhalla/valhalla:latest
The important part here is, that you map a volume from your host machine to the container's /custom_files
. The container will dump all relevant Valhalla files to that directory.
At this point Valhalla is running, but there is no graph tiles yet. Follow the steps below to customize your Valhalla instance in a heartbeat.
Note
Alternatively you could create custom_files
on your host before starting the container with all necessary files you want to be respected, e.g. the OSM PBF files.
Valhalla supports reading raw GTFS feeds to build transit into its graph, see the docs for more details.
Put the unzipped GTFS feeds as subfolders in the main gtfs folder, e.g. gtfs_feeds/berlin/
, otherwise the files will not be found.
To enable multimodal
routing, you'll need to map the directory which contains all the GTFS feeds to the container's /gtfs_feeds
directory, e.g.
docker run -dt -v gtfs_feeds:/gtfs_feeds -v $PWD/custom_files:/custom_files -p 8002:8002 --name valhalla nilsnolde/docker-valhalla:latest
Build Valhalla with arbitrary OSM data
Just dump single or multiple OSM PBF files to your mapped custom_files
directory, restart the container and Valhalla will start building the graphs:
cd custom_files # Download Andorra & Faroe Islands wget http://download.geofabrik.de/europe/faroe-islands-latest.osm.pbf http://download.geofabrik.de/europe/andorra-latest.osm.pbf docker restart valhalla
If you change the PBF files by either adding new ones or deleting any, Valhalla will build new tiles on the next restart unless told not to (e.g. setting use_tiles_ignore_pbf=True
).
Elevation tiles need to be in HGT (file format of the SRTM dataset) format and need to be named like NXXEYYY.hgt
. More info about format.
You need to store elevation tiles in the <base_path>/elevation_data
directory (by default custom_files/elevation_data/
). Tiles need to be grouped in folders by latitude , for example:
custom_files/elevation_data/
N53/
N53E016.hgt
N53E017.hgt
N54/
N54E016.hgt
If you had an existing graph before you acquired new elevation data, you'll need to rebuild the graph for the new data to become available, e.g. by starting a new container with force_rebuild=True. If you want to use new elevation data for Elevation API, you just need to restart container.
Customize Valhalla configurationIf you need to customize Valhalla's configuration to e.g. increase the allowed maximum distance for the /route
POST endpoint, just edit custom_files/valhalla.json
and restart the container. It won't rebuild the tiles in this case, unless you tell it to do so via environment variables.
In the case where you have a pre-built valhalla_tiles.tar
package from another Valhalla instance, you can also dump that to /custom_files/
and they're loaded upon container restart if you set the following environment variables: use_tiles_ignore_pbf=True
, force_rebuild=False
. Also, don't forget to set the md5 sum for your valhalla_tiles.tar
in .file_hashes.txt
.
If you want to verify that the image is working correctly, there's a small test script in ./tests
.
Tip
It might require sudo
, since it touches a few things generated by the container's valhalla
user
This project was first introduced by MichaelsJP.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4