astzweig/wildduck

Docker Wildduck

获取 https://github.com/nodemailer/wildduck 邮件服务器作为 Docker 服务。

本项目是 Astzweig 社会责任计划的一部分。

目录

• 使用方法
  • 从源码构建
  • 从Docker Hub获取
• 环境变量
  • 通用
  • Wildduck API
  • API配置文件
  • Wildduck IMAP
  • Wildduck 出站SMTP
  • 构建参数
• 开发决策
• 路线图
• 替代方案
• 许可证

使用方法

有多种运行此容器的方式，经验丰富的用户还有更多选择。对于急于使用的用户，我们准备了一些示例配置：

• 从源码构建
• 从Docker Hub获取

两种方式都将得到一个功能齐全的邮件服务器，根据配置不同，它将监听IMAP端口（143）和提交端口（587），如果启用SSL并提供有效密钥，则监听IMAPS端口（993）和SMTPS端口（465）。

从源码构建

在计算机/服务器上克隆此仓库，进入克隆的仓库文件夹，根据需要编辑 https://raw.githubusercontent.com/astzweig/docker-wildduck/master/docker-compose.yml。

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

至少应替换该文件中的变量值。之后只需运行：

bash
$ docker-compose up -d mail

从Docker Hub获取

使用 curl 或 wget 将提供的 https://raw.githubusercontent.com/astzweig/docker-wildduck/master/docker-compose.hub.yml 文件内容复制到服务器的任意位置：

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

 - 或者 -

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

之后只需运行：

bash
$ docker-compose up -d mail

环境变量

下表显示了可用于修改容器构建或运行时行为的所有变量。粗体字体表示为了容器正常工作，您必须提供值。斜体字体表示该设置可针对每个电子邮件账户单独覆盖。

通用

Wildduck API

API配置文件

由于Wildduck API支持双因素（2fa）身份验证，它还支持应用专用密码。生成应用专用密码时，API会自动生成所谓的Apple配置文件。这是一个允许iOS和macOS设备自动设置账户（例如在这种情况下是电子邮件账户）的文件。以下变量可用于配置这些配置文件的元数据。

Wildduck IMAP

Wildduck 出站SMTP

构建参数

这些变量可用于定义容器中使用的服务版本。它们仅更改构建时行为。

开发决策

• 我们将使用shell脚本来运行命令，而不是在Dockerfile中编写所有内容。我们希望构建阶段的脚本形成一个序列，因此我们定义了包含两位数字排序前缀的脚本命名方案。
• 不打算单独执行的脚本以下划线开头。它们不会移出容器内的脚本文件夹，并且未设置执行位。
• 打算在运行的容器中作为可执行文件的脚本将位于名为'bin'的子文件夹中。它们可以有任何名称，带或不带扩展名。它们将被移动到系统路径之一。
• 只有一个'entrypoint.sh'脚本，它是容器的默认命令。
• 容器需要三个组件才能运行（Wildduck、Haraka和ZoneMTA）。每个组件必须先安装，然后在第二步配置，第三步启动。我们为每个组件编写一个组件脚本，包含上述两个步骤的函数：configure_{service}函数和start_{service}函数。为了利用Docker镜像层缓存，我们在单个BUILD脚本中实现每个组件的安装步骤。

路线图

• 提供预安装了 https://github.com/nodemailer/wildduck 项目提供的https://github.com/nodemailer/wildduck/tree/master/setup所安装服务的docker容器。
• 提供使用环境变量配置docker容器的脚本。
• 为容器中的不同服务创建不同的用户。
• 创建更好的管理工具，如CLI用户管理工具。

替代方案

在开始构建此镜像之前，我们寻找了替代方案，发现了 https://hub.docker.com/r/houlagins/wildduck/ 和 https://hub.docker.com/r/hechengjin/mailserver/ 的容器。我们仍然决定开发自己的解决方案，因为它们都没有提供构建文件或相应的代码仓库。而且（对某些人来说可能不太重要）它们都没有提供有用的文档。

许可证

• 根据 EUPL 许可。
• 徽标：Duck by Milky - Digital innovation from the Noun Project。