diff --git a/README.md b/README.md index 27376684bd..42944e9a53 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,23 @@ The [sourcespy dashboard](https://sourcespy.com/github/giscienceopenrouteservice ## Installation -We suggest using docker to install and launch openrouteservice backend. In short, on a machine with a working [docker installation](https://www.digitalocean.com/community/tutorial_collections/how-to-install-and-use-docker) running the following commands will get everything done. +We suggest using docker to install and launch openrouteservice backend. In short, a machine with a working [docker installation](https://www.digitalocean.com/community/tutorial_collections/how-to-install-and-use-docker) will get everything done for you. + +Only use nightly (master branch) if you know what you do. We recommend running docker compose with the latest release version: ```bash -wget https://raw.githubusercontent.com/GIScience/openrouteservice/master/docker-compose.yml +# For example for the latest release +git clone https://github.com/GIScience/openrouteservice.git +cd openrouteservice +# Checkout latest version +export LATEST_ORS_RELEASE=$(git describe --tags --abbrev=0); +git checkout $LATEST_ORS_RELEASE +# If the docker folder exists cd into it +cd docker || echo "No docker folder found. Continue with next step." +# Now change the version the docker-compose.yml uses +sed -i='' "s/openrouteservice\/openrouteservice:nightly/openrouteservice\/openrouteservice:$LATEST_ORS_RELEASE/g" docker-compose.yml +sed -i='' "s/openrouteservice\/openrouteservice:latest/openrouteservice\/openrouteservice:$LATEST_ORS_RELEASE/g" docker-compose.yml +# Run docker compose with docker compose up -d ``` diff --git a/docs/installation/Running-with-Docker.md b/docs/installation/Running-with-Docker.md index a9310ebecd..c59b570acc 100644 --- a/docs/installation/Running-with-Docker.md +++ b/docs/installation/Running-with-Docker.md @@ -17,15 +17,8 @@ Use [Dockerhub's hosted Openrouteservice image](https://hub.docker.com/r/openrou There are multiple ways with docker to quickly have a running instance. -1. Run with `docker compose` for nightly -```bash -# For nightly builds -wget https://raw.githubusercontent.com/GIScience/openrouteservice/master/docker-compose.yml -docker compose up -d -``` - -2. Run with `docker compose` for a specific ors version +1. Recommended: Run a specific ors version using `docker compose` ```bash # For example for the latest release @@ -43,6 +36,14 @@ sed -i='' "s/openrouteservice\/openrouteservice:latest/openrouteservice\/openrou docker compose up -d ``` +2. Run nightly using `docker compose` + +```bash +# For nightly builds +wget https://raw.githubusercontent.com/GIScience/openrouteservice/master/docker-compose.yml +docker compose up -d +``` + 3. `docker run` for ors versions >= 6.8.2 ```bash