From d221c585c2adf9e08da72c440d21d0eb1b96bb00 Mon Sep 17 00:00:00 2001 From: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Date: Thu, 18 Feb 2021 14:00:51 +0100 Subject: [PATCH] inform about proper `setup.sh` usage between versions --- README.md | 16 +++++++++++++--- test/tests.bats | 4 ++-- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cabb7864..7d8e1a05 100644 --- a/README.md +++ b/README.md @@ -74,13 +74,21 @@ All workflows are using the **tagging convention** listed below. It is subsequen ### Get the tools -Download the `docker-compose.yml`, `compose.env`, `mailserver.env` and the `setup.sh` files: +Download `docker-compose.yml`, `compose.env`, `mailserver.env` ``` BASH -wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/setup.sh +wget -O .env https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/compose.env wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/docker-compose.yml wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/mailserver.env -wget -O .env https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/compose.env +``` + +and the `setup.sh` + +``` BASH +# if you're using :edge as the image tag +wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/setup.sh +# if you're using :latest (= :8.0.1) as the image tag +wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/v8.0.1/setup.sh chmod a+x ./setup.sh @@ -88,6 +96,8 @@ chmod a+x ./setup.sh ./setup.sh help ``` +**Make sure to get the `setup.sh` that comes with the release you're using**. Look up the release and the git commit on which this release is based upon by selecting the appropriate tag on GitHub. This is done to rule out possible inconsistencies between versions. + ### Create a docker-compose environment - [Install the latest docker-compose](https://docs.docker.com/compose/install/) diff --git a/test/tests.bats b/test/tests.bats index be8d388f..65ff18d7 100644 --- a/test/tests.bats +++ b/test/tests.bats @@ -1127,10 +1127,10 @@ EOF assert_failure } -@test "checking setup.sh: setup.sh config dkim help" { +@test "setup.sh :: setup.sh config dkim help correctly displayed" { run ./setup.sh -c mail config dkim help assert_success - assert_line --index 2 " open-dkim - configure DomainKeys Identified Mail (DKIM)" + assert_line --index 3 " open-dkim - configure DomainKeys Identified Mail (DKIM)" } # debug