https://github.com/vroom-project/vroom-docker
Docker image for vroom and vroom-express
https://github.com/vroom-project/vroom-docker
Last synced: 8 months ago
JSON representation
Docker image for vroom and vroom-express
- Host: GitHub
- URL: https://github.com/vroom-project/vroom-docker
- Owner: VROOM-Project
- License: bsd-2-clause
- Created: 2020-03-10T09:42:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T15:53:11.000Z (over 1 year ago)
- Last Synced: 2025-03-29T00:06:53.602Z (about 1 year ago)
- Language: Shell
- Size: 52.7 KB
- Stars: 92
- Watchers: 6
- Forks: 61
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# VROOM Docker image
[](https://github.com/VROOM-Project/vroom-docker/actions/workflows/master_push.yml)
**Note**, this repo is migrating to Github's container registry, releases from v1.14.0 on will not be published at hub.docker.com.
This image includes all dependencies and projects needed to successfully run an instance of [`vroom-express`](https://github.com/VROOM-Project/vroom-express) on top of [`vroom`](https://github.com/VROOM-Project/vroom). Within 2 minutes you'll have a routing optimization engine running on your machine.
```bash
docker run -dt --name vroom \
--net host \ # or set the container name as host in config.yml and use --port 3000:3000 instead, see below
-v $PWD/conf:/conf \ # mapped volume for config & log
-e VROOM_ROUTER=osrm \ # routing layer: osrm, valhalla or ors
ghcr.io/vroom-project/vroom-docker:v1.14.0
```
If you want to build the image yourself, run a
`docker build -t ghcr.io/vroom-project/vroom-docker:v1.14.0 --build-arg VROOM_RELEASE=v1.14.0 --build-arg VROOM_EXPRESS_RELEASE=v0.12.0 .`
> **Note**, you should have access to a self-hosted instance of OSRM, Valhalla or OpenRouteService for the routing server.
## Tagging
The tagging scheme follows the release convention of `vroom` core.
## Customization
### Environment variables
- `VROOM_ROUTER`: specifies the routing engine to be used, `osrm`, `valhalla` or `ors`. Default `osrm`.
The pre-configured host for the routing servers is `localhost` and `port: 8080` for ORS, `port: 5000` for OSRM and `port: 8002` for Valhalla.
> **Note**, the environment variable `VROOM_ROUTER` has precedence over the `router` setting in `config.yml`.
### Volume mounting
All relevant files are located inside the container's `/conf` directory and can be shared with the host. These include:
- `access.log`: the server log for `vroom-express`
- `config.yml`: the server configuration file, which gives you full control over the `vroom-express` configuration. If you need to edit the configuration, run `docker restart vroom` to restart the server with the new settings.
Add a `-v $PWD/vroom-conf:/conf` to your `docker run` command.
### Build arguments
If you prefer to build the image from source, there are 2 build arguments:
- `VROOM_RELEASE`: specifies VROOM's git [branch](https://github.com/VROOM-Project/vroom/branches), [commit hash](https://github.com/VROOM-Project/vroom/commits/master) or [release](https://github.com/VROOM-Project/vroom/releases) (e.g. `v1.14.0`) to install in the container
- `VROOM_EXPRESS_RELEASE`: specifies `vroom-express`'s git [branch](https://github.com/VROOM-Project/vroom-express/branches), [commit hash](https://github.com/VROOM-Project/vroom-express/commits/master) or [release](https://github.com/VROOM-Project/vroom-express/releases) (e.g. `v0.12.0`) to install in the container
> **Note**, not all versions are compatible with each other
## Routing Server
You have the option to use [OSRM](https://github.com/Project-OSRM/osrm-backend), [Valhalla](https://github.com/valhalla/valhalla) or [OpenRouteService](https://github.com/GIScience/openrouteservice). However, the proper setup in Docker or `docker-compose` depends on how you run the routing server.
### Routing server in local Docker container
If you started the routing layer in a separate Docker container via `docker run` and didn't create a docker network, you'll have to start the `vroom` container on the `host` network by adding `--net host`. The disadvantage is that you'll have to assign `vroom-express` configured `port` on the host machine. If port 3000 is already occupied on your machine, configure a different port in `config.yml`.
Alternatively you can add both containers to a private Docker network and change the routing server host(s) to the routing server container name(s) in `config.yml` before restarting the `vroom` container. However, the concepts involved are beyond the scope of this project.
### Routing server on a remote server
In this case, you'll have to edit the mapped `config.yml` to include the host and port you published the routing server on.