* 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
GitHub
parent
f225e14a21
commit
06f0b087c1
108
README.md
108
README.md
|
|
@ -2,7 +2,6 @@
|
|||
|
||||
[](https://travis-ci.org/tomav/docker-mailserver) [](https://hub.docker.com/r/tvial/docker-mailserver/) [](https://microbadger.com/images/tvial/docker-mailserver) [](https://github.com/tomav/docker-mailserver/) [](https://github.com/tomav/docker-mailserver/) [](https://github.com/tomav/docker-mailserver/) [](https://gitter.im/tomav/docker-mailserver)
|
||||
|
||||
|
||||
A fullstack but simple mail server (smtp, imap, antispam, antivirus...).
|
||||
Only configuration files, no SQL database. Keep it simple and versioned.
|
||||
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!
|
||||
|
||||
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/).
|
||||
- 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 run into problems, please raise issues and ask for help. Don't forget to provide details.
|
||||
|
||||
|
||||
Includes:
|
||||
|
||||
- [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
|
||||
|
||||
Recommended:
|
||||
|
||||
- 1 CPU
|
||||
- 1-2GB RAM
|
||||
- Swap enabled for the container
|
||||
|
||||
Minimum:
|
||||
|
||||
- 1 CPU
|
||||
- 512MB RAM
|
||||
|
||||
|
|
@ -62,14 +63,11 @@ Minimum:
|
|||
|
||||
## Usage
|
||||
|
||||
#### Get latest image
|
||||
|
||||
docker pull tvial/docker-mailserver:latest
|
||||
|
||||
#### Get the tools
|
||||
### Get the tools
|
||||
|
||||
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 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-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:
|
||||
- `.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).
|
||||
|
||||
#### Start Container
|
||||
### Starting the Container
|
||||
|
||||
``` BASH
|
||||
docker-compose up -d mail
|
||||
```
|
||||
|
||||
#### Create your mail accounts
|
||||
### Create your mail accounts
|
||||
|
||||
``` BASH
|
||||
./setup.sh email add <user@domain> [<password>]
|
||||
```
|
||||
|
||||
#### Generate DKIM keys
|
||||
### Generate DKIM keys
|
||||
|
||||
``` BASH
|
||||
./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.
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
#### Restart and update the container
|
||||
|
||||
``` BASH
|
||||
docker-compose down
|
||||
docker pull tvial/docker-mailserver:latest
|
||||
docker-compose up -d mail
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
#### 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)
|
||||
|
||||
|
|
@ -125,10 +135,10 @@ Your config folder will be mounted in `/tmp/docker-mailserver/`. To understand h
|
|||
|
||||
#### Exposed ports
|
||||
|
||||
| Protocol | Opt-in Encryption<sup>1</sup> | Enforced Encryption | Purpose |
|
||||
|----------|-------------------------------|---------------------|----------------------|
|
||||
| SMTP | 25 | N/A | Transfer<sup>2</sup> |
|
||||
| ESMTP | 587 | 465<sup>3</sup> | Submission |
|
||||
| Protocol | Opt-in Encryption ¹ | Enforced Encryption | Purpose |
|
||||
| :------: | :----------------------: | :-----------------: | :------------: |
|
||||
| SMTP | 25 | N/A | Transfer² |
|
||||
| ESMTP | 587 | 465³ | Submission |
|
||||
| POP3 | 110 | 995 | 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.
|
||||
|
||||
##### Examples with just the relevant environmental variables:
|
||||
### Examples
|
||||
|
||||
#### Just the relevant environmental variables
|
||||
|
||||
```yaml
|
||||
version: '2'
|
||||
|
|
@ -180,9 +192,9 @@ volumes:
|
|||
driver: local
|
||||
```
|
||||
|
||||
__for ldap setup__:
|
||||
#### LDAP setup
|
||||
|
||||
```yaml
|
||||
``` YAML
|
||||
version: '2'
|
||||
|
||||
services:
|
||||
|
|
@ -242,13 +254,15 @@ volumes:
|
|||
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!
|
||||
|
||||
Value in **bold** is the default value.
|
||||
|
||||
## General
|
||||
### Assignments
|
||||
|
||||
#### General
|
||||
|
||||
##### 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`:
|
||||
|
||||
``` BASH
|
||||
cap_add:
|
||||
- NET_ADMIN
|
||||
```
|
||||
|
||||
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
|
||||
- modern => Enables TLSv1.2 and modern ciphers only. (default)
|
||||
- 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
|
||||
|
||||
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)
|
||||
- 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
|
||||
|
||||
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
|
||||
- 1 => Enabled
|
||||
|
||||
##### 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.
|
||||
|
||||
- **empty** => localhost 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
|
||||
|
|
@ -328,8 +349,8 @@ Note: you probably want to [set `POSTFIX_INET_PROTOCOLS=ipv4`](#postfix_inet_pro
|
|||
##### VIRUSMAILS_DELETE_DELAY
|
||||
|
||||
Set how many days a virusmail will stay on the server before being deleted
|
||||
- **empty** => 7 days
|
||||
|
||||
- **empty** => 7 days
|
||||
|
||||
##### ENABLE_POSTFIX_VIRTUAL_TRANSPORT
|
||||
|
||||
|
|
@ -344,7 +365,7 @@ Enabled by ENABLE_POSTFIX_VIRTUAL_TRANSPORT. Specify the final delivery of postf
|
|||
|
||||
- **empty**: fail
|
||||
- `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)
|
||||
- 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)
|
||||
|
||||
|
||||
##### ENABLE_QUOTAS
|
||||
|
||||
- **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
|
||||
- => Specify the postmaster address
|
||||
|
||||
|
||||
##### 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.
|
||||
|
|
@ -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.
|
||||
- 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
|
||||
|
||||
Enables regular pflogsumm mail reports.
|
||||
|
||||
- **not set** => No report
|
||||
- daily_cron => Daily report for the previous day
|
||||
- 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
|
||||
|
||||
Recipient address for pflogsumm reports.
|
||||
|
||||
- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
|
||||
- => Specify the recipient address(es)
|
||||
|
||||
##### PFLOGSUMM_SENDER
|
||||
|
||||
From address for pflogsumm reports.
|
||||
|
||||
- **not set** => Use REPORT_SENDER or POSTMASTER_ADDRESS
|
||||
- => Specify the sender address
|
||||
|
||||
##### LOGWATCH_INTERVAL
|
||||
|
||||
Interval for logwatch report.
|
||||
|
||||
- **none** => No report is generated
|
||||
- daily => Send a daily report
|
||||
- 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
|
||||
|
||||
Recipient address for logwatch reports if they are enabled.
|
||||
|
||||
- **not set** => Use REPORT_RECIPIENT or POSTMASTER_ADDRESS
|
||||
- => Specify the recipient address(es)
|
||||
|
||||
##### REPORT_RECIPIENT (deprecated)
|
||||
|
||||
Enables a report being sent (created by pflogsumm) on a regular basis.
|
||||
|
||||
- **0** => Report emails are disabled unless enabled by other options
|
||||
- 1 => Using POSTMASTER_ADDRESS as the recipient
|
||||
- => 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)
|
||||
|
||||
Change the sending address for mail report
|
||||
|
||||
- **empty** => mailserver-report@hostname
|
||||
- => Specify the report sender (From) address
|
||||
|
||||
##### 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
|
||||
- weekly => Send a report every week
|
||||
- monthly => Send a report every month
|
||||
|
|
@ -470,6 +497,7 @@ the logs.
|
|||
##### LOGROTATE_INTERVAL
|
||||
|
||||
Defines the interval in which the mail log is being rotated.
|
||||
|
||||
- **daily** => Rotate daily.
|
||||
- weekly => Rotate weekly.
|
||||
- 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.
|
||||
|
||||
## Spamassassin
|
||||
#### Spamassassin
|
||||
|
||||
##### ENABLE_SPAMASSASSIN
|
||||
|
||||
|
||||
- **0** => Spamassassin is disabled
|
||||
- 1 => Spamassassin is enabled
|
||||
|
||||
|
|
@ -495,7 +522,6 @@ Use `SPAMASSASSIN_SPAM_TO_INBOX=1` for receiving spam messages.
|
|||
|
||||
##### SPAMASSASSIN_SPAM_TO_INBOX
|
||||
|
||||
|
||||
- **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`.
|
||||
|
||||
|
|
@ -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.
|
||||
|
||||
## Fetchmail
|
||||
#### Fetchmail
|
||||
|
||||
##### ENABLE_FETCHMAIL
|
||||
|
||||
- **0** => `fetchmail` disabled
|
||||
- 1 => `fetchmail` enabled
|
||||
|
||||
##### FETCHMAIL_POLL
|
||||
|
||||
- **300** => `fetchmail` The number of seconds for the interval
|
||||
|
||||
## LDAP
|
||||
#### LDAP
|
||||
|
||||
##### ENABLE_LDAP
|
||||
|
||||
|
|
@ -616,7 +644,7 @@ Note: activate this only if you are confident in your bayes database for identif
|
|||
- **empty** => no
|
||||
- yes => LDAP over TLS enabled for Dovecot
|
||||
|
||||
## Dovecot
|
||||
#### Dovecot
|
||||
|
||||
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.
|
||||
- More details on the [Dovecot Wiki](https://wiki.dovecot.org/AuthDatabase/LDAP/PasswordLookups)
|
||||
|
||||
## Postgrey
|
||||
#### Postgrey
|
||||
|
||||
##### ENABLE_POSTGREY
|
||||
|
||||
|
|
@ -675,7 +703,7 @@ Note: This postgrey setting needs `ENABLE_POSTGREY=1`
|
|||
|
||||
Note: This postgrey setting needs `ENABLE_POSTGREY=1`
|
||||
|
||||
## SASL Auth
|
||||
#### SASL Auth
|
||||
|
||||
##### ENABLE_SASLAUTHD
|
||||
|
||||
|
|
@ -732,7 +760,7 @@ Note: This postgrey setting needs `ENABLE_POSTGREY=1`
|
|||
- **empty** => No sasl_passwd will be created
|
||||
- string => `/etc/postfix/sasl_passwd` will be created with the string as password
|
||||
|
||||
## SRS (Sender Rewriting Scheme)
|
||||
#### SRS (Sender Rewriting Scheme)
|
||||
|
||||
##### 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
|
||||
- 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
|
||||
|
||||
|
|
@ -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
|
||||
be compatible with `$RELAY_USER` and `$RELAY_PASSWORD`, explained below).
|
||||
|
||||
## Multi-domain Relay Hosts
|
||||
#### Multi-domain Relay Hosts
|
||||
|
||||
#### RELAY_HOST
|
||||
|
||||
|
|
|
|||
360
setup.sh
360
setup.sh
|
|
@ -1,68 +1,70 @@
|
|||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
##
|
||||
# Wrapper for various setup scripts included in the docker-mailserver
|
||||
#
|
||||
# Wrapper for various setup scripts
|
||||
# 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=
|
||||
INFO=
|
||||
IMAGE_NAME=
|
||||
CONTAINER_NAME='mail'
|
||||
DEFAULT_CONFIG_PATH="$CDIR/config"
|
||||
USE_CONTAINER=false
|
||||
WISHED_CONFIG_PATH=
|
||||
CONFIG_PATH=
|
||||
VOLUME=
|
||||
USE_TTY=
|
||||
|
||||
_check_root() {
|
||||
if [[ $EUID -ne 0 ]]; then
|
||||
function _check_root()
|
||||
{
|
||||
if [[ $EUID -ne 0 ]]
|
||||
then
|
||||
echo "Curently docker-mailserver doesn't support podman's rootless mode, please run this script as root user."
|
||||
exit 1
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
if [ -z "$CRI" ]; then
|
||||
if [ ! -z "$(command -v docker)" ]; then
|
||||
CRI=docker
|
||||
elif [ ! -z "$(command -v podman)" ]; then
|
||||
CRI=podman
|
||||
_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 \
|
||||
function _update_config_path()
|
||||
{
|
||||
if [[ -n $CONTAINER_NAME ]]
|
||||
then
|
||||
VOLUME=$(docker inspect "$CONTAINER_NAME" \
|
||||
--format="{{range .Mounts}}{{ println .Source .Destination}}{{end}}" | \
|
||||
grep "/tmp/docker-mailserver$" 2>/dev/null)
|
||||
fi
|
||||
|
||||
if [ ! -z "$VOLUME" ]; then
|
||||
CONFIG_PATH=$(echo $VOLUME | awk '{print $1}')
|
||||
if [[ -n $VOLUME ]]
|
||||
then
|
||||
CONFIG_PATH=$(echo "$VOLUME" | awk '{print $1}')
|
||||
fi
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
_inspect() {
|
||||
if _docker_image_exists "$IMAGE_NAME"; then
|
||||
function _inspect()
|
||||
{
|
||||
if _docker_image_exists "$IMAGE_NAME"
|
||||
then
|
||||
echo "Image: $IMAGE_NAME"
|
||||
else
|
||||
echo "Image: '$IMAGE_NAME' can’t be found."
|
||||
fi
|
||||
if [ -n "$CONTAINER_NAME" ]; then
|
||||
|
||||
if [[ -n $CONTAINER_NAME ]]
|
||||
then
|
||||
echo "Container: $CONTAINER_NAME"
|
||||
echo "Config mount: $CONFIG_PATH"
|
||||
else
|
||||
|
|
@ -70,7 +72,8 @@ _inspect() {
|
|||
fi
|
||||
}
|
||||
|
||||
_usage() {
|
||||
function _usage()
|
||||
{
|
||||
echo "Usage: $0 [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args]
|
||||
|
||||
OPTIONS:
|
||||
|
|
@ -121,226 +124,197 @@ SUBCOMMANDS:
|
|||
$0 debug inspect
|
||||
$0 debug login <commands>
|
||||
"
|
||||
exit 1
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
_docker_image_exists() {
|
||||
if ${CRI} history -q "$1" >/dev/null 2>&1; then
|
||||
function _docker_image_exists()
|
||||
{
|
||||
if $CRI history -q "$1" >/dev/null 2>&1
|
||||
then
|
||||
return 0
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
if tty -s ; then
|
||||
USE_TTY="-ti"
|
||||
fi
|
||||
|
||||
_docker_image() {
|
||||
if [ "$USE_CONTAINER" = true ]; then
|
||||
# Reuse existing container specified on command line
|
||||
${CRI} exec ${USE_TTY} "$CONTAINER_NAME" "$@"
|
||||
function _docker_image()
|
||||
{
|
||||
if $USE_CONTAINER
|
||||
then
|
||||
# reuse existing container specified on command line
|
||||
$CRI exec "$USE_TTY" "$CONTAINER_NAME" "$@"
|
||||
else
|
||||
# Start temporary container with specified image
|
||||
if ! _docker_image_exists "$IMAGE_NAME"; then
|
||||
# start temporary container with specified image
|
||||
if ! _docker_image_exists "$IMAGE_NAME"
|
||||
then
|
||||
echo "Image '$IMAGE_NAME' not found. Pulling ..."
|
||||
${CRI} pull "$IMAGE_NAME"
|
||||
$CRI pull "$IMAGE_NAME"
|
||||
fi
|
||||
|
||||
${CRI} run \
|
||||
--rm \
|
||||
${CRI} run --rm \
|
||||
-v "$CONFIG_PATH":/tmp/docker-mailserver \
|
||||
${USE_TTY} "$IMAGE_NAME" $@
|
||||
"$USE_TTY" "$IMAGE_NAME" "$@"
|
||||
fi
|
||||
}
|
||||
|
||||
_docker_container() {
|
||||
if [ -n "$CONTAINER_NAME" ]; then
|
||||
${CRI} exec ${USE_TTY} "$CONTAINER_NAME" "$@"
|
||||
function _docker_container()
|
||||
{
|
||||
if [[ -n $CONTAINER_NAME ]]
|
||||
then
|
||||
$CRI exec "$USE_TTY" "$CONTAINER_NAME" "$@"
|
||||
else
|
||||
echo "The docker-mailserver is not running!"
|
||||
exit 1
|
||||
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
|
||||
c)
|
||||
CONTAINER_NAME="$OPTARG"
|
||||
USE_CONTAINER=true # Container specified, connect to running instance
|
||||
;;
|
||||
i)
|
||||
IMAGE_NAME="$OPTARG"
|
||||
;;
|
||||
c) CONTAINER_NAME="$OPTARG" ; USE_CONTAINER=true ;; # container specified, connect to running instance
|
||||
i) IMAGE_NAME="$OPTARG" ;;
|
||||
p)
|
||||
case "$OPTARG" in
|
||||
/*)
|
||||
WISHED_CONFIG_PATH="$OPTARG"
|
||||
;;
|
||||
*)
|
||||
WISHED_CONFIG_PATH="$(pwd)/$OPTARG"
|
||||
;;
|
||||
/*) WISHED_CONFIG_PATH="$OPTARG" ;;
|
||||
* ) WISHED_CONFIG_PATH="$CDIR/$OPTARG" ;;
|
||||
esac
|
||||
if [ ! -d "$WISHED_CONFIG_PATH" ]; then
|
||||
|
||||
if [[ ! -d $WISHED_CONFIG_PATH ]]
|
||||
then
|
||||
echo "Directory doesn't exist"
|
||||
_usage
|
||||
exit 1
|
||||
fi
|
||||
;;
|
||||
\?)
|
||||
echo "Invalid option: -$OPTARG" >&2
|
||||
;;
|
||||
*) echo "Invalid option: -$OPTARG" >&2 ;;
|
||||
esac
|
||||
done
|
||||
shift $((OPTIND-1))
|
||||
|
||||
if [ ! -n "$WISHED_CONFIG_PATH" ]; then
|
||||
if [[ -z $WISHED_CONFIG_PATH ]]
|
||||
then
|
||||
# no wished config path
|
||||
_update_config_path
|
||||
|
||||
if [ ! -n "$CONFIG_PATH" ]; then
|
||||
if [[ -z $CONFIG_PATH ]]
|
||||
then
|
||||
CONFIG_PATH=$DEFAULT_CONFIG_PATH
|
||||
fi
|
||||
else
|
||||
CONFIG_PATH=$WISHED_CONFIG_PATH
|
||||
fi
|
||||
|
||||
shift $((OPTIND-1))
|
||||
|
||||
case $1 in
|
||||
case ${1:-} in
|
||||
|
||||
email)
|
||||
shift
|
||||
case $1 in
|
||||
add)
|
||||
shift
|
||||
_docker_image addmailuser $@
|
||||
;;
|
||||
update)
|
||||
shift
|
||||
_docker_image updatemailuser $@
|
||||
;;
|
||||
del)
|
||||
shift
|
||||
_docker_image delmailuser $@
|
||||
;;
|
||||
restrict)
|
||||
shift
|
||||
_docker_container restrict-access $@
|
||||
;;
|
||||
list)
|
||||
_docker_image listmailuser
|
||||
;;
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
shift ; case ${1:-} in
|
||||
add ) shift ; _docker_image addmailuser "$@" ;;
|
||||
update ) shift ; _docker_image updatemailuser "$@" ;;
|
||||
del ) shift ; _docker_image delmailuser "$@" ;;
|
||||
restrict ) shift ; _docker_container restrict-access "$@" ;;
|
||||
list ) _docker_image listmailuser ;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
;;
|
||||
|
||||
alias)
|
||||
shift
|
||||
case $1 in
|
||||
add)
|
||||
shift
|
||||
_docker_image addalias $@
|
||||
;;
|
||||
del)
|
||||
shift
|
||||
_docker_image delalias $@
|
||||
;;
|
||||
list)
|
||||
shift
|
||||
_docker_image listalias $@
|
||||
;;
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
shift ; case ${1:-} in
|
||||
add ) shift ; _docker_image addalias "$@" ;;
|
||||
del ) shift ; _docker_image delalias "$@" ;;
|
||||
list ) shift ; _docker_image listalias "$@" ;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
;;
|
||||
|
||||
quota)
|
||||
shift
|
||||
case $1 in
|
||||
set)
|
||||
shift
|
||||
_docker_image setquota $@
|
||||
;;
|
||||
del)
|
||||
shift
|
||||
_docker_image delquota $@
|
||||
;;
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
shift ; case ${1:-} in
|
||||
set ) shift ; _docker_image setquota "$@" ;;
|
||||
del ) shift ; _docker_image delquota "$@" ;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
;;
|
||||
|
||||
config)
|
||||
shift
|
||||
case $1 in
|
||||
dkim)
|
||||
_docker_image generate-dkim-config $2
|
||||
;;
|
||||
ssl)
|
||||
_docker_image generate-ssl-certificate "$2"
|
||||
;;
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
shift ; case ${1:-} in
|
||||
dkim ) _docker_image generate-dkim-config "${2:-2048}" ;;
|
||||
ssl ) _docker_image generate-ssl-certificate "$2" ;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
;;
|
||||
|
||||
relay)
|
||||
shift
|
||||
case $1 in
|
||||
add-domain)
|
||||
shift
|
||||
_docker_image addrelayhost $@
|
||||
;;
|
||||
add-auth)
|
||||
shift
|
||||
_docker_image addsaslpassword $@
|
||||
;;
|
||||
exclude-domain)
|
||||
shift
|
||||
_docker_image excluderelaydomain $@
|
||||
;;
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
shift ; case ${1:-} in
|
||||
add-domain ) shift ; _docker_image addrelayhost "$@" ;;
|
||||
add-auth ) shift ; _docker_image addsaslpassword "$@" ;;
|
||||
exclude-domain ) shift ; _docker_image excluderelaydomain "$@" ;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
;;
|
||||
|
||||
debug)
|
||||
shift
|
||||
case $1 in
|
||||
fetchmail)
|
||||
_docker_image debug-fetchmail
|
||||
;;
|
||||
fail2ban)
|
||||
shift
|
||||
_docker_container fail2ban $@
|
||||
;;
|
||||
show-mail-logs)
|
||||
_docker_container cat /var/log/mail/mail.log
|
||||
;;
|
||||
inspect)
|
||||
_inspect
|
||||
;;
|
||||
shift ; case ${1:-} in
|
||||
fetchmail ) _docker_image debug-fetchmail ;;
|
||||
fail2ban ) shift ; _docker_container fail2ban "$@" ;;
|
||||
show-mail-logs ) _docker_container cat /var/log/mail/mail.log ;;
|
||||
inspect ) _inspect ;;
|
||||
login )
|
||||
shift
|
||||
if [ -z "$1" ]; then
|
||||
if [[ -z ${1:-''} ]]
|
||||
then
|
||||
_docker_container /bin/bash
|
||||
else
|
||||
_docker_container /bin/bash -c "$@"
|
||||
fi
|
||||
;;
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
;;
|
||||
|
||||
*)
|
||||
_usage
|
||||
;;
|
||||
* ) _usage ;;
|
||||
esac
|
||||
}
|
||||
|
||||
main "$@"
|
||||
_unset_vars
|
||||
|
|
|
|||
Loading…
Reference in New Issue