From 0ebb54016d8cd1c45a8e3b0338e7aad4aa192a03 Mon Sep 17 00:00:00 2001 From: Georg Lauterbach <44545919+aendeavor@users.noreply.github.com> Date: Mon, 31 May 2021 09:04:02 +0200 Subject: [PATCH] remove :stable and other deprecated stuff --- README.md | 19 +++++++++---------- setup.sh | 2 -- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6ff055f9..7a59af1f 100644 --- a/README.md +++ b/README.md @@ -60,20 +60,19 @@ If you have issues, read the full `README` **and** the [documentation][documenta ## Usage -### Available image sources / tags +### Available Images / Tags - Tagging Convention [CI/CD](https://github.com/docker-mailserver/docker-mailserver/actions) will automatically build, test and push new images to container registries. Currently, the following registries are supported: - [DockerHub](https://hub.docker.com/repository/docker/mailserver/docker-mailserver) - [GitHub Container Registry](https://github.com/orgs/docker-mailserver/packages?repo_name=docker-mailserver) -All workflows are using the **tagging convention** listed below. It is subsequently applied to all images pushed to supported container registries: +All workflows are using the tagging convention listed below. It is subsequently applied to all images. -| Event | Ref | Commit SHA | Image Tags | -|--------------|-----------------------|------------|-------------------------------| -| `push` | `refs/heads/master` | `cf20257` | `edge` | -| `push` | `refs/heads/stable` | `cf20257` | `stable` | -| `push tag` | `refs/tags/[v]1.2.3` | `ad132f5` | `1.2.3`, `1.2`, `1`, `latest` | +| Event | Ref | Image Tags | +|--------------|-----------------------|-------------------------------| +| `push` | `refs/heads/master` | `edge` | +| `push tag` | `refs/tags/[v]1.2.3` | `1.2.3`, `1.2`, `1`, `latest` | ### Get the tools @@ -108,7 +107,7 @@ chmod a+x ./setup.sh - if you want to use SELinux for the `./config/:/tmp/docker-mailserver/` mount, append `-z` or `-Z` 3. Configure the mailserver container to your liking by editing `mailserver.env` ([**Documentation**](https://docker-mailserver.github.io/docker-mailserver/edge/config/environment/)) - this file supports [_only_ simple `VAR=VAL`](https://docs.docker.com/compose/env-file/) (**don't** quote your values) - - variable substitution is **not** supported (e.g. :no_entry_sign:`OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME` :no_entry_sign:) + - variable substitution is **not** supported (e.g. :no_entry_sign: `OVERRIDE_HOSTNAME=$HOSTNAME.$DOMAINNAME` :no_entry_sign:) ### Get up and running @@ -121,7 +120,7 @@ docker-compose up -d mailserver ./setup.sh [-Z] config 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 and / or execute `./setup.sh help` and read the `VERSION` section. +If you're seeing error messages about unchecked errors, please **verify that you're using the right version of `setup.sh`**. Refer to the [Get the tools](#get-the-tools) section and / or execute `./setup.sh help` and read the `VERSION` section. In case you're using 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: @@ -137,7 +136,7 @@ If you want to see detailed usage information, run `./setup.sh config dkim help` When keys are generated, you can configure your DNS server by just pasting the content of `config/opendkim/keys/domain.tld/mail.txt` to [set up DKIM](https://mxtoolbox.com/dmarc/dkim/setup/how-to-setup-dkim). See the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/best-practices/dkim/) for more details. -#### Custom user changes & patches +#### Custom User Changes & Patches If you'd like to change, patch or alter files or behavior of `docker-mailserver`, you can use a script. See the [documentation](https://docker-mailserver.github.io/docker-mailserver/edge/config/advanced/override-defaults/user-patches/) for a detailed explanation. diff --git a/setup.sh b/setup.sh index 85d62a5c..f988032a 100755 --- a/setup.sh +++ b/setup.sh @@ -180,7 +180,6 @@ ${RED}[${ORANGE}SUB${RED}]${ORANGE}COMMANDS${RESET} ${LBLUE}COMMAND${RESET} config ${RED}:=${RESET} ${0} config dkim [ ARGUMENTS${RED}...${RESET} ] - ${0} config ssl (${CYAN}ATTENTION${RESET}: This is deprecated and will be removed soon.) ${LBLUE}COMMAND${RESET} relay ${RED}:=${RESET} ${0} relay add-domain [] @@ -370,7 +369,6 @@ function _main config ) case ${2:-} in dkim ) shift 2 ; _docker_image open-dkim "${@}" ;; - ssl ) shift 2 ; _docker_image generate-ssl-certificate "${1}" ;; * ) _usage ;; esac ;;