Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add recommended setup method #1585

Merged
merged 6 commits into from
Oct 27, 2023
Merged

docs: add recommended setup method #1585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e29ea9a
docs: add recommended setup method
MichaelsJP Oct 27, 2023
530f414
Update docs/installation/Running-with-Docker.md
MichaelsJP Oct 27, 2023
7af495a
Update docs/installation/Running-with-Docker.md
MichaelsJP Oct 27, 2023
2cfb7d7
Update README.md
MichaelsJP Oct 27, 2023
fc57f9b
Update README.md
MichaelsJP Oct 27, 2023
1500d2c
Update README.md
MichaelsJP Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
17 changes: 9 additions & 8 deletions docs/installation/Running-with-Docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down