major refactoring for setup.sh (#1590) (#1595)

* major refactoring for setup.sh (#1590)

* `set -u` stopped dkim generation from defaulting

* changed to bash and implemented simple error logging

* fixed $VOLUME not being set and refactored README as well due to markdownlint showing (valid) complaints

* setup.sh more consistent with braces, return codes, un-setting of variables and error reports and (importantly) test
This commit is contained in:
Georg Lauterbach 2020-09-04 08:42:12 +02:00 committed by GitHub
parent f225e14a21
commit 06f0b087c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 464 additions and 462 deletions

108
README.md
View File

@ -2,7 +2,6 @@
[![Build Status](https://travis-ci.org/tomav/docker-mailserver.svg?branch=master)](https://travis-ci.org/tomav/docker-mailserver) [![Docker Pulls](https://img.shields.io/docker/pulls/tvial/docker-mailserver.svg)](https://hub.docker.com/r/tvial/docker-mailserver/) [![Docker layers](https://images.microbadger.com/badges/image/tvial/docker-mailserver.svg)](https://microbadger.com/images/tvial/docker-mailserver) [![Github Stars](https://img.shields.io/github/stars/tomav/docker-mailserver.svg?label=github%20%E2%98%85)](https://github.com/tomav/docker-mailserver/) [![Github Stars](https://img.shields.io/github/contributors/tomav/docker-mailserver.svg)](https://github.com/tomav/docker-mailserver/) [![Github Forks](https://img.shields.io/github/forks/tomav/docker-mailserver.svg?label=github%20forks)](https://github.com/tomav/docker-mailserver/) [![Gitter](https://img.shields.io/gitter/room/tomav/docker-mailserver.svg)](https://gitter.im/tomav/docker-mailserver) [![Build Status](https://travis-ci.org/tomav/docker-mailserver.svg?branch=master)](https://travis-ci.org/tomav/docker-mailserver) [![Docker Pulls](https://img.shields.io/docker/pulls/tvial/docker-mailserver.svg)](https://hub.docker.com/r/tvial/docker-mailserver/) [![Docker layers](https://images.microbadger.com/badges/image/tvial/docker-mailserver.svg)](https://microbadger.com/images/tvial/docker-mailserver) [![Github Stars](https://img.shields.io/github/stars/tomav/docker-mailserver.svg?label=github%20%E2%98%85)](https://github.com/tomav/docker-mailserver/) [![Github Stars](https://img.shields.io/github/contributors/tomav/docker-mailserver.svg)](https://github.com/tomav/docker-mailserver/) [![Github Forks](https://img.shields.io/github/forks/tomav/docker-mailserver.svg?label=github%20forks)](https://github.com/tomav/docker-mailserver/) [![Gitter](https://img.shields.io/gitter/room/tomav/docker-mailserver.svg)](https://gitter.im/tomav/docker-mailserver)
A fullstack but simple mail server (smtp, imap, antispam, antivirus...). A fullstack but simple mail server (smtp, imap, antispam, antivirus...).
Only configuration files, no SQL database. Keep it simple and versioned. Only configuration files, no SQL database. Keep it simple and versioned.
Easy to deploy and upgrade. Easy to deploy and upgrade.
@ -13,13 +12,13 @@ At this point we have merged the next branch based on Debian Buster into master.
That means the docker image latest uses Buster. The change may break things! That means the docker image latest uses Buster. The change may break things!
The following possibly breaking changes are known: The following possibly breaking changes are known:
- Filebeat is removed and should be handled by another container, see [Wiki](https://github.com/tomav/docker-mailserver/wiki/). - Filebeat is removed and should be handled by another container, see [Wiki](https://github.com/tomav/docker-mailserver/wiki/).
- Dovecot will be downgraded a little bit (same major version) so that we can use the official Debian version. - Dovecot will be downgraded a little bit (same major version) so that we can use the official Debian version.
If you want to stick to the old version a while longer, either switch to stable or to a specific version. If you want to stick to the old version a while longer, either switch to stable or to a specific version.
If you run into problems, please raise issues and ask for help. Don't forget to provide details. If you run into problems, please raise issues and ask for help. Don't forget to provide details.
Includes: Includes:
- [Postfix](http://www.postfix.org) with smtp or ldap auth - [Postfix](http://www.postfix.org) with smtp or ldap auth
@ -50,11 +49,13 @@ Before you open an issue, please have a look this `README`, the [Wiki](https://g
## Requirements ## Requirements
Recommended: Recommended:
- 1 CPU - 1 CPU
- 1-2GB RAM - 1-2GB RAM
- Swap enabled for the container - Swap enabled for the container
Minimum: Minimum:
- 1 CPU - 1 CPU
- 512MB RAM - 512MB RAM
@ -62,14 +63,11 @@ Minimum:
## Usage ## Usage
#### Get latest image ### Get the tools
docker pull tvial/docker-mailserver:latest
#### Get the tools
Download the docker-compose.yml, the .env and the setup.sh files: Download the docker-compose.yml, the .env and the setup.sh files:
``` SH
curl -o setup.sh https://raw.githubusercontent.com/tomav/docker-mailserver/master/setup.sh; chmod a+x ./setup.sh curl -o setup.sh https://raw.githubusercontent.com/tomav/docker-mailserver/master/setup.sh; chmod a+x ./setup.sh
curl -o docker-compose.yml https://raw.githubusercontent.com/tomav/docker-mailserver/master/docker-compose.yml.dist curl -o docker-compose.yml https://raw.githubusercontent.com/tomav/docker-mailserver/master/docker-compose.yml.dist
@ -77,8 +75,9 @@ Download the docker-compose.yml, the .env and the setup.sh files:
curl -o .env https://raw.githubusercontent.com/tomav/docker-mailserver/master/.env.dist curl -o .env https://raw.githubusercontent.com/tomav/docker-mailserver/master/.env.dist
curl -o env-mailserver https://raw.githubusercontent.com/tomav/docker-mailserver/master/env-mailserver.dist curl -o env-mailserver https://raw.githubusercontent.com/tomav/docker-mailserver/master/env-mailserver.dist
```
#### Create a docker-compose environment ### Create a docker-compose environment
- Edit the files `.env` and `env-mailserver` to your liking: - Edit the files `.env` and `env-mailserver` to your liking:
- `.env` contains the configuration for docker-compose - `.env` contains the configuration for docker-compose
@ -90,24 +89,35 @@ Download the docker-compose.yml, the .env and the setup.sh files:
**Note:** If you want to use a bare domain (host name equals domain name) see [FAQ](https://github.com/tomav/docker-mailserver/wiki/FAQ-and-Tips#can-i-use-nakedbare-domains-no-host-name). **Note:** If you want to use a bare domain (host name equals domain name) see [FAQ](https://github.com/tomav/docker-mailserver/wiki/FAQ-and-Tips#can-i-use-nakedbare-domains-no-host-name).
#### Start Container ### Starting the Container
``` BASH
docker-compose up -d mail docker-compose up -d mail
```
#### Create your mail accounts ### Create your mail accounts
``` BASH
./setup.sh email add <user@domain> [<password>] ./setup.sh email add <user@domain> [<password>]
```
#### Generate DKIM keys ### Generate DKIM keys
``` BASH
./setup.sh config dkim ./setup.sh config dkim
```
Now the keys are generated, you can configure your DNS server by just pasting the content of `config/opendkim/keys/domain.tld/mail.txt` in your `domain.tld.hosts` zone. Now the keys are generated, you can configure your DNS server by just pasting the content of `config/opendkim/keys/domain.tld/mail.txt` in your `domain.tld.hosts` zone.
### Miscellaneous
#### Restart and update the container #### Restart and update the container
``` BASH
docker-compose down docker-compose down
docker pull tvial/docker-mailserver:latest docker pull tvial/docker-mailserver:latest
docker-compose up -d mail docker-compose up -d mail
```
You're done! You're done!
@ -117,7 +127,7 @@ And don't forget to have a look at the remaining functions of the `setup.sh` scr
If you got any problems with SPF and/or forwarding mails, give [SRS](https://github.com/roehling/postsrsd/blob/master/README.md) a try. You enable SRS by setting `ENABLE_SRS=1`. See the variable description for further information. If you got any problems with SPF and/or forwarding mails, give [SRS](https://github.com/roehling/postsrsd/blob/master/README.md) a try. You enable SRS by setting `ENABLE_SRS=1`. See the variable description for further information.
#### For informational purposes: #### For informational purposes
Your config folder will be mounted in `/tmp/docker-mailserver/`. To understand how things work on boot, please have a look at [start-mailserver.sh](https://github.com/tomav/docker-mailserver/blob/master/target/start-mailserver.sh) Your config folder will be mounted in `/tmp/docker-mailserver/`. To understand how things work on boot, please have a look at [start-mailserver.sh](https://github.com/tomav/docker-mailserver/blob/master/target/start-mailserver.sh)
@ -125,10 +135,10 @@ Your config folder will be mounted in `/tmp/docker-mailserver/`. To understand h
#### Exposed ports #### Exposed ports
| Protocol | Opt-in Encryption<sup>1</sup> | Enforced Encryption | Purpose | | Protocol | Opt-in Encryption &#185; | Enforced Encryption | Purpose |
|----------|-------------------------------|---------------------|----------------------| | :------: | :----------------------: | :-----------------: | :------------: |
| SMTP | 25 | N/A | Transfer<sup>2</sup> | | SMTP | 25 | N/A | Transfer&#178; |
| ESMTP | 587 | 465<sup>3</sup> | Submission | | ESMTP | 587 | 465&#179; | Submission |
| POP3 | 110 | 995 | Retrieval | | POP3 | 110 | 995 | Retrieval |
| IMAP4 | 143 | 993 | Retrieval | | IMAP4 | 143 | 993 | Retrieval |
@ -138,7 +148,9 @@ Your config folder will be mounted in `/tmp/docker-mailserver/`. To understand h
See the [wiki](https://github.com/tomav/docker-mailserver/wiki) for further details and best practice advice, especially regarding security concerns. See the [wiki](https://github.com/tomav/docker-mailserver/wiki) for further details and best practice advice, especially regarding security concerns.
##### Examples with just the relevant environmental variables: ### Examples
#### Just the relevant environmental variables
```yaml ```yaml
version: '2' version: '2'
@ -180,9 +192,9 @@ volumes:
driver: local driver: local
``` ```
__for ldap setup__: #### LDAP setup
```yaml ``` YAML
version: '2' version: '2'
services: services:
@ -242,13 +254,15 @@ volumes:
driver: local driver: local
``` ```
# Environment variables ## Environment variables
Please check [how the container starts](https://github.com/tomav/docker-mailserver/blob/master/target/start-mailserver.sh) to understand what's expected. Also if an option doesn't work as documented here, check if you are running the latest image! Please check [how the container starts](https://github.com/tomav/docker-mailserver/blob/master/target/start-mailserver.sh) to understand what's expected. Also if an option doesn't work as documented here, check if you are running the latest image!
Value in **bold** is the default value. Value in **bold** is the default value.
## General ### Assignments
#### General
##### DMS_DEBUG ##### DMS_DEBUG
@ -277,8 +291,10 @@ Value in **bold** is the default value.
If you enable Fail2Ban, don't forget to add the following lines to your `docker-compose.yml`: If you enable Fail2Ban, don't forget to add the following lines to your `docker-compose.yml`:
``` BASH
cap_add: cap_add:
- NET_ADMIN - NET_ADMIN
```
Otherwise, `iptables` won't be able to ban IPs. Otherwise, `iptables` won't be able to ban IPs.
@ -303,21 +319,26 @@ Please read [the SSL page in the wiki](https://github.com/tomav/docker-mailserve
- **empty** => modern - **empty** => modern
- modern => Enables TLSv1.2 and modern ciphers only. (default) - modern => Enables TLSv1.2 and modern ciphers only. (default)
- intermediate => Enables TLSv1, TLSv1.1 and TLSv1.2 and broad compatibility ciphers. - intermediate => Enables TLSv1, TLSv1.1 and TLSv1.2 and broad compatibility ciphers.
- old => NOT implemented. If you really need it, then customize the TLS ciphers overriding postfix and dovecot settings [ wiki](https://github.com/tomav/docker-mailserver/wiki/ - old => NOT implemented. If you really need it, then customize the TLS ciphers overriding postfix and dovecot settings [wiki](https://github.com/tomav/docker-mailserver/wiki/)
##### SPOOF_PROTECTION ##### SPOOF_PROTECTION
Configures the handling of creating mails with forged sender addresses. Configures the handling of creating mails with forged sender addresses.
- **empty** => Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address. See also [Wikipedia](https://en.wikipedia.org/wiki/Email_spoofing)(not recommended, but default for backwards compatibility reasons) - **empty** => Mail address spoofing allowed. Any logged in user may create email messages with a forged sender address. See also [Wikipedia](https://en.wikipedia.org/wiki/Email_spoofing)(not recommended, but default for backwards compatibility reasons)
- 1 => (recommended) Mail spoofing denied. Each user may only send with his own or his alias addresses. Addresses with [extension delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages. - 1 => (recommended) Mail spoofing denied. Each user may only send with his own or his alias addresses. Addresses with [extension delimiters](http://www.postfix.org/postconf.5.html#recipient_delimiter) are not able to send messages.
##### ENABLE_SRS ##### ENABLE_SRS
Enables the Sender Rewriting Scheme. SRS is needed if your mail server acts as forwarder. See [postsrsd](https://github.com/roehling/postsrsd/blob/master/README.md#sender-rewriting-scheme-crash-course) for further explanation. Enables the Sender Rewriting Scheme. SRS is needed if your mail server acts as forwarder. See [postsrsd](https://github.com/roehling/postsrsd/blob/master/README.md#sender-rewriting-scheme-crash-course) for further explanation.
- **0** => Disabled - **0** => Disabled
- 1 => Enabled - 1 => Enabled
##### PERMIT_DOCKER ##### PERMIT_DOCKER
Set different options for mynetworks option (can be overwrite in postfix-main.cf) **WARNING**: Adding the docker network's gateway to the list of trusted hosts, e.g. using the `network` or `connected-networks` option, can create an [**open relay**](https://en.wikipedia.org/wiki/Open_mail_relay), [for instance](https://github.com/tomav/docker-mailserver/issues/1405#issuecomment-590106498) if IPv6 is enabled on the host machine but not in Docker. Set different options for mynetworks option (can be overwrite in postfix-main.cf) **WARNING**: Adding the docker network's gateway to the list of trusted hosts, e.g. using the `network` or `connected-networks` option, can create an [**open relay**](https://en.wikipedia.org/wiki/Open_mail_relay), [for instance](https://github.com/tomav/docker-mailserver/issues/1405#issuecomment-590106498) if IPv6 is enabled on the host machine but not in Docker.
- **empty** => localhost only - **empty** => localhost only
- host => Add docker host (ipv4 only) - host => Add docker host (ipv4 only)
- network => Add the docker default bridge network (172.16.0.0/12); **WARNING**: `docker-compose` might use others (e.g. 192.168.0.0/16) use `PERMIT_DOCKER=connected-networks` in this case - network => Add the docker default bridge network (172.16.0.0/12); **WARNING**: `docker-compose` might use others (e.g. 192.168.0.0/16) use `PERMIT_DOCKER=connected-networks` in this case
@ -328,8 +349,8 @@ Note: you probably want to [set `POSTFIX_INET_PROTOCOLS=ipv4`](#postfix_inet_pro
##### VIRUSMAILS_DELETE_DELAY ##### VIRUSMAILS_DELETE_DELAY
Set how many days a virusmail will stay on the server before being deleted Set how many days a virusmail will stay on the server before being deleted
- **empty** => 7 days
- **empty** => 7 days
##### ENABLE_POSTFIX_VIRTUAL_TRANSPORT ##### ENABLE_POSTFIX_VIRTUAL_TRANSPORT
@ -344,7 +365,7 @@ Enabled by ENABLE_POSTFIX_VIRTUAL_TRANSPORT. Specify the final delivery of postf
- **empty**: fail - **empty**: fail
- `lmtp:unix:private/dovecot-lmtp` (use socket) - `lmtp:unix:private/dovecot-lmtp` (use socket)
- `lmtps:inet:<host>:<port>` (secure lmtp with starttls, take a look at https://sys4.de/en/blog/2014/11/17/sicheres-lmtp-mit-starttls-in-dovecot/) - `lmtps:inet:<host>:<port>` (secure lmtp with starttls, take a look at <https://sys4.de/en/blog/2014/11/17/sicheres-lmtp-mit-starttls-in-dovecot/>)
- `lmtp:<kopano-host>:2003` (use kopano as mailstore) - `lmtp:<kopano-host>:2003` (use kopano as mailstore)
- etc. - etc.
@ -354,7 +375,6 @@ Set the mailbox size limit for all users. If set to zero, the size will be unlim
- **empty** => 0 (no limit) - **empty** => 0 (no limit)
##### ENABLE_QUOTAS ##### ENABLE_QUOTAS
- **1** => Dovecot quota is enabled - **1** => Dovecot quota is enabled
@ -383,7 +403,6 @@ Set the message size limit for all users. If set to zero, the size will be unlim
- **empty** => postmaster@domain.com - **empty** => postmaster@domain.com
- => Specify the postmaster address - => Specify the postmaster address
##### POSTSCREEN_ACTION ##### POSTSCREEN_ACTION
- **enforce** => Allow other tests to complete. Reject attempts to deliver mail with a 550 SMTP reply, and log the helo/sender/recipient information. Repeat this test the next time the client connects. - **enforce** => Allow other tests to complete. Reject attempts to deliver mail with a 550 SMTP reply, and log the helo/sender/recipient information. Repeat this test the next time the client connects.
@ -404,13 +423,14 @@ This option has been added in November 2019. Using other format than Maildir is
- ipv4 => Use only IPv4 traffic. Most likely you want this behind Docker. - ipv4 => Use only IPv4 traffic. Most likely you want this behind Docker.
- ipv6 => Use only IPv6 traffic. - ipv6 => Use only IPv6 traffic.
Note: More details in http://www.postfix.org/postconf.5.html#inet_protocols Note: More details in <http://www.postfix.org/postconf.5.html#inet_protocols>
## Reports #### Reports
##### PFLOGSUMM_TRIGGER ##### PFLOGSUMM_TRIGGER
Enables regular pflogsumm mail reports. Enables regular pflogsumm mail reports.
- **not set** => No report - **not set** => No report
- daily_cron => Daily report for the previous day - daily_cron => Daily report for the previous day
- logrotate => Full report based on the mail log when it is rotated - logrotate => Full report based on the mail log when it is rotated
@ -421,18 +441,21 @@ If this is not set and reports are enabled with the old options, logrotate will
##### PFLOGSUMM_RECIPIENT ##### PFLOGSUMM_RECIPIENT
Recipient address for pflogsumm reports. Recipient address for pflogsumm reports.
- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS - **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
- => Specify the recipient address(es) - => Specify the recipient address(es)
##### PFLOGSUMM_SENDER ##### PFLOGSUMM_SENDER
From address for pflogsumm reports. From address for pflogsumm reports.
- **not set** => Use REPORT_SENDER or POSTMASTER_ADDRESS - **not set** => Use REPORT_SENDER or POSTMASTER_ADDRESS
- => Specify the sender address - => Specify the sender address
##### LOGWATCH_INTERVAL ##### LOGWATCH_INTERVAL
Interval for logwatch report. Interval for logwatch report.
- **none** => No report is generated - **none** => No report is generated
- daily => Send a daily report - daily => Send a daily report
- weekly => Send a report every week - weekly => Send a report every week
@ -440,12 +463,14 @@ If this is not set and reports are enabled with the old options, logrotate will
##### LOGWATCH_RECIPIENT ##### LOGWATCH_RECIPIENT
Recipient address for logwatch reports if they are enabled. Recipient address for logwatch reports if they are enabled.
- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS - **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
- => Specify the recipient address(es) - => Specify the recipient address(es)
##### REPORT_RECIPIENT (deprecated) ##### REPORT_RECIPIENT (deprecated)
Enables a report being sent (created by pflogsumm) on a regular basis. Enables a report being sent (created by pflogsumm) on a regular basis.
- **0** => Report emails are disabled unless enabled by other options - **0** => Report emails are disabled unless enabled by other options
- 1 => Using POSTMASTER_ADDRESS as the recipient - 1 => Using POSTMASTER_ADDRESS as the recipient
- => Specify the recipient address - => Specify the recipient address
@ -453,12 +478,14 @@ If this is not set and reports are enabled with the old options, logrotate will
##### REPORT_SENDER (deprecated) ##### REPORT_SENDER (deprecated)
Change the sending address for mail report Change the sending address for mail report
- **empty** => mailserver-report@hostname - **empty** => mailserver-report@hostname
- => Specify the report sender (From) address - => Specify the report sender (From) address
##### REPORT_INTERVAL (deprecated) ##### REPORT_INTERVAL (deprecated)
changes the interval in which logs are rotated and a report is being sent (deprecated). Changes the interval in which logs are rotated and a report is being sent (deprecated).
- **daily** => Send a daily report - **daily** => Send a daily report
- weekly => Send a report every week - weekly => Send a report every week
- monthly => Send a report every month - monthly => Send a report every month
@ -470,6 +497,7 @@ the logs.
##### LOGROTATE_INTERVAL ##### LOGROTATE_INTERVAL
Defines the interval in which the mail log is being rotated. Defines the interval in which the mail log is being rotated.
- **daily** => Rotate daily. - **daily** => Rotate daily.
- weekly => Rotate weekly. - weekly => Rotate weekly.
- monthly => Rotate monthly. - monthly => Rotate monthly.
@ -482,11 +510,10 @@ Also note that by default the logs are lost when the container is recycled. To k
Finally the logrotate interval **may** affect the period for generated reports. That is the case when the reports are triggered by log rotation. Finally the logrotate interval **may** affect the period for generated reports. That is the case when the reports are triggered by log rotation.
## Spamassassin #### Spamassassin
##### ENABLE_SPAMASSASSIN ##### ENABLE_SPAMASSASSIN
- **0** => Spamassassin is disabled - **0** => Spamassassin is disabled
- 1 => Spamassassin is enabled - 1 => Spamassassin is enabled
@ -495,7 +522,6 @@ Use `SPAMASSASSIN_SPAM_TO_INBOX=1` for receiving spam messages.
##### SPAMASSASSIN_SPAM_TO_INBOX ##### SPAMASSASSIN_SPAM_TO_INBOX
- **0** => Spam messages will be bounced (_rejected_) without any notification (_dangerous_). - **0** => Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
- 1 => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`. - 1 => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`.
@ -546,16 +572,18 @@ This will uncomment the respective line in ```/etc/spamassasin/local.cf```
Note: activate this only if you are confident in your bayes database for identifying ham. Note: activate this only if you are confident in your bayes database for identifying ham.
## Fetchmail #### Fetchmail
##### ENABLE_FETCHMAIL ##### ENABLE_FETCHMAIL
- **0** => `fetchmail` disabled - **0** => `fetchmail` disabled
- 1 => `fetchmail` enabled - 1 => `fetchmail` enabled
##### FETCHMAIL_POLL ##### FETCHMAIL_POLL
- **300** => `fetchmail` The number of seconds for the interval - **300** => `fetchmail` The number of seconds for the interval
## LDAP #### LDAP
##### ENABLE_LDAP ##### ENABLE_LDAP
@ -616,7 +644,7 @@ Note: activate this only if you are confident in your bayes database for identif
- **empty** => no - **empty** => no
- yes => LDAP over TLS enabled for Dovecot - yes => LDAP over TLS enabled for Dovecot
## Dovecot #### Dovecot
The following variables overwrite the default values for ```/etc/dovecot/dovecot-ldap.conf.ext```. The following variables overwrite the default values for ```/etc/dovecot/dovecot-ldap.conf.ext```.
@ -644,7 +672,7 @@ The following variables overwrite the default values for ```/etc/dovecot/dovecot
- Note: The left-hand value is the directory attribute, the right hand value is the dovecot variable. - Note: The left-hand value is the directory attribute, the right hand value is the dovecot variable.
- More details on the [Dovecot Wiki](https://wiki.dovecot.org/AuthDatabase/LDAP/PasswordLookups) - More details on the [Dovecot Wiki](https://wiki.dovecot.org/AuthDatabase/LDAP/PasswordLookups)
## Postgrey #### Postgrey
##### ENABLE_POSTGREY ##### ENABLE_POSTGREY
@ -675,7 +703,7 @@ Note: This postgrey setting needs `ENABLE_POSTGREY=1`
Note: This postgrey setting needs `ENABLE_POSTGREY=1` Note: This postgrey setting needs `ENABLE_POSTGREY=1`
## SASL Auth #### SASL Auth
##### ENABLE_SASLAUTHD ##### ENABLE_SASLAUTHD
@ -732,7 +760,7 @@ Note: This postgrey setting needs `ENABLE_POSTGREY=1`
- **empty** => No sasl_passwd will be created - **empty** => No sasl_passwd will be created
- string => `/etc/postfix/sasl_passwd` will be created with the string as password - string => `/etc/postfix/sasl_passwd` will be created with the string as password
## SRS (Sender Rewriting Scheme) #### SRS (Sender Rewriting Scheme)
##### SRS_SENDER_CLASSES ##### SRS_SENDER_CLASSES
@ -764,7 +792,7 @@ you to replace both instead of just the envelope sender.
- **empty** => Derived from OVERRIDE_HOSTNAME, DOMAINNAME, or the container's hostname - **empty** => Derived from OVERRIDE_HOSTNAME, DOMAINNAME, or the container's hostname
- Set this if auto-detection fails, isn't what you want, or you wish to have a separate container handle DSNs - Set this if auto-detection fails, isn't what you want, or you wish to have a separate container handle DSNs
## Default Relay Host #### Default Relay Host
#### DEFAULT_RELAY_HOST #### DEFAULT_RELAY_HOST
@ -773,7 +801,7 @@ you to replace both instead of just the envelope sender.
Format: `[example.com]:587` (don't forget the brackets if you need this to Format: `[example.com]:587` (don't forget the brackets if you need this to
be compatible with `$RELAY_USER` and `$RELAY_PASSWORD`, explained below). be compatible with `$RELAY_USER` and `$RELAY_PASSWORD`, explained below).
## Multi-domain Relay Hosts #### Multi-domain Relay Hosts
#### RELAY_HOST #### RELAY_HOST

360
setup.sh
View File

@ -1,68 +1,70 @@
#!/bin/sh #!/bin/bash
## # Wrapper for various setup scripts
# Wrapper for various setup scripts included in the docker-mailserver # included in the docker-mailserver
#
set -euEo pipefail
trap '_report_err $_ $LINENO $?' ERR
function _report_err()
{
echo "ERROR occured :: source (hint) $1 ; line $2 ; exit code $3 ;;" >&2
_unset_vars
}
function _unset_vars()
{
unset CDIR CRI INFO IMAGE_NAME CONTAINER_NAME DEFAULT_CONFIG_PATH
unset USE_CONTAINER WISHED_CONFIG_PATH CONFIG_PATH VOLUME USE_TTY
}
CDIR="$(cd "$(dirname "$(readlink -f "$0")")" && pwd)"
CRI= CRI=
INFO=
IMAGE_NAME=
CONTAINER_NAME='mail'
DEFAULT_CONFIG_PATH="$CDIR/config"
USE_CONTAINER=false
WISHED_CONFIG_PATH=
CONFIG_PATH=
VOLUME=
USE_TTY=
_check_root() { function _check_root()
if [[ $EUID -ne 0 ]]; then {
if [[ $EUID -ne 0 ]]
then
echo "Curently docker-mailserver doesn't support podman's rootless mode, please run this script as root user." echo "Curently docker-mailserver doesn't support podman's rootless mode, please run this script as root user."
exit 1 return 1
fi fi
} }
if [ -z "$CRI" ]; then function _update_config_path()
if [ ! -z "$(command -v docker)" ]; then {
CRI=docker if [[ -n $CONTAINER_NAME ]]
elif [ ! -z "$(command -v podman)" ]; then then
CRI=podman VOLUME=$(docker inspect "$CONTAINER_NAME" \
_check_root
else
echo "No Support Container Runtime Interface Detected."
exit 1
fi
fi
INFO=$($CRI ps \
--no-trunc \
--format "{{.Image}};{{.Names}}" \
--filter label=org.label-schema.name="docker-mailserver" | \
tail -1)
IMAGE_NAME=${INFO%;*}
CONTAINER_NAME=${INFO#*;}
DEFAULT_CONFIG_PATH="$(pwd)/config"
USE_CONTAINER=false
_update_config_path() {
if [ ! -z "$CONTAINER_NAME" ]; then
VOLUME=$(docker inspect $CONTAINER_NAME \
--format="{{range .Mounts}}{{ println .Source .Destination}}{{end}}" | \ --format="{{range .Mounts}}{{ println .Source .Destination}}{{end}}" | \
grep "/tmp/docker-mailserver$" 2>/dev/null) grep "/tmp/docker-mailserver$" 2>/dev/null)
fi fi
if [ ! -z "$VOLUME" ]; then if [[ -n $VOLUME ]]
CONFIG_PATH=$(echo $VOLUME | awk '{print $1}') then
CONFIG_PATH=$(echo "$VOLUME" | awk '{print $1}')
fi fi
} }
if [ -z "$IMAGE_NAME" ]; then function _inspect()
if [ "$CRI" = "docker" ]; then {
IMAGE_NAME=tvial/docker-mailserver:latest if _docker_image_exists "$IMAGE_NAME"
elif [ "$CRI" = "podman" ]; then then
IMAGE_NAME=docker.io/tvial/docker-mailserver:latest
fi
fi
_inspect() {
if _docker_image_exists "$IMAGE_NAME"; then
echo "Image: $IMAGE_NAME" echo "Image: $IMAGE_NAME"
else else
echo "Image: '$IMAGE_NAME' cant be found." echo "Image: '$IMAGE_NAME' cant be found."
fi fi
if [ -n "$CONTAINER_NAME" ]; then
if [[ -n $CONTAINER_NAME ]]
then
echo "Container: $CONTAINER_NAME" echo "Container: $CONTAINER_NAME"
echo "Config mount: $CONFIG_PATH" echo "Config mount: $CONFIG_PATH"
else else
@ -70,7 +72,8 @@ _inspect() {
fi fi
} }
_usage() { function _usage()
{
echo "Usage: $0 [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args] echo "Usage: $0 [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args]
OPTIONS: OPTIONS:
@ -121,226 +124,197 @@ SUBCOMMANDS:
$0 debug inspect $0 debug inspect
$0 debug login <commands> $0 debug login <commands>
" "
exit 1
return 1
} }
_docker_image_exists() { function _docker_image_exists()
if ${CRI} history -q "$1" >/dev/null 2>&1; then {
if $CRI history -q "$1" >/dev/null 2>&1
then
return 0 return 0
else else
return 1 return 1
fi fi
} }
if tty -s ; then function _docker_image()
USE_TTY="-ti" {
fi if $USE_CONTAINER
then
_docker_image() { # reuse existing container specified on command line
if [ "$USE_CONTAINER" = true ]; then $CRI exec "$USE_TTY" "$CONTAINER_NAME" "$@"
# Reuse existing container specified on command line
${CRI} exec ${USE_TTY} "$CONTAINER_NAME" "$@"
else else
# Start temporary container with specified image # start temporary container with specified image
if ! _docker_image_exists "$IMAGE_NAME"; then if ! _docker_image_exists "$IMAGE_NAME"
then
echo "Image '$IMAGE_NAME' not found. Pulling ..." echo "Image '$IMAGE_NAME' not found. Pulling ..."
${CRI} pull "$IMAGE_NAME" $CRI pull "$IMAGE_NAME"
fi fi
${CRI} run \ ${CRI} run --rm \
--rm \
-v "$CONFIG_PATH":/tmp/docker-mailserver \ -v "$CONFIG_PATH":/tmp/docker-mailserver \
${USE_TTY} "$IMAGE_NAME" $@ "$USE_TTY" "$IMAGE_NAME" "$@"
fi fi
} }
_docker_container() { function _docker_container()
if [ -n "$CONTAINER_NAME" ]; then {
${CRI} exec ${USE_TTY} "$CONTAINER_NAME" "$@" if [[ -n $CONTAINER_NAME ]]
then
$CRI exec "$USE_TTY" "$CONTAINER_NAME" "$@"
else else
echo "The docker-mailserver is not running!" echo "The docker-mailserver is not running!"
exit 1 exit 1
fi fi
} }
while getopts ":c:i:p:" OPT; do function main()
{
if [[ -n $(command -v docker) ]]
then
CRI=docker
elif [[ -n $(command -v podman) ]]
then
CRI=podman
_check_root
else
echo "No supported Container Runtime Interface detected."
exit 1
fi
INFO=$($CRI ps \
--no-trunc \
--format "{{.Image}};{{.Names}}" \
--filter label=org.label-schema.name="docker-mailserver" | \
tail -1)
IMAGE_NAME=${INFO%;*}
CONTAINER_NAME=${INFO#*;}
if [[ -z $IMAGE_NAME ]]
then
if [[ $CRI == "docker" ]]
then
IMAGE_NAME=tvial/docker-mailserver:latest
elif [[ $CRI == "podman" ]]
then
IMAGE_NAME=docker.io/tvial/docker-mailserver:latest
fi
fi
if tty -s
then
USE_TTY="-ti"
fi
local OPTIND
while getopts ":c:i:p:" OPT
do
case $OPT in case $OPT in
c) c) CONTAINER_NAME="$OPTARG" ; USE_CONTAINER=true ;; # container specified, connect to running instance
CONTAINER_NAME="$OPTARG" i) IMAGE_NAME="$OPTARG" ;;
USE_CONTAINER=true # Container specified, connect to running instance
;;
i)
IMAGE_NAME="$OPTARG"
;;
p) p)
case "$OPTARG" in case "$OPTARG" in
/*) /*) WISHED_CONFIG_PATH="$OPTARG" ;;
WISHED_CONFIG_PATH="$OPTARG" * ) WISHED_CONFIG_PATH="$CDIR/$OPTARG" ;;
;;
*)
WISHED_CONFIG_PATH="$(pwd)/$OPTARG"
;;
esac esac
if [ ! -d "$WISHED_CONFIG_PATH" ]; then
if [[ ! -d $WISHED_CONFIG_PATH ]]
then
echo "Directory doesn't exist" echo "Directory doesn't exist"
_usage _usage
exit 1 exit 1
fi fi
;; ;;
\?) *) echo "Invalid option: -$OPTARG" >&2 ;;
echo "Invalid option: -$OPTARG" >&2
;;
esac esac
done done
shift $((OPTIND-1))
if [ ! -n "$WISHED_CONFIG_PATH" ]; then if [[ -z $WISHED_CONFIG_PATH ]]
then
# no wished config path # no wished config path
_update_config_path _update_config_path
if [ ! -n "$CONFIG_PATH" ]; then if [[ -z $CONFIG_PATH ]]
then
CONFIG_PATH=$DEFAULT_CONFIG_PATH CONFIG_PATH=$DEFAULT_CONFIG_PATH
fi fi
else else
CONFIG_PATH=$WISHED_CONFIG_PATH CONFIG_PATH=$WISHED_CONFIG_PATH
fi fi
shift $((OPTIND-1))
case $1 in case ${1:-} in
email) email)
shift shift ; case ${1:-} in
case $1 in add ) shift ; _docker_image addmailuser "$@" ;;
add) update ) shift ; _docker_image updatemailuser "$@" ;;
shift del ) shift ; _docker_image delmailuser "$@" ;;
_docker_image addmailuser $@ restrict ) shift ; _docker_container restrict-access "$@" ;;
;; list ) _docker_image listmailuser ;;
update) * ) _usage ;;
shift
_docker_image updatemailuser $@
;;
del)
shift
_docker_image delmailuser $@
;;
restrict)
shift
_docker_container restrict-access $@
;;
list)
_docker_image listmailuser
;;
*)
_usage
;;
esac esac
;; ;;
alias) alias)
shift shift ; case ${1:-} in
case $1 in add ) shift ; _docker_image addalias "$@" ;;
add) del ) shift ; _docker_image delalias "$@" ;;
shift list ) shift ; _docker_image listalias "$@" ;;
_docker_image addalias $@ * ) _usage ;;
;;
del)
shift
_docker_image delalias $@
;;
list)
shift
_docker_image listalias $@
;;
*)
_usage
;;
esac esac
;; ;;
quota) quota)
shift shift ; case ${1:-} in
case $1 in set ) shift ; _docker_image setquota "$@" ;;
set) del ) shift ; _docker_image delquota "$@" ;;
shift * ) _usage ;;
_docker_image setquota $@
;;
del)
shift
_docker_image delquota $@
;;
*)
_usage
;;
esac esac
;; ;;
config) config)
shift shift ; case ${1:-} in
case $1 in dkim ) _docker_image generate-dkim-config "${2:-2048}" ;;
dkim) ssl ) _docker_image generate-ssl-certificate "$2" ;;
_docker_image generate-dkim-config $2 * ) _usage ;;
;;
ssl)
_docker_image generate-ssl-certificate "$2"
;;
*)
_usage
;;
esac esac
;; ;;
relay) relay)
shift shift ; case ${1:-} in
case $1 in add-domain ) shift ; _docker_image addrelayhost "$@" ;;
add-domain) add-auth ) shift ; _docker_image addsaslpassword "$@" ;;
shift exclude-domain ) shift ; _docker_image excluderelaydomain "$@" ;;
_docker_image addrelayhost $@ * ) _usage ;;
;;
add-auth)
shift
_docker_image addsaslpassword $@
;;
exclude-domain)
shift
_docker_image excluderelaydomain $@
;;
*)
_usage
;;
esac esac
;; ;;
debug) debug)
shift shift ; case ${1:-} in
case $1 in fetchmail ) _docker_image debug-fetchmail ;;
fetchmail) fail2ban ) shift ; _docker_container fail2ban "$@" ;;
_docker_image debug-fetchmail show-mail-logs ) _docker_container cat /var/log/mail/mail.log ;;
;; inspect ) _inspect ;;
fail2ban)
shift
_docker_container fail2ban $@
;;
show-mail-logs)
_docker_container cat /var/log/mail/mail.log
;;
inspect)
_inspect
;;
login ) login )
shift shift
if [ -z "$1" ]; then if [[ -z ${1:-''} ]]
then
_docker_container /bin/bash _docker_container /bin/bash
else else
_docker_container /bin/bash -c "$@" _docker_container /bin/bash -c "$@"
fi fi
;; ;;
*) * ) _usage ;;
_usage
;;
esac esac
;; ;;
*) * ) _usage ;;
_usage
;;
esac esac
}
main "$@"
_unset_vars