kevin/mailgo

Fork 0

T

kevin 0e9b62f5cf 修复socket问题

2026-06-01 20:18:38 +08:00

.workbuddy

2026-06-01 20:06:02 +08:00

config

二阶段差不多

2026-06-01 19:46:51 +08:00

docs

一阶段ok

2026-06-01 18:59:55 +08:00

internal

修复socket问题

2026-06-01 20:18:38 +08:00

.gitignore

2026-06-01 19:54:53 +08:00

go.mod

二阶段差不多

2026-06-01 19:46:51 +08:00

go.sum

二阶段差不多

2026-06-01 19:46:51 +08:00

install.sh

2026-06-01 20:06:02 +08:00

main.go

二阶段差不多

2026-06-01 19:46:51 +08:00

README.md

2026-06-01 20:06:02 +08:00

README.md

MailGo

Go 语言编写的轻量级邮件系统，集成 SMTP / IMAP / POP3 协议服务和 Web 管理界面。

功能特性

邮件协议：SMTP（发送）、IMAP（同步）、POP3（收取），均支持 TLS 加密
Web 邮箱：收件箱、已发送、草稿箱、富文本编辑（Quill.js）、附件上传/下载
管理后台：域名管理、用户管理、DKIM 密钥自动生成、DNS 配置提示、全量邮件查看、IP 封禁管理、仪表盘统计
外部认证：OAuth2（Google / GitHub）、LDAP（可选，默认关闭）
安全机制：BCrypt 密码哈希、登录失败自动封禁 IP、管理员可解封
多数据库：默认 SQLite，可切换 MySQL
跨平台：Linux 生产部署 + Windows 本地调试

快速开始

编译

go build -o mailgo .

启动

./mailgo

首次启动会自动创建配置文件和数据库，默认管理员账户：

项目	值
邮箱	`admin@example.com`
密码	`admin`

⚠️ 请在生产环境中立即修改默认密码。

访问

页面	地址
用户邮箱	`http://localhost:8080/`
管理后台	`http://localhost:8080/admin`

配置文件

配置文件路径（TOML 格式）：

系统	路径
Linux	`/etc/mail_go/mail_go.toml`
Windows	`./win/etc/mail_go/mail_go.toml`

首次启动自动生成，缺失字段自动补全。修改后需重启服务生效。

完整配置参考

[database]
driver = "sqlite"                          # sqlite | mysql
dsn = "/srv/mail_go/mail.db"               # SQLite: 文件路径; MySQL: DSN 连接串

[storage]
base_dir = "/srv/mail_go"                  # 数据根目录
attach_dir = "/srv/mail_go/attachments"     # 附件存储目录

[web]
addr = ":8080"                             # 监听地址，支持 TCP 端口或 Unix socket

[smtp]
addr = ":25"                               # SMTP 明文端口
tls_addr = ":465"                          # SMTPS 端口（需配置 TLS 证书）
domain = "example.com"                     # 邮件域名
tls_cert = ""                             # TLS 证书路径（留空则不启用 TLS）
tls_key = ""                              # TLS 私钥路径
max_message_bytes = 67108864              # 单封邮件最大 64MB

[imap]
addr = ":143"                              # IMAP 明文端口
tls_addr = ":993"                          # IMAPS 端口
tls_cert = ""
tls_key = ""

[pop3]
addr = ":110"                              # POP3 明文端口
tls_addr = ":995"                          # POP3S 端口
tls_cert = ""
tls_key = ""

[auth]
oauth2_enabled = false                     # 是否启用 OAuth2 登录
oauth2_provider = ""                       # google | github
oauth2_client_id = ""
oauth2_client_secret = ""
oauth2_redirect_url = ""
ldap_enabled = false                      # 是否启用 LDAP 登录
ldap_server = ""                          # 例: ldap://localhost:389
ldap_bind_dn = ""                         # 例: cn=admin,dc=example,dc=com
ldap_bind_password = ""
ldap_search_base = ""                     # 例: ou=users,dc=example,dc=com
ldap_search_filter = ""                   # 例: (uid=%s)
ldap_use_tls = false

