maxking/mailman-web

Mailman 3 Web UI 镜像文档

镜像概述和主要用途

本镜像包含 Mailman 3 的 Web 管理界面（Postorius）和邮件归档器（Hyperkitty），是 Mailman 3 套件的核心组件之一。镜像基于 GitLab 仓库 的最新源码构建。目前镜像仅提供 latest 版本，未来将区分 latest（开发版）和 stable（稳定版），计划在 Mailman Suite 3.1 版本发布后实现版本分离。

核心功能和特性

• Web 管理界面（Postorius）：提供 Mailman 3 邮件列表的可视化管理功能，支持列表创建、成员管理、权限配置等操作。
• 邮件归档器（Hyperkitty）：自动归档邮件列表消息，支持搜索、分类、线程查看等功能。
• 与 Mailman Core 集成：通过 REST API 与 Mailman Core 组件通信，实现配置同步和数据交互。
• 灵活的配置选项：支持自定义数据库、SMTP 服务器、日志路径等关键参数。
• 社交登录支持：默认集成多种社交登录提供商，可通过配置启用或禁用。
• 可扩展架构：支持覆盖 Django 配置（如 INSTALLED_APPS）以满足定制需求。

使用场景和适用范围

本镜像适用于需要部署完整 Mailman 3 套件的场景，尤其适合：

• 自托管邮件列表服务的组织或个人，需通过 Web 界面管理列表和归档邮件。
• 对邮件列表服务有定制化需求（如自定义域名、SMTP 服务器、数据库）的用户。
• 需要与 Mailman Core 组件协同工作，构建完整邮件列表生态的部署环境。

详细配置说明

环境变量配置

必须配置的环境变量

以下参数必须在部署前设置，无默认值或默认值无法满足生产需求：

可选配置的环境变量

以下参数已设置合理默认值，仅在需要自定义时修改：

部署与运行方法

推荐部署方式：Docker Compose

官方推荐使用 https://github.com/maxking/docker-mailman/ 提供的 docker-compose.yaml 进行部署，该配置已集成 Mailman Core、数据库（PostgreSQL）、Web 容器及 Nginx 反向代理。

Docker Compose 配置示例

以下为简化版 docker-compose.yaml（完整配置请参考 https://github.com/maxking/docker-mailman/blob/master/docker-compose.yaml%EF%BC%89%EF%BC%9A

yaml
version: '3'

services:
  mailman-web:
    image: maxking/mailman-web:latest
    container_name: mailman-web
    depends_on:
      - mailman-core
      - db
    environment:
      # 必须配置的环境变量
      - SERVE_FROM_DOMAIN=lists.example.com  # 替换为实际域名
      - HYPERKITTY_API_KEY=your-hyperkitty-api-key  # 与 mailman-core 保持一致
      - MAILMAN_ADMIN_USER=admin
      - MAILMAN_ADMIN_EMAIL=admin@example.com
      - SECRET_KEY=your-django-secret-key  # 建议使用随机字符串
      # 可选配置的环境变量（示例）
      - DATABASE_URL=postgres://mailman:mailmanpass@db:5432/mailmandb
      - MAILMAN_REST_URL=http://mailman-core:8001
      - SMTP_HOST=smtp.example.com
      - SMTP_PORT=587
      - SMTP_USE_TLS=True
      - SMTP_HOST_USER=smtp-user@example.com
      - SMTP_HOST_PASSWORD=smtp-password
    volumes:
      - mailman-web-data:/opt/mailman-web-data
    ports:
      - "8000:8000"

  mailman-core:
    image: maxking/mailman-core:latest
    container_name: mailman-core
    depends_on:
      - db
    environment:
      - HYPERKITTY_API_KEY=your-hyperkitty-api-key  # 与 mailman-web 保持一致
      # 其他 mailman-core 环境变量...
    volumes:
      - mailman-core-data:/opt/mailman/core
      - mailman-core-logs:/opt/mailman/logs

  db:
    image: postgres:13
    container_name: mailman-db
    environment:
      - POSTGRES_USER=mailman
      - POSTGRES_PASSWORD=mailmanpass
      - POSTGRES_DB=mailmandb
    volumes:
      - mailman-db-data:/var/lib/postgresql/data

volumes:
  mailman-web-data:
  mailman-core-data:
  mailman-core-logs:
  mailman-db-data:

独立运行：Docker Run 命令

若需快速测试，可使用 docker run 命令启动（生产环境建议使用 Docker Compose）：

bash
docker run -d \
  --name mailman-web \
  -p 8000:8000 \
  -e SERVE_FROM_DOMAIN=lists.example.com \
  -e HYPERKITTY_API_KEY=your-api-key \
  -e MAILMAN_ADMIN_USER=admin \
  -e MAILMAN_ADMIN_EMAIL=admin@example.com \
  -e SECRET_KEY=your-secret-key \
  -e DATABASE_URL=sqlite:///opt/mailman-web-data/mailmanweb.db \
  -v mailman-web-data:/opt/mailman-web-data \
  maxking/mailman-web:latest

后续步骤

1. 创建 Django 超级用户
   容器启动后，需执行以下命令创建管理员账户（用于登录 Django 管理后台）：

   bash
   docker exec -it mailman-web python manage.py createsuperuser
   

2. 配置反向代理
   需通过 Nginx 等 Web 服务器反向代理容器的 8000 端口，以支持 HTTPS 和域名访问。官方仓库提供 https://github.com/maxking/docker-mailman/%E3%80%82

3. SSL 证书配置
   建议通过 Let's Encrypt 获取免费 SSL 证书，并在 Nginx 中配置 HTTPS（因 Django 配置默认启用 USE_SSL=True）。

数据持久化

容器数据通过卷 mailman-web-data 持久化，包含数据库文件、日志、静态资源等，需确保该卷在升级或重启时保留。

注意事项

• 环境变量一致性：HYPERKITTY_API_KEY 必须在 mailman-web 和 mailman-core 容器中设置为相同值，否则无法正常归档邮件。
• 数据库选择：默认 SQLite 适用于测试，生产环境建议使用 PostgreSQL（如示例中 docker-compose.yaml 配置）。
• 安全建议：SECRET_KEY 应使用随机高强度字符串，避免泄露；敏感信息（如 SMTP 密码）建议通过环境变量注入，而非硬编码在配置文件中。