docker-mailserver/docs/content/setup-docker-mailserver-using-the-script-setup.sh.md
2018-02-01 09:36:13 +01:00

67 lines
2.5 KiB
Markdown

The latest version of the script `setup.sh` is included in the `docker-mailserver` repository. Get the last version to the script by copying this command in your console:
```
wget -q -O setup.sh https://raw.githubusercontent.com/tomav/docker-mailserver/master/setup.sh; chmod a+x ./setup.sh
```
if you use curl:
```
curl -o setup.sh https://raw.githubusercontent.com/tomav/docker-mailserver/master/setup.sh; chmod a+x ./setup.sh
```
Run `./setup.sh` without arguments and you get some usage informations.
```
Usage: ./setup.sh [-i IMAGE_NAME] [-c CONTAINER_NAME] <subcommand> <subcommand> [args]
OPTIONS:
-i IMAGE_NAME The name of the docker-mailserver image, by default
'tvial/docker-mailserver:latest'.
-c CONTAINER_NAME The name of the running container.
SUBCOMMANDS:
email:
./setup.sh email add <email> <password>
./setup.sh email update <email> <password>
./setup.sh email del <email>
./setup.sh email list
alias:
./setup.sh alias add <email> <recipient>
./setup.sh alias del <email> <recipient>
./setup.sh alias list
config:
./setup.sh config dkim
./setup.sh config ssl
debug:
./setup.sh debug fetchmail
./setup.sh debug show-mail-logs
./setup.sh debug inspect
./setup.sh debug login <commands>
```
# email
* `./setup.sh email add <email> <password>`: Add an email-account (\<password\> is optional)
* `./setup.sh email update <email> <password>`: Change the password of an email-account (\<password\> is optional)
* `./setup.sh email del <email>': delete an email-account
* `./setup.sh email list`: list all existing email-accounts
# alias
* `./setup.sh alias add <email> <recipient>`: add an alias(email) for an email-account(recipient)
* `./setup.sh alias del <email> <recipient>`: delete an alias
* `./setup.sh alias list`: list all aliases
# config
* `./setup.sh config dkim`: autoconfig the dkim-config
* `./setup.sh config ssl`: generate ssl-certificates
# debug
* `./setup.sh debug fetchmail`: see [wiki](https://github.com/tomav/docker-mailserver/wiki/Retrieve-emails-from-a-remote-mail-server-%28using-builtin-fetchmail%29#debugging)
* `./setup.sh debug fail2ban <unban> <ip-address>`: omitt all options to get a list of banned IPs, otherwise unban the specified IP.
* `./setup.sh debug show-mail-logs`: show the logfile contents of the mail container
* `./setup.sh debug inspect`: show infos about the running container
* `./setup.sh debug login <commands>`: run a <command> inside the mail container (omit the command to get shell access)