|
|
1 mesiac pred | |
|---|---|---|
| .github | 1 mesiac pred | |
| docker | 1 mesiac pred | |
| docs | 1 mesiac pred | |
| public | 1 mesiac pred | |
| scripts | 1 mesiac pred | |
| src | 1 mesiac pred | |
| test | 1 mesiac pred | |
| .dockerignore | 1 mesiac pred | |
| .env.example | 1 mesiac pred | |
| .gitignore | 1 mesiac pred | |
| AGENTS.md | 1 mesiac pred | |
| CHANGELOG.md | 1 mesiac pred | |
| CODE_OF_CONDUCT.md | 1 mesiac pred | |
| CONTRIBUTING.md | 1 mesiac pred | |
| Dockerfile | 1 mesiac pred | |
| LICENSE | 1 mesiac pred | |
| README.md | 1 mesiac pred | |
| SECURITY.md | 1 mesiac pred | |
| SUPPORT.md | 1 mesiac pred | |
| docker-compose.yml | 1 mesiac pred | |
| index.html | 1 mesiac pred | |
| login.html | 1 mesiac pred | |
| package-lock.json | 1 mesiac pred | |
| package.json | 1 mesiac pred | |
| tsconfig.json | 1 mesiac pred | |
| vite.config.ts | 1 mesiac pred |
MailHub 是一个 Docker 化的多用户发信控制面板、SMTP Submission 服务和发送 API。它面向需要自托管出站邮件能力的团队,提供域名验证、DKIM 签名、DNS 配置提示、SMTP 凭据和 API Token 管理。
>=24.0.0node:testcp .env.example .env
npm install
npm test
npm run build
docker compose up -d --build
docker compose logs -f app postfix
默认管理面板通过 APP_PORT 暴露到宿主机 127.0.0.1:3025。生产环境建议使用 Nginx、Caddy 或其他反向代理提供 HTTPS。
首次启动前务必修改 .env 中的默认管理员密码、SESSION_SECRET、SMTP 凭据和域名/IP 配置。
以 .env.example 为模板创建 .env。常用配置包括:
APP_BASE_URL:管理面板和发送 API 的公网访问地址。MAIL_HOSTNAME:出站邮件 HELO、Postfix myhostname 和 DNS 指南中的发信主机名。SENDING_IP:发信服务器公网 IP。SESSION_SECRET:会话和服务端加密使用的随机密钥,生产环境必须使用强随机值。SUBMISSION_HOST、SUBMISSION_PORTS:SMTP Submission 对外连接信息。SUBMISSION_TLS_CERT、SUBMISSION_TLS_KEY:TLS 证书路径。证书文件应放在本地 certs/,不要提交到 Git。DEFAULT_SPF_MECHANISMS:需要保留的第三方 SPF include,例如事务邮件服务商。SEND_REQUIRES_VERIFIED:是否要求域名 DNS 验证通过后才能发信。MailHub 提供公网 SMTP Submission。所有发信端口都需要 SMTP AUTH,未认证请求不会转发邮件,避免开放中继。
Host: 由 SUBMISSION_HOST 配置,例如 smtp.mailhub.example.com
Port 25: SMTP + STARTTLS + AUTH
Port 587: SMTP Submission + STARTTLS + AUTH
Port 465: SMTPS implicit TLS + AUTH
Port 2525: SMTP + STARTTLS + AUTH
Username: 用户在网页“SMTP 凭据”中配置
Password: 用户在网页“SMTP 凭据”中配置
SMTP 密码会同时保存哈希和服务端加密密文:哈希用于认证,加密密文用于用户本人在网页复制。旧数据如果只有哈希,无法反解,需要用户重新设置一次密码后才能复制。
每个用户可以在面板生成自己的发送 API Token。Token 只在创建时完整显示,之后列表只显示前缀。
curl -X POST https://mailhub.example.com/api/send \
-H "Authorization: Bearer <USER_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"from": "noreply@example.com",
"to": "user@example.net",
"subject": "Hello from MailHub",
"text": "Signed with DKIM and queued by MailHub."
}'
发送时会校验 From 所属域名必须归当前 Token 所属用户所有。.env 中的 API_TOKEN 仅作为旧版 admin 兼容发送 token,新用户应使用网页生成的用户级 Token。
用户可在网页“DNS API”中保存以下服务商凭据:
域名绑定 DNS 凭据后,点击“一键配置 DNS”会写入或更新验证 TXT、DKIM TXT、SPF TXT、DMARC TXT 和发信主机 A 记录。PTR 反向解析只检测和提示,通常必须在云服务器或 IP 服务商控制台配置。
生产环境建议:
/opt/mailhub。.env.example 创建 .env,填写真实域名、IP、证书路径和强随机密钥。certs/ 目录,确保私钥不会进入 Git。docker compose up -d --build。127.0.0.1:${APP_PORT}。可选的远程部署脚本需要显式提供目标服务器和目录:
MAILHUB_DEPLOY_REMOTE=deploy@example.com \
MAILHUB_DEPLOY_DIR=/opt/mailhub \
MAILHUB_DEPLOY_BRANCH=main \
npm run deploy:remote
脚本会要求本地 HEAD 已推送到对应远端分支,然后在目标目录执行 git pull --ff-only 和 docker compose up -d --build。如果目标工作区存在未提交变更,脚本会停止;确认可暂存远端工作区时,可显式设置 MAILHUB_DEPLOY_STASH_REMOTE=1。
npm test
npm run build
测试覆盖数据库迁移、多用户隔离、SMTP 凭据、API Token、DNS 服务商逻辑、DKIM、投递日志解析和前端纯逻辑模型。
.env、SQLite 数据库、API Token、SMTP 密码、DNS API 密钥、证书私钥或真实生产证书。SESSION_SECRET。25/465/587/2525 已在云防火墙和系统防火墙放行。欢迎提交 issue 和 pull request。开始前请阅读 CONTRIBUTING.md、CODE_OF_CONDUCT.md 和 SECURITY.md。
MailHub 使用 MIT License。详见 LICENSE。