astzweig/wildduck repository overview

⁠Docker Wildduck

Get the nodemailer/wildduck⁠ email server as a Docker service.

This project is part of the Astzweig⁠ social responsibility program.

⁠Table of contents

• Usage⁠
  • From source⁠
  • From Docker Hub⁠
• Environment variables⁠
  • General⁠
  • Wildduck API⁠
  • API configuration profile⁠
  • Wildduck IMAP⁠
  • Build Args⁠
  • Build Args⁠
• Development decisions⁠
• Roadmap⁠
• Alternatives⁠
• License⁠

⁠Usage

There are multiple ways to run this container and even more for experienced users. For the impatience user we have some example configurations prepared:

• From source⁠
• From Docker Hub⁠

Both ways will result in a fully functional mailserver that - depending on your configuration - will either listen on IMAP port (143) and submission port (587) or if SSL is enabled and you provid valid keys will listen on IMAPS port (993) and SMTPS port (465).

⁠From source

Checkout this repository on the computer/server, change into the cloned repository folder and edit docker-compose.yml⁠ as you wish.

$ git clone https://github.com/astzweig/docker-wildduck.git
$ cd docker-wildduck
$ vi docker-compose.yml

You should at least replace the values of the variables in that file. Afterwards you can just run:

$ docker-compose up -d mail

⁠From Docker Hub

Copy the contents of the provided docker-compose.yml⁠ file with eiter curl or wget anywhere on your server:

$ curl -o 'docker-compose.yml' https://raw.githubusercontent.com/astzweig/docker-wildduck/master/docker-compose.hub.yml

 - or -

$ wget -O 'docker-compose.yml' https://raw.githubusercontent.com/astzweig/docker-wildduck/master/docker-compose.hub.yml

Afterwards you can just run:

$ docker-compose up -d mail

⁠Environment variables

The following tables shows a complete list of variables that you can use to modify the container's build or runtime behaviour. A bold font means you will have to provide a value in order for the container to work correctly. An italic font means the setting can be overridden individually for each email account.

⁠General

⁠Wildduck API

⁠API Configuration Profile

As the Wildduck API supports two factor (2fa) authentication, it also supports application specific passwords. When an application specific password is generated, the API generates also a so called [Apple configuration profile][apple-profiles] automatically. That is a file, that allows iOS and macOS devices, to set up accounts (e.g. in this case email accounts) automatically. The following variables can be used, to configure the metadata of those configuration profiles.

⁠Wildduck IMAP

⁠Wildduck Outbound SMTP

⁠Build ARGS

These variables can be used to define the service versions that are used in the container. They change only the build time behaviour.

⁠Development decisions

• We will use shell scripts to run commands instead of writing everything in the Dockerfile. We want the build-stage scripts to form a sequence and thus we define a script naming scheme that contains an ordering prefix of two digits.
• Scripts that are not meant to be executed by their own start with an underscore. They are not moved out of the scripts folder inside the container and their execution bit is not set.
• Scripts that are meant to be executables in the running container will be in a sub-folder called 'bin'. They can have any name, with or without extension. They will be moved into one of the system paths.
• There is exactly one 'entrypoint.sh' script, that is the default command of the container.
• The container needs three components to run (Wildduck, Haraka and ZoneMTA). Each of those components has to be installed first, to be configured in a second step and to be started in a third step. We write one component script for each one of those components containing a functions for two of the steps above: a configure_{service} function and a start_{service} function. To make use of Docker image layer caching we implement the install step of each component in a single BUILD script.

⁠Roadmap

• Provide a docker container with the pre-installed services as done by the setup scripts⁠ provided by the Wildduck⁠ project.
• Provide scripts to configure the docker container using environment variables.
• Create different users for the different services in the container.
• Create better management tools, like a CLI user management tool.

⁠Alternatives

Before starting to build this image we looked around for alternatives and found houlagins⁠'s and hechengjin⁠'s containers. We still decided to go for our own solution, as neither of them provides their build files or a corresponding code repository. And - for some maybe less important - neither does any of them provide a useful documentation.

⁠License

• Licensed under the EUPL⁠.
• Logo: Duck by Milky - Digital innovation from the Noun Project⁠.