mirror of
https://github.com/docker-mailserver/docker-mailserver.git
synced 2024-01-19 02:48:50 +00:00
remove :stable and other deprecated stuff
This commit is contained in:
parent
264639774c
commit
0ebb54016d
19
README.md
19
README.md
|
@ -60,20 +60,19 @@ If you have issues, read the full `README` **and** the [documentation][documenta
|
||||||
|
|
||||||
## Usage
|
## 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:
|
[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)
|
- [DockerHub](https://hub.docker.com/repository/docker/mailserver/docker-mailserver)
|
||||||
- [GitHub Container Registry](https://github.com/orgs/docker-mailserver/packages?repo_name=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 |
|
| Event | Ref | Image Tags |
|
||||||
|--------------|-----------------------|------------|-------------------------------|
|
|--------------|-----------------------|-------------------------------|
|
||||||
| `push` | `refs/heads/master` | `cf20257` | `edge` |
|
| `push` | `refs/heads/master` | `edge` |
|
||||||
| `push` | `refs/heads/stable` | `cf20257` | `stable` |
|
| `push tag` | `refs/tags/[v]1.2.3` | `1.2.3`, `1.2`, `1`, `latest` |
|
||||||
| `push tag` | `refs/tags/[v]1.2.3` | `ad132f5` | `1.2.3`, `1.2`, `1`, `latest` |
|
|
||||||
|
|
||||||
### Get the tools
|
### 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`
|
- 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/))
|
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)
|
- 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
|
### Get up and running
|
||||||
|
|
||||||
|
@ -121,7 +120,7 @@ docker-compose up -d mailserver
|
||||||
./setup.sh [-Z] config dkim
|
./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:
|
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.
|
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.
|
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.
|
||||||
|
|
||||||
|
|
2
setup.sh
2
setup.sh
|
@ -180,7 +180,6 @@ ${RED}[${ORANGE}SUB${RED}]${ORANGE}COMMANDS${RESET}
|
||||||
|
|
||||||
${LBLUE}COMMAND${RESET} config ${RED}:=${RESET}
|
${LBLUE}COMMAND${RESET} config ${RED}:=${RESET}
|
||||||
${0} config dkim [ ARGUMENTS${RED}...${RESET} ]
|
${0} config dkim [ ARGUMENTS${RED}...${RESET} ]
|
||||||
${0} config ssl <FQDN> (${CYAN}ATTENTION${RESET}: This is deprecated and will be removed soon.)
|
|
||||||
|
|
||||||
${LBLUE}COMMAND${RESET} relay ${RED}:=${RESET}
|
${LBLUE}COMMAND${RESET} relay ${RED}:=${RESET}
|
||||||
${0} relay add-domain <DOMAIN> <HOST> [<PORT>]
|
${0} relay add-domain <DOMAIN> <HOST> [<PORT>]
|
||||||
|
@ -370,7 +369,6 @@ function _main
|
||||||
config )
|
config )
|
||||||
case ${2:-} in
|
case ${2:-} in
|
||||||
dkim ) shift 2 ; _docker_image open-dkim "${@}" ;;
|
dkim ) shift 2 ; _docker_image open-dkim "${@}" ;;
|
||||||
ssl ) shift 2 ; _docker_image generate-ssl-certificate "${1}" ;;
|
|
||||||
* ) _usage ;;
|
* ) _usage ;;
|
||||||
esac
|
esac
|
||||||
;;
|
;;
|
||||||
|
|
Loading…
Reference in a new issue