maxking/postorius

使用Docker部署GNU Mailman 3

![CircleCI]([***]

本仓库包含两个Docker镜像maxking/mailman-core和maxking/mailman-web，用于在生产环境部署[GNU Mailman 3][1]。

[Docker][2]是一个容器生态系统，可在多个平台上运行容器。它包含一个名为[docker-compose][3]的工具，可用于运行多容器应用。本仓库提供了一个docker-compose.yaml配置文件，用于部署[Mailman 3套件][4]。

请查看https://github.com/maxking/docker-mailman/releases%E8%8E%B7%E5%8F%96%E7%89%88%E6%9C%AC%E4%BF%A1%E6%81%AF%E5%92%8C%E5%8F%98%E6%9B%B4%E6%97%A5%E5%BF%97%E3%80%82

发布版本

镜像的标签被视为发布版本。这是一种常见的容器镜像分发理念，相同标签的镜像通常会更新以包含新功能。

发布遵循以下规则：

• 标签格式为A.B.C的镜像永不更改。如果需要固定镜像版本，请使用这些标签。

• 标签为A.B的镜像对应最新的A.B.C版本。A.B系列的发布应保持向后兼容，即现有安装在A.B.C子版本间升级时不应中断。因此，如果希望获取最新更新并频繁升级而无需更改版本号，可以使用此标签。

• Mailman组件的次要版本变更将导致镜像次要版本号（A.(B+1)）的提升。此外，镜像功能的重大变更（可能改变镜像工作方式或用户与容器的交互方式）也会导致次要版本号提升。

• 主版本号变更将在出现不兼容变更、达到特定里程碑或内部组件有bug修复版本时发生，或两者皆有。

容器仓库

容器镜像可从多个容器仓库获取：

Mailman Core

• ghcr.io/maxking/mailman-core
• quay.io/maxking/mailman-core
• docker.io/maxking/mailman-core

Mailman Web

• ghcr.io/maxking/mailman-web
• quay.io/maxking/mailman-web
• docker.io/maxking/mailman-web

Postorius

• ghcr.io/maxking/postorius
• quay.io/maxking/postorius
• docker.io/maxking/postorius

滚动发布

滚动发布基于git源码安装的Mailman组件构建。注意：这些发布包含未发布的软件，应视为测试版质量。

每次提交都会通过Mailman的CI基础设施测试，只有通过完整测试套件的提交才会包含在滚动发布中。

bash
$ docker pull docker.io/maxking/mailman-web:rolling
$ docker pull docker.io/maxking/mailman-core:rolling

滚动发布随每次提交构建，并每周重新生成。可通过以下命令检查镜像的构建提交信息：

bash
$ docker inspect --format '{{json .Config.Labels }}' mailman-core | python -m json.tool
{
    "version.core": "31f434d0",
    "version.git_commit": "45a4d7805b2b3d0e7c51679f59682d64ba02f05f",
    "version.mm3-hk": "c625bfd2"
}

$ docker inspect --format '{{json .Config.Labels }}' mailman-web | python -m json.tool
{
    "version.client": "d9e9cb73",
    "version.dj-mm3": "72a7d6c4",
    "version.git_commit": "45a4d7805b2b3d0e7c51679f59682d64ba02f05f",
    "version.hyperkitty": "b67ca8a8",
    "version.postorius": "73328ad4"
}

• version.git_commit：https://github.com/maxking/docker-mailman%E4%B8%ADDockerfile%E7%9A%84%E6%8F%90%E4%BA%A4%E5%93%88%E5%B8%8C
• version.core：Mailman Core的提交哈希
• version.mm3-hk：Mailman3-hyperkitty插件的提交哈希
• version.client：Mailman Client的提交哈希
• version.hyperkitty：Hyperkitty的提交哈希
• version.postorius：Postorius的提交哈希
• version.dj-mm3：Django-Mailman3项目的提交哈希

依赖项

• Docker
• Docker-compose

在Ubuntu/Debian上安装：

$ sudo apt install docker.io docker-compose

其他系统可参考官方Docker文档安装依赖项：[Docker安装][5]和[Docker-compose安装][6]。

配置

大多数常见配置通过docker-compose.yaml中的环境变量处理。但部分配置需要直接与应用交互，主机上有两个配置文件在运行时导入容器：

• /opt/mailman/core/mailman-extra.cfg：Mailman Core的配置文件，添加的内容将合并到Core配置中。修改后需重启mailman-core容器生效。

• /opt/mailman/web/settings_local.py：Django配置文件，由mailman-web容器的现有配置导入。在大多数Postorius和Django文档中，此文件称为settings.py。要修改或覆盖Django/Postorius的任何设置，需创建/编辑此文件。

此外，如需从主机访问容器内的其他文件，可放置在以下挂载目录：

• 主机的/opt/mailman/core映射到mailman-core容器的/opt/mailman/
• 主机的/opt/mailman/web映射到mailman-web容器的/opt/mailman-web-data

Mailman-web

部署前必须修改以下设置：

• SERVE_FROM_DOMAIN：Django服务的域名，将添加到Django的ALLOWED_HOSTS。默认未设置。同时替换Django默认的example.com站点，成为默认站点（SITE_ID=1）。

• HYPERKITTY_API_KEY：Hyperkitty的API密钥，需与mailman-core的设置相同。（仅Postorius版本不需要）

• MAILMAN_ADMIN_USER：默认创建的管理员用户名。

• MAILMAN_ADMIN_EMAIL：默认创建的管理员***。

• SECRET_KEY：Django的密钥，主要用于签名cookie等。

注意：使用上述环境变量创建管理员用户时，密码未设置。需通过“登录”页面的“忘记密码”链接设置密码。

要配置mailman-web容器发送邮件，在settings_local.py中添加：

EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.example.com'
EMAIL_PORT = 25

或者使用环境变量：SMTP_HOST（默认容器网关）、SMTP_PORT（默认25）、SMTP_HOST_USER（默认空）、SMTP_HOST_PASSWORD（默认空）、SMTP_USE_TLS（默认False）。

除上述配置外，还需完成设置MTA部分，配置Mailman Core的邮件发送。

更多配置详情见Mailman-web的Readme。

Mailman-Core

部署前必须修改以下变量：

• HYPERKITTY_API_KEY：Hyperkitty的API密钥，需与mailman-web的设置相同。非Hyperkitty部署可忽略。

• DATABASE_URL：数据库URL，格式为driver://user:password@hostname:port/databasename。默认未设置时为sqlite:///opt/mailman-web-data/mailmanweb.db。标准docker-compose.yaml配置为PostgreSQL数据库，如满意无需修改。

• DATABASE_TYPE：支持sqlite、postgres或mysql（Mailman 3仅支持这三种）。默认与上述默认数据库类和URL一起设为sqlite。

• DATABASE_CLASS：默认值为mailman.database.sqlite.SQLiteDatabase。有效值见Mailman文档[数据库配置][11]。

更多配置详情见Mailman-core的Readme。

上述配置可运行镜像并查看Web前端，但需完全配置邮件发送才能正常工作。配置mailman-core容器发送邮件见设置MTA部分。

运行

运行容器：

bash
$ mkdir -p /opt/mailman/core
$ mkdir -p /opt/mailman/web
$ git clone https://github.com/maxking/docker-mailman
$ cd docker-mailman
# 按上述修改配置变量
$ docker-compose up -d

注意：mailman-web容器默认仅配置动态内容服务，静态文件（如样式表）需由Web服务器直接提供。静态文件位于/opt/mailman/web/static，需在Web服务器配置中别名到/static/。

示例见[nginx配置][17]。

该命令主要完成：

• 运行uwsgi服务器，提供Mailman的Django Web前端，监听8000端口。默认启动2个工作进程，每个4线程。生产环境部署前建议修改ALLOWED_HOSTS设置。

• 运行PostgreSQL服务器，默认数据库、用户名和密码见docker-compose.yaml。修改这些需同步更新配置文件。

• 运行mailman-core，监听8001端口（REST API）和8024端口（LMTP服务器，接收MTA消息）。需配置MTA发送消息到该地址。

系统工作原理简述（简单部署可忽略）：

• 在docker-compose.yaml中创建名为mailman的桥接网络（实际名称可能不同）。所有容器（mailman-core、mailman-web、database）加入该网络并分配静态IP。容器默认网关为主机操作系统。

• mailman-core容器连接到上述网络，运行GNU Mailman 3 core。REST API监听8001端口，LMTP服务器监听8024端口。

• mailman-web容器运行Django应用，包含Mailman的Web前端Postorius和Web归档器。使用[uwsgi][7]服务器和本仓库的配置运行。生产环境部署前建议修改ALLOWED_HOSTS设置，可通过添加/opt/mailman/web/settings_local.py实现。

• PostgreSQL数据库容器作为mailman-core和mailman-web的主数据库。

• mailman-core挂载主机的/opt/mailman/core到容器的/opt/mailman，存储Mailman的var目录以便主机访问。配置从环境变量生成，额外配置可放在主机的/opt/mailman/core/mailman-extra.cfg，并合并到生成的配置中。Mailman还需要mailman-hyperkitty.cfg，需放在主机的/opt/mailman/core/。

• mailman-web挂载主机的/opt/mailman/web到容器的/opt/mailman-web-data，存储日志和Django的settings_local.py。

• database挂载主机的/opt/mailman/database到容器的/var/lib/postgresql/data，确保PostgreSQL数据持久化。

设置邮件传输代理（MTA）

提供的容器未内置MTA。可在容器内运行MTA并转发邮件到mailman-core，或在主机安装MTA并配置转发。

使用Exim4

需配置Exim4转发mailman-core和mailman-web的邮件。仓库提供以下配置文件：

• 25_mm_macros：放置在Debian系统的/etc/exim4/conf.d/main/25_mm3_macros。将MY_DOMAIN_NAME替换为Mailman服务的域名（多域配置后续支持）。

• 455_mm3_router：放置在Debian系统的/etc/exim4/conf.d/router/455_mm3_router。

• 55_mm3_transport：放置在Debian系统的/etc/exim4/conf.d/transport/55_mm3_transport。

mailman-core镜像默认MTA配置为Exim，参考：

# mailman.cfg
[mta]
incoming: mailman.mta.exim4.LMTP
outgoing: mailman.mta.deliver.deliver
lmtp_host: $MM_HOSTNAME
lmtp_port: 8024
smtp_host: $SMTP_HOST
smtp_port: $SMTP_PORT
configuration: python:mailman.config.exim4

使用Postfix

编辑main.cf配置文件（Debian系统通常位于/etc/postfix/main.cf）。将mailman-core和mailman-web添加到mynetworks以允许转发容器邮件，并添加以下配置：

# main.cf

# 支持默认VERP分隔符
recipient_delimiter = +
unknown_local_recipient_reject_code = 550
owner_request_special = no

transport_maps =
    regexp:/opt/mailman/core/var/data/postfix_lmtp
local_recipient_maps =
    regexp:/opt/mailman/core/var/data/postfix_lmtp
relay_domains =
    regexp:/opt/mailman/core/var/data/postfix_domains

配置Mailman使用Postfix，在主机的/opt/mailman/core/mailman-extra.cfg中添加：

# mailman-extra.cfg

[mta]
incoming: mailman.mta.postfix.LMTP
outgoing: mailman.mta.deliver.deliver
# Postfix服务器视角的mailman-core主机名或IP
lmtp_host: localhost
lmtp_port: 8024
# mailman-core视角的Postfix服务器主机名或IP
smtp_host: smtp.example.com
smtp_port: 25
configuration: /etc/postfix-mailman.cfg

配置文件/etc/postfix-mailman.cfg会自动生成。

设置站点管理员地址：默认mailman的site_owner为changeme@example.com，需指向有效***。在/opt/mailman/core/mailman-extra.cfg中添加：

[mailman]
# 站点管理员地址，用于接收无法发送给列表所有者的邮件（如列表所有者邮件退回），应指向有效邮箱。
site_owner: changeme@example.com

设置搜索索引

mailman-web镜像中的Hyperkitty支持全文索引。历史原因默认使用Whoosh，生产环境建议使用Xapian。下次主版本更新将更改默认值。

要配置mailman-web容器使用Xapian，在settings_local.py中添加：

python
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'xapian_backend.XapianEngine',
        'PATH': "/opt/mailman-web-data/fulltext_index",
    },
}

