feat: add managed installation and system updates
This commit is contained in:
zxyszx
@@ -1,39 +1,142 @@
|
||||
# NewSzxcn-Email
|
||||
|
||||
NewSzxcn-Email 是一个可自建、可管理、开箱即用的开源邮箱系统。
|
||||
NewSzxcn-Email 是一个可自建、可管理、带完整 Webmail 与管理后台的开源邮箱系统。
|
||||
|
||||
## 功能
|
||||
[](https://github.com/zxyszx/NewSzxcn-Email/releases)
|
||||
[](https://github.com/zxyszx/NewSzxcn-Email/actions/workflows/docker.yml)
|
||||
[](https://github.com/zxyszx/NewSzxcn-Email/actions/workflows/ci.yml)
|
||||
[](LICENSE)
|
||||
|
||||
- Webmail 收发邮件、写信、附件、草稿、搜索、星标、标签、已读/未读
|
||||
- 多邮箱、多域名、DKIM、DNS 检测、邮件转发
|
||||
- 账号管理、邮箱数量配额、权限配额、注册与自助申请邮箱
|
||||
- 管理后台、全部邮件、发送队列、系统设置
|
||||
- Postfix、Dovecot、Rspamd、SQLite、Docker 单容器部署
|
||||
[版本发布](https://github.com/zxyszx/NewSzxcn-Email/releases) · [部署文档](deploy/README.md) · [English](README.en.md)
|
||||
|
||||
## 技术栈
|
||||
## 主要功能
|
||||
|
||||
- 后端：Go
|
||||
- 前端：React + TypeScript + shadcn/ui
|
||||
- 数据库：SQLite
|
||||
- 邮件服务：Postfix + Dovecot + Rspamd
|
||||
- 部署：Docker / Docker Compose
|
||||
| 模块 | 能力 |
|
||||
| --- | --- |
|
||||
| Webmail | 收发邮件、草稿、附件、搜索、星标、标签、自定义文件夹、稍后提醒、导入与导出 |
|
||||
| 邮箱管理 | 多邮箱切换、邮箱申请、暂停收信、账号级与邮箱级转发、外部 IMAP |
|
||||
| 收信规则 | 多条件匹配、移动、标记、删除、转发、规则排序与应用到已有邮件 |
|
||||
| 管理后台 | 账号、权限配额、域名、邮箱、转发、全部邮件、发送队列、系统设置 |
|
||||
| 邮件服务 | Postfix、Dovecot、Rspamd、DKIM、IMAP、POP3、SMTP Submission |
|
||||
| 安全 | 2FA、Turnstile、权限组、API Token、转发邮箱验证、SSRF 防护 |
|
||||
| 运维 | Docker 单镜像部署、在线检查更新、页面一键更新、自动备份、命令行回滚 |
|
||||
|
||||
## 快速部署
|
||||
## 一键安装
|
||||
|
||||
支持 Debian / Ubuntu 的 `amd64` 与 `arm64` 服务器。建议至少 2 核、2 GB 内存，并准备一个已解析到服务器的邮件主机名，例如 `mail.example.com`。
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/zxyszx/NewSzxcn-Email/main/install.sh | sudo bash
|
||||
```
|
||||
|
||||
脚本会自动完成：
|
||||
|
||||
- 安装或检查 Docker Engine 与 Docker Compose v2
|
||||
- 询问邮件域名、访问地址、管理员邮箱和密码
|
||||
- 创建 `/opt/newszxcn-email` 持久化目录
|
||||
- 拉取 GHCR 镜像并启动邮件服务
|
||||
- 生成后台在线更新所需的内部鉴权令牌
|
||||
- 等待 Web 与 API 健康检查通过
|
||||
|
||||
安装完成后访问配置的 `LANQIN_PUBLIC_BASE_URL`。首次登录后，在后台添加邮件域名并按照 DNS 检测页配置记录。
|
||||
|
||||
> 一键安装不会替你修改 DNS，也不能绕过云厂商对 25 端口的限制。公网收信前必须确认 25 端口可入站，公网发信前需确认 25 端口可出站。
|
||||
|
||||
## 更新与回滚
|
||||
|
||||
### 后台页面更新
|
||||
|
||||
超级管理员可点击后台侧栏中的版本号，查看当前版本、最新版本与更新日志。点击“立即更新”后，系统会先在线备份 SQLite 数据库，再拉取新镜像并重启；页面会等待服务恢复后自动刷新。
|
||||
|
||||
更新服务只在 Docker 内部网络开放，不映射公网端口。普通用户和普通后台权限组无法执行系统更新。
|
||||
|
||||
### 命令行更新
|
||||
|
||||
```bash
|
||||
sudo newszxcn-email update
|
||||
```
|
||||
|
||||
命令行更新会保留当前镜像、备份数据库并执行健康检查。需要回滚时运行：
|
||||
|
||||
```bash
|
||||
sudo newszxcn-email rollback
|
||||
```
|
||||
|
||||
常用运维命令：
|
||||
|
||||
```bash
|
||||
sudo newszxcn-email status
|
||||
sudo newszxcn-email logs
|
||||
sudo newszxcn-email uninstall
|
||||
```
|
||||
|
||||
`uninstall` 只移除容器，不删除 `/opt/newszxcn-email` 中的配置、数据库与邮件。
|
||||
|
||||
## DNS 与端口
|
||||
|
||||
至少需要以下 DNS 记录：
|
||||
|
||||
| 类型 | 示例 | 用途 |
|
||||
| --- | --- | --- |
|
||||
| A / AAAA | `mail.example.com -> 服务器 IP` | 邮件主机与 Webmail |
|
||||
| MX | `example.com -> mail.example.com` | 接收邮件 |
|
||||
| SPF TXT | 后台生成 | 声明允许发信的服务器 |
|
||||
| DKIM TXT | 后台按域名生成 | 邮件签名验证 |
|
||||
| DMARC TXT | 后台生成建议值 | 发信策略与报告 |
|
||||
|
||||
服务器防火墙和云安全组应按需开放：
|
||||
|
||||
| 端口 | 协议 | 用途 |
|
||||
| --- | --- | --- |
|
||||
| 25 | TCP | SMTP 服务器间收发信 |
|
||||
| 80 / 443 | TCP | Webmail 与证书签发 |
|
||||
| 465 / 587 | TCP | 邮件客户端 SMTP 发信 |
|
||||
| 993 | TCP | IMAP SSL |
|
||||
| 995 | TCP | POP3 SSL |
|
||||
|
||||
## 数据目录
|
||||
|
||||
默认部署目录为 `/opt/newszxcn-email`：
|
||||
|
||||
```text
|
||||
/opt/newszxcn-email/
|
||||
|-- .env # 环境配置与内部更新令牌
|
||||
|-- docker-compose.yml # 邮箱主服务与内部更新服务
|
||||
|-- data/ # SQLite、附件和更新前备份
|
||||
|-- mail/ # Maildir 邮件原文
|
||||
`-- dkim/ # DKIM 私钥
|
||||
```
|
||||
|
||||
升级和重建容器不会删除这些目录。备份时应同时保存 `data`、`mail`、`dkim` 与 `.env`。
|
||||
|
||||
## 手动部署
|
||||
|
||||
需要自行控制 Compose 配置时：
|
||||
|
||||
```bash
|
||||
git clone https://github.com/zxyszx/NewSzxcn-Email.git
|
||||
cd NewSzxcn-Email/deploy
|
||||
cp .env.example .env
|
||||
# 编辑 .env
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
本地源码构建：
|
||||
|
||||
```bash
|
||||
cd deploy
|
||||
cp .env.example .env
|
||||
# 修改域名、访问地址、管理员邮箱、管理员密码
|
||||
docker compose up -d --build
|
||||
docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build
|
||||
```
|
||||
|
||||
公网收发邮件需要配置：
|
||||
更完整的证书、外部 SMTP、Webhook 和排错说明见 [deploy/README.md](deploy/README.md)。
|
||||
|
||||
- MX
|
||||
- SPF
|
||||
- DKIM
|
||||
- DMARC
|
||||
- 25 / 465 / 587 / 993 / 995 端口
|
||||
## 技术栈
|
||||
|
||||
- 后端：Go、Chi、SQLite
|
||||
- 前端：React、TypeScript、TanStack Query、shadcn/ui、Tailwind CSS
|
||||
- 邮件：Postfix、Dovecot、Rspamd
|
||||
- 部署：Docker、Docker Compose、GitHub Actions、GHCR
|
||||
|
||||
## 本地开发
|
||||
|
||||
@@ -48,10 +151,13 @@ pnpm install
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
## 说明
|
||||
提交前建议运行：
|
||||
|
||||
这是 NewSzxcn 自用维护版本，后续功能和界面修改都以本仓库为准。
|
||||
```bash
|
||||
cd apps/api && go test ./...
|
||||
cd apps/web && pnpm run check
|
||||
```
|
||||
|
||||
## License
|
||||
## 开源协议
|
||||
|
||||
[MIT](./LICENSE)
|
||||
[MIT](LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user