[ban]
max_fail_attempts = 5                    # 登录失败次数阈值
ban_duration_min = 30                     # 封禁时长（分钟）

常见配置场景

1. 切换到 MySQL

[database]
driver = "mysql"
dsn = "mailgo:YourPassword@tcp(127.0.0.1:3306)/mailgo?charset=utf8mb4&parseTime=True&loc=Local"

MySQL DSN 格式：用户名:密码@tcp(主机:端口)/数据库名?参数

数据库和用户需提前在 MySQL 中创建：

CREATE DATABASE mailgo CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'mailgo'@'localhost' IDENTIFIED BY 'YourPassword';
GRANT ALL PRIVILEGES ON mailgo.* TO 'mailgo'@'localhost';
FLUSH PRIVILEGES;

2. Web 使用 Unix Socket

[web]
addr = "/run/mail_go/web.sock"

当 addr 以 / 开头时，Gin 自动以 Unix socket 方式监听。

Nginx 反向代理配置：

server {
    listen 80;
    server_name mail.example.com;

    location / {
        proxy_pass http://unix:/run/mail_go/web.sock;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

确保 socket 目录存在并有写权限：
mkdir -p /run/mail_go
chown mailgo:mailgo /run/mail_go

3. 启用 TLS 加密

为 SMTP/IMAP/POP3 启用 TLS（三个协议共享同一证书，或分别配置）：

[smtp]
tls_cert = "/etc/mail_go/certs/server.crt"
tls_key = "/etc/mail_go/certs/server.key"

[imap]
tls_cert = "/etc/mail_go/certs/server.crt"
tls_key = "/etc/mail_go/certs/server.key"

[pop3]
tls_cert = "/etc/mail_go/certs/server.crt"
tls_key = "/etc/mail_go/certs/server.key"

配置 TLS 后，系统会自动启动对应的加密端口（465/993/995）。管理后台添加域名时勾选 TLS 会自动切换端口号。

可用 Let's Encrypt 获取免费证书：

certbot certonly --standalone -d mail.example.com
# 证书路径: /etc/letsencrypt/live/mail.example.com/fullchain.pem
# 私钥路径: /etc/letsencrypt/live/mail.example.com/privkey.pem

4. 启用 OAuth2 登录（Google 示例）

[auth]
oauth2_enabled = true
oauth2_provider = "google"
oauth2_client_id = "your-client-id.apps.googleusercontent.com"
oauth2_client_secret = "your-client-secret"
oauth2_redirect_url = "https://mail.example.com/auth/oauth2/callback"

需要在 Google Cloud Console 创建 OAuth 2.0 客户端，授权回调地址填 https://你的域名/auth/oauth2/callback。

5. 启用 LDAP 认证

[auth]
ldap_enabled = true
ldap_server = "ldap://ldap.example.com:389"
ldap_bind_dn = "cn=admin,dc=example,dc=com"
ldap_bind_password = "ldap_admin_password"
ldap_search_base = "ou=users,dc=example,dc=com"
ldap_search_filter = "(uid=%s)"
ldap_use_tls = true

端口速查

协议	明文端口	TLS 端口	说明
SMTP	25	465	邮件发送
IMAP	143	993	邮箱同步
POP3	110	995	邮件收取
Web	8080	—	Web 界面（可配 Unix socket）

目录结构

mailgo/
├── main.go                          # 程序入口
├── config/
│   ├── config.go                    # 配置加载与合并
│   └── defaults.go                  # 默认常量
├── internal/
│   ├── db/
│   │   ├── db.go                    # 数据库初始化（SQLite/MySQL）
│   │   └── models.go               # GORM 模型定义
│   ├── store/
│   │   ├── stores.go                # Store 聚合器
│   │   ├── user_store.go            # 用户数据操作
│   │   ├── mail_store.go            # 邮件数据操作
│   │   ├── domain_store.go          # 域名数据操作
│   │   ├── attachment_store.go      # 附件数据操作
│   │   └── ban_store.go             # 封禁数据操作
│   ├── smtp_server/server.go        # SMTP 服务
│   ├── imap_server/
│   │   ├── server.go                # IMAP 服务
│   │   └── backend.go               # IMAP 后端
│   ├── pop3_server/server.go         # POP3 服务
│   ├── storage/attachment.go         # 附件文件存储
│   ├── dkim/keys.go                  # DKIM 密钥生成
│   ├── auth/
│   │   ├── provider.go              # 认证接口
│   │   ├── oauth2.go                # OAuth2 认证
│   │   └── ldap.go                  # LDAP 认证
│   └── web/
│       ├── server.go                 # Web 路由与模板加载
│       ├── handlers/
│       │   ├── auth.go              # 登录/登出/OAuth2/LDAP
│       │   ├── mail.go              # 邮箱操作
│       │   └── admin.go             # 管理后台
│       ├── middleware/
│       │   ├── auth.go              # 会话认证
│       │   ├── admin.go             # 管理员权限
│       │   └── ban.go               # IP 封禁检查
│       └── templates/               # HTML 模板
│           ├── *.html               # 用户页面
│           └── admin/*.html          # 管理页面
└── .gitignore

运行时数据目录（Linux）

路径	说明
`/etc/mail_go/`	配置文件
`/srv/mail_go/`	数据库 + 附件存储

运行时数据目录（Windows 调试）

路径	说明
`./win/etc/mail_go/`	配置文件
`./win/srv/mail_go/`	数据库 + 附件存储

Linux 服务部署

systemd 服务文件

创建 /etc/systemd/system/mailgo.service：

[Unit]
Description=MailGo Mail Server
After=network.target mysql.service

[Service]
Type=simple
User=mailgo
Group=mailgo
WorkingDirectory=/opt/mailgo
ExecStart=/opt/mailgo/mailgo
Restart=on-failure
RestartSec=5
LimitNOFILE=65536

# 安全加固
NoNewPrivileges=true
ProtectSystem=strict
ProtectHome=true
ReadWritePaths=/srv/mail_go /run/mail_go /etc/mail_go

[Install]
WantedBy=multi-user.target

启动服务

# 创建系统用户
sudo useradd -r -s /sbin/nologin -d /srv/mail_go mailgo

# 设置目录权限
sudo chown -R mailgo:mailgo /srv/mail_go /etc/mail_go

# 启用并启动
sudo systemctl daemon-reload
sudo systemctl enable mailgo
sudo systemctl start mailgo

# 查看日志
sudo journalctl -u mailgo -f

DNS 配置

邮件服务需要以下 DNS 记录（管理后台 → DNS 提示页面可查看完整配置）：

记录类型	名称	值	说明
A	mail	服务器 IP	邮件服务器地址
MX	@	mail.example.com	邮件路由
TXT	@	`v=spf1 mx ~all`	SPF 反垃圾
TXT	default._domainkey	DKIM 公钥（后台自动生成）	DKIM 签名验证
TXT	_dmarc	`v=DMARC1; p=none; rua=mailto:admin@example.com`	DMARC 策略

技术栈

组件	技术
语言	Go 1.25+
Web 框架	Gin
模板引擎	html/template
ORM	GORM
数据库	SQLite（默认）/ MySQL
配置格式	TOML
SMTP	github.com/emersion/go-smtp
IMAP	github.com/emersion/go-imap v1
POP3	手工实现 TCP 协议
密码哈希	golang.org/x/crypto/bcrypt
富文本	Quill.js (CDN)
OAuth2	golang.org/x/oauth2
LDAP	github.com/go-ldap/ldap/v3
DKIM	RSA 2048 自动生成

默认账户

角色	邮箱	密码	默认配额
管理员	admin@example.com	admin	5 GB

⚠️ 部署到生产环境后请立即修改管理员密码。

License

MIT

README.md Unescape Escape

MailGo

功能特性

快速开始

编译

启动

访问

配置文件

完整配置参考

常见配置场景

1. 切换到 MySQL

2. Web 使用 Unix Socket

3. 启用 TLS 加密

4. 启用 OAuth2 登录（Google 示例）

5. 启用 LDAP 认证

端口速查

目录结构

运行时数据目录（Linux）

运行时数据目录（Windows 调试）

Linux 服务部署

systemd 服务文件

启动服务

DNS 配置

技术栈

默认账户

License

README.md