如使用默认索引引擎，需重建邮件索引：

bash
$ docker-compose exec mailman-web ./manage.py rebuild_index

邮件数量多时此命令可能耗时，请耐心等待！

设置Web服务器

生产环境建议使用实际Web服务器运行Django（通过WSGI服务器）以获得更好性能。

v0.1.0版本

uwsgi服务器默认配置为通过HTTP协议监听8000端口。代理请求时需保留HOST头。Nginx配置示例：

    # Nginx配置
    location /static {
        alias /opt/mailman/web/static;
        autoindex off;
    }

    location / {
        proxy_pass http://localhost:8000;
        include uwsgi_params;
        uwsgi_read_timeout 300;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
    }

确保使用proxy_pass代理HTTP协议。

v0.1.1及以上版本

从v0.1.1开始，uwsgi服务器配置为监听8000端口（HTTP协议）和8080端口（uwsgi协议）。建议使用8080端口的uwsgi协议以获得更好性能。

Nginx配置示例（需v0.1.1及以上版本）：

    # Nginx配置
    location /static {
        alias /opt/mailman/web/static;
        autoindex off;
    }

    location / {
        uwsgi_pass localhost:8080;
        include uwsgi_params;
        uwsgi_read_timeout 300;
    }

静态文件服务

UWSGI默认不提供静态文件服务，使用提供的docker-compose.yaml运行mailman-web时，CSS和JS文件无法加载。

要通过UWSGI提供静态文件，在docker-compose.yaml的mailman-web部分添加环境变量：

UWSGI_STATIC_MAP=/static=/opt/mailman-web-data/static

建议使用Web服务器提供静态文件以获得更好性能。需在Web服务器中添加别名规则。详见[Web服务器配置指南][18]