From ed1bd0cc2488c319c2beda07cd7b69441fc535c5 Mon Sep 17 00:00:00 2001 From: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Date: Fri, 19 Feb 2021 10:29:26 +0100 Subject: [PATCH] making 'using the correction version of setup.sh' even clearer --- README.md | 8 +++++--- setup.sh | 13 +++++++++++++ 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d8e1a05..cef7d02e 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/maste wget https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/master/mailserver.env ``` -and the `setup.sh` +and the `setup.sh` **in the correct version** ``` BASH # if you're using :edge as the image tag @@ -96,7 +96,7 @@ 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. +**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 can done with the "Switch branches/tags" button on GitHub, choosing the right tag. This is done in order to rule out possible inconsistencies between versions. ### Create a docker-compose environment @@ -128,7 +128,9 @@ docker-compose up -d mail ./setup.sh -Z config dkim ``` -If you are using a LDAP setup the setup looks a bit different as you do not add user accounts directly. Postfix doesn't know your domain(s) and you need to provide it when configuring DKIM: +If you're seeing error messages about unchecked error, please **verify that you're using the right version of `setup.sh`**. Refer to the [Get the tools](#get-the-tools) section. + +If you are using a LDAP, the setup looks a bit different as you do not add user accounts directly. Postfix doesn't know your domain(s) and you need to provide it when configuring DKIM: ``` BASH ./setup.sh config dkim domain '[,]' diff --git a/setup.sh b/setup.sh index e37c4a96..e145b42b 100755 --- a/setup.sh +++ b/setup.sh @@ -17,6 +17,10 @@ function __log_err " – function = ${1} / ${2}" \ " – line = ${3}" \ " – exit code = ${4}" >&2 + + printf "Make sure you use a version of this script that matches +the version / tag of docker-mailserver. Please read the +'Get the tools' section in the README on GitHub carefully.\n" >&2 } function _unset_vars @@ -122,6 +126,15 @@ function _usage its arguments by appending \e[37mhelp\e[39m after your command. Currently, this does not work with all scripts. +\e[38;5;214mVERSION\e[39m + The current version of this script is backwards compatible with versions of + \e[37mdocker-mailserver\e[39m \e[1mafter\e[0m \e[34m8.0.1\e[0m. In case that there is not a more recent release, + this script is currently only working with the \e[37m:edge\e[0m tag. + + You can download the script for your release by substituting TAG from the + following URL, where TAG looks like 'vX.X.X': + https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/TAG/setup.sh + \e[38;5;214mOPTIONS\e[39m \e[94mConfig path, container or image adjustments\e[39m -i IMAGE_NAME