Skip to content
This repository was archived by the owner on Feb 12, 2026. It is now read-only.

Commit e0a15c8

Browse files
fix: minor formating fixes (nilsnolde#170)
1 parent a7c8383 commit e0a15c8

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ A hyper-flexible Docker image for the excellent [Valhalla](https://github.com/va
99
mkdir custom_files
1010
wget -O custom_files/andorra-latest.osm.pbf https://download.geofabrik.de/europe/andorra-latest.osm.pbf
1111
docker run -dt --name valhalla_gis-ops -p 8002:8002 -v $PWD/custom_files:/custom_files ghcr.io/gis-ops/docker-valhalla/valhalla:latest
12+
1213
# or let the container download the file for you
1314
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/gis-ops/docker-valhalla/valhalla:latest
1415
```
@@ -22,18 +23,21 @@ This image aims at being user-friendly and most efficient with your time and res
2223
- Load and build from **multiple URLs** pointing to valid pbf files.
2324
- Load local data through volume mapping.
2425
- **Supports auto rebuild** on OSM file changes through hash mapping.
25-
- **new**: supports advanced user management to avoid sudo access to host-shared folders and files, see [notes on user management](#notes-on-user-management)
26+
- **new**: supports advanced user management to avoid sudo access to host-shared folders and files, see [notes on user management](#notes-on-user-management)
2627

2728
## Dockerhub/Github Packages
2829

29-
**NOTE**, with the recent (17.03.2023) announcement of Docker to remove free "teams" (even those providing FOSS like us), we moved our images to Github packages. If it's not on Github you'll find an image version still on Dockerhub.
30+
> [!NOTE]
31+
> With the recent (17.03.2023) announcement of Docker to remove free "teams" (even those providing FOSS like us), we moved our images to Github packages.
32+
> If it's not on Github you'll find an image version still on Dockerhub.
3033
3134
Our [package registry](https://github.com/gis-ops/docker-valhalla/pkgs/container/docker-valhalla%2Fvalhalla) provides the following:
3235

3336
- stable release tags (e.g. 3.0.9)
3437
- `latest`, updated from Valhalla Github repository every Saturday morning
3538

36-
> Note, you might have to do a [`docker login`](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-docker-registry#authenticating-to-github-packages) before.
39+
> [!NOTE]
40+
> You might have to do a [`docker login`](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-docker-registry#authenticating-to-github-packages) before.
3741
3842
## Build the image
3943

@@ -42,7 +46,9 @@ If you want to build the image yourself, be aware that you might need to adapt t
4246
- `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.
4347
- `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.
4448

45-
**Note**, before Valhalla version `3.1.0` the building scheme was completely different. Please contact enquiry@gis-ops.com if you need access to previous Valhalla versions via Docker.
49+
> [!NOTE]
50+
> before Valhalla version `3.1.0` the building scheme was completely different.
51+
> Please contact enquiry@gis-ops.com if you need access to previous Valhalla versions via Docker.
4652
4753
Then it's a simple
4854

@@ -62,7 +68,7 @@ This image respects the following custom environment variables to be passed duri
6268
- `build_time_zones`: `True` builds the timezone db which is needed for time-dependent routing. `Force` will do the same, but first delete the existing db. Default `False`.
6369
- `build_transit`: `True` will attempt to build transit tiles if none exist yet. `Force` will remove existing transit **and** routing tiles. Default `False`.
6470
- `build_tar` (since 29.10.2021/v`3.1.5`): `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. Default `True`.
65-
- `server_threads`: How many threads `valhalla_build_tiles` will use and `valhalla_service` will run with. Default is the value of `nproc`. If valhalla kills it self when building tiles, lower this number.
71+
- `server_threads`: How many threads `valhalla_build_tiles` will use and `valhalla_service` will run with. Default is the value of `nproc`. If valhalla kills itself when building tiles, lower this number.
6672
- `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. Can be very useful in certain deployment scenarios. No leading/trailing path separator allowed. Default is ''.
6773
- `serve_tiles`: `True` starts the valhalla service. Default `True`.
6874
- `tileset_name`: The name of the resulting graph on disk. Very useful in case you want to build multiple datasets in the same directory. Default `valhalla_tiles`.
@@ -85,7 +91,8 @@ The important part here is, that you map a volume from your host machine to the
8591

8692
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.
8793

88-
> 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.
94+
> [!NOTE]
95+
> 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.
8996
9097
#### Build Valhalla with transit
9198

@@ -139,12 +146,15 @@ In the case where you have a pre-built `valhalla_tiles.tar` package from another
139146

140147
## Tests
141148

142-
If you want to verify that the image is working correctly, there's a small test script in `./tests`. **Note**, it might require `sudo`, since it touches a few things generated by the container's `valhalla` user:
149+
If you want to verify that the image is working correctly, there's a small test script in `./tests`.
143150

144151
```shell script
145152
./tests/test.sh
146153
```
147154

155+
> [!TIP]
156+
> It might require `sudo`, since it touches a few things generated by the container's `valhalla` user
157+
148158
## Acknowledgements
149159

150160
This project was first introduced by [MichaelsJP](https://github.com/MichaelsJP).

0 commit comments

Comments
 (0)