szx/NewSzxcn-Email
1
0
Fork 0
Code Issues Pull Requests Actions 55 Packages Projects Releases Wiki Activity

feat: add managed installation and system updates

Browse Source
This commit is contained in:
zxyszx
2026-08-03 16:16:20 +08:00
parent fbbd126ef4
commit ea7d58b610
43 changed files with 2766 additions and 624 deletions
Download Patch File Download Diff File Expand all files Collapse all files
deploy/.env.example
+10 -7
View File
@@ -7,14 +7,18 @@
# =========================
# 单容器部署镜像。默认使用你的 GHCR 镜像。
# 本地源码构建请用：docker compose -f docker-compose.yml -f docker-compose.build.yml up -d --build
LANQIN_IMAGE=ghcr.io/lanqin996/lanqin-email:latest
LANQIN_IMAGE=ghcr.io/zxyszx/newszxcn-email:latest
# 多容器调试版镜像。只在 docker-compose.stack.yml 中使用。
LANQIN_API_IMAGE=ghcr.io/lanqin996/lanqin-email-api:latest
LANQIN_WEB_IMAGE=ghcr.io/lanqin996/lanqin-email-web:latest
LANQIN_POSTFIX_IMAGE=ghcr.io/lanqin996/lanqin-email-postfix:latest
LANQIN_DOVECOT_IMAGE=ghcr.io/lanqin996/lanqin-email-dovecot:latest
LANQIN_RSPAMD_IMAGE=ghcr.io/lanqin996/lanqin-email-rspamd:latest
LANQIN_API_IMAGE=ghcr.io/zxyszx/newszxcn-email-api:latest
LANQIN_WEB_IMAGE=ghcr.io/zxyszx/newszxcn-email-web:latest
LANQIN_POSTFIX_IMAGE=ghcr.io/zxyszx/newszxcn-email-postfix:latest
LANQIN_DOVECOT_IMAGE=ghcr.io/zxyszx/newszxcn-email-dovecot:latest
LANQIN_RSPAMD_IMAGE=ghcr.io/zxyszx/newszxcn-email-rspamd:latest
# 后台“立即更新”使用的内部鉴权令牌。一键安装会自动生成，请勿对外公开。
# 手动部署可执行：openssl rand -hex 24
LANQIN_UPDATE_TOKEN=
# =========================
# 对外访问地址
@@ -167,4 +171,3 @@ LANQIN_EXTERNAL_IMAP_OUTLOOK_CLIENT_SECRET=
# =========================
# 容器时区。
TZ=Asia/Shanghai
deploy/README.md
+26 -8
View File
@@ -1,4 +1,23 @@
# LanQin Email Docker 部署说明
# NewSzxcn Email Docker 部署说明
## 一键安装与更新
推荐直接使用仓库根目录的管理脚本：
```bash
curl -fsSL https://raw.githubusercontent.com/zxyszx/NewSzxcn-Email/main/install.sh | sudo bash
```
后续操作：
```bash
sudo newszxcn-email update
sudo newszxcn-email status
sudo newszxcn-email logs
sudo newszxcn-email rollback
```
一键安装会把配置和数据放在 `/opt/newszxcn-email`，并部署内部 Watchtower 更新服务。该服务不映射公网端口，仅接受带随机令牌的容器内请求；后台“立即更新”也只允许超级管理员执行。
## 最简单部署：单容器镜像版
@@ -55,12 +74,12 @@ docker compose down
默认镜像：
```text
ghcr.io/lanqin996/lanqin-email:latest
ghcr.io/lanqin996/lanqin-email-api:latest
ghcr.io/lanqin996/lanqin-email-web:latest
ghcr.io/lanqin996/lanqin-email-postfix:latest
ghcr.io/lanqin996/lanqin-email-dovecot:latest
ghcr.io/lanqin996/lanqin-email-rspamd:latest
ghcr.io/zxyszx/newszxcn-email:latest
ghcr.io/zxyszx/newszxcn-email-api:latest
ghcr.io/zxyszx/newszxcn-email-web:latest
ghcr.io/zxyszx/newszxcn-email-postfix:latest
ghcr.io/zxyszx/newszxcn-email-dovecot:latest
ghcr.io/zxyszx/newszxcn-email-rspamd:latest
```
如果拉取时报：
@@ -212,4 +231,3 @@ docker compose logs --tail=200 lanqin-email
- 建议在服务器或边缘网关配置 HTTPS。
- 云厂商通常默认封禁 25 端口，需要单独申请解封。
- SQLite 适合 V1 单机部署；多节点部署前迁移到 PostgreSQL，并把 Postfix/Dovecot maps 改为 PostgreSQL。
deploy/all-in-one/Dockerfile
+5 -1
View File
@@ -6,9 +6,13 @@ COPY apps/api/go.mod apps/api/go.sum ./
RUN --mount=type=cache,target=/go/pkg/mod \
go mod download
COPY apps/api ./
ARG APP_VERSION="dev"
ARG APP_COMMIT=""
RUN --mount=type=cache,target=/go/pkg/mod \
--mount=type=cache,target=/root/.cache/go-build \
CGO_ENABLED=0 GOOS=linux go build -trimpath -o /out/lanqin-api ./cmd/server
CGO_ENABLED=0 GOOS=linux go build -trimpath \
-ldflags "-s -w -X lanqin-email-api/internal/app.BuildVersion=${APP_VERSION} -X lanqin-email-api/internal/app.BuildCommit=${APP_COMMIT}" \
-o /out/lanqin-api ./cmd/server
FROM node:20-bookworm-slim AS web-build
WORKDIR /src
deploy/api.Dockerfile
+5 -1
View File
@@ -6,9 +6,13 @@ COPY apps/api/go.mod apps/api/go.sum ./
RUN --mount=type=cache,target=/go/pkg/mod \
go mod download
COPY apps/api ./
ARG APP_VERSION="dev"
ARG APP_COMMIT=""
RUN --mount=type=cache,target=/go/pkg/mod \
--mount=type=cache,target=/root/.cache/go-build \
CGO_ENABLED=0 GOOS=linux go build -trimpath -o /out/lanqin-api ./cmd/server
CGO_ENABLED=0 GOOS=linux go build -trimpath \
-ldflags "-s -w -X lanqin-email-api/internal/app.BuildVersion=${APP_VERSION} -X lanqin-email-api/internal/app.BuildCommit=${APP_COMMIT}" \
-o /out/lanqin-api ./cmd/server
FROM debian:bookworm-slim
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
deploy/docker-compose.build.yml
+5
View File
@@ -3,3 +3,8 @@ services:
build:
context: ..
dockerfile: deploy/all-in-one/Dockerfile
args:
APP_VERSION: ${LANQIN_BUILD_VERSION:-dev}
APP_COMMIT: ${LANQIN_BUILD_COMMIT:-local}
VITE_APP_VERSION: ${LANQIN_BUILD_VERSION:-dev}
VITE_RELEASE_URL: ${LANQIN_BUILD_RELEASE_URL:-}
deploy/docker-compose.stack.build.yml
+6
View File
@@ -3,11 +3,17 @@ services:
build:
context: ..
dockerfile: deploy/api.Dockerfile
args:
APP_VERSION: ${LANQIN_BUILD_VERSION:-dev}
APP_COMMIT: ${LANQIN_BUILD_COMMIT:-local}
web:
build:
context: ..
dockerfile: deploy/web.Dockerfile
args:
VITE_APP_VERSION: ${LANQIN_BUILD_VERSION:-dev}
VITE_RELEASE_URL: ${LANQIN_BUILD_RELEASE_URL:-}
postfix:
build:
deploy/docker-compose.stack.yml
+5 -5
View File
@@ -1,6 +1,6 @@
services:
api:
image: ${LANQIN_API_IMAGE:-ghcr.io/lanqin996/lanqin-email-api:latest}
image: ${LANQIN_API_IMAGE:-ghcr.io/zxyszx/newszxcn-email-api:latest}
env_file: .env
environment:
LANQIN_SMTP_HOST: ${LANQIN_STACK_SMTP_HOST:-postfix}
@@ -23,7 +23,7 @@ services:
restart: unless-stopped
web:
image: ${LANQIN_WEB_IMAGE:-ghcr.io/lanqin996/lanqin-email-web:latest}
image: ${LANQIN_WEB_IMAGE:-ghcr.io/zxyszx/newszxcn-email-web:latest}
restart: unless-stopped
nginx:
@@ -39,7 +39,7 @@ services:
restart: unless-stopped
postfix:
image: ${LANQIN_POSTFIX_IMAGE:-ghcr.io/lanqin996/lanqin-email-postfix:latest}
image: ${LANQIN_POSTFIX_IMAGE:-ghcr.io/zxyszx/newszxcn-email-postfix:latest}
env_file: .env
volumes:
- ./data:/data
@@ -54,7 +54,7 @@ services:
restart: unless-stopped
dovecot:
image: ${LANQIN_DOVECOT_IMAGE:-ghcr.io/lanqin996/lanqin-email-dovecot:latest}
image: ${LANQIN_DOVECOT_IMAGE:-ghcr.io/zxyszx/newszxcn-email-dovecot:latest}
env_file: .env
volumes:
- ./data:/data
@@ -69,7 +69,7 @@ services:
restart: unless-stopped
rspamd:
image: ${LANQIN_RSPAMD_IMAGE:-ghcr.io/lanqin996/lanqin-email-rspamd:latest}
image: ${LANQIN_RSPAMD_IMAGE:-ghcr.io/zxyszx/newszxcn-email-rspamd:latest}
env_file: .env
volumes:
- ./data:/data:ro
deploy/docker-compose.yml
+20 -1
View File
@@ -1,7 +1,10 @@
services:
lanqin-email:
image: ${LANQIN_IMAGE:-ghcr.io/lanqin996/lanqin-email:latest}
image: ${LANQIN_IMAGE:-ghcr.io/zxyszx/newszxcn-email:latest}
env_file: .env
environment:
LANQIN_UPDATE_SERVICE_URL: http://updater:8080/v1/update
LANQIN_UPDATE_SERVICE_TOKEN: ${LANQIN_UPDATE_TOKEN:-}
ports:
- "80:80"
- "443:443"
@@ -16,4 +19,20 @@ services:
- ./dkim:/var/lib/rspamd/dkim
# 生产环境如需第三方客户端校验证书，请取消下面挂载，并在 .env 配置：
# - /etc/letsencrypt:/etc/letsencrypt:ro
labels:
com.centurylinklabs.watchtower.enable: "true"
com.centurylinklabs.watchtower.scope: "newszxcn-email"
restart: unless-stopped
updater:
image: nickfedor/watchtower:1.20.2
environment:
WATCHTOWER_HTTP_API_TOKEN: ${LANQIN_UPDATE_TOKEN:?请在 .env 设置 LANQIN_UPDATE_TOKEN}
command:
- --http-api-update
- --label-enable
- --scope
- newszxcn-email
volumes:
- /var/run/docker.sock:/var/run/docker.sock
restart: unless-stopped
deploy/install.sh
Regular → Executable
+2 -32
View File
@@ -1,34 +1,4 @@
#!/usr/bin/env bash
set -euo pipefail
set -Eeuo pipefail
cd "$(dirname "$0")"
if ! command -v docker >/dev/null 2>&1; then
echo "未检测到 docker，请先安装 Docker Engine / Docker Compose。" >&2
exit 1
fi
if ! docker compose version >/dev/null 2>&1; then
echo "未检测到 docker compose，请先安装 Docker Compose v2。" >&2
exit 1
fi
if [ ! -f .env ]; then
cp .env.example .env
echo "已生成 deploy/.env。请先编辑域名和管理员密码："
echo " LANQIN_PUBLIC_HOSTNAME"
echo " LANQIN_PUBLIC_BASE_URL"
echo " LANQIN_ADMIN_EMAIL"
echo " LANQIN_ADMIN_PASSWORD"
echo
echo "编辑完成后再次执行：./install.sh"
exit 0
fi
echo "拉取镜像..."
docker compose pull
echo "启动服务..."
docker compose up -d
echo "完成。查看日志：docker compose logs -f lanqin-email"
exec "$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)/install.sh" "$@"