OpenSync 是面向飞牛 fnOS / 飞牛 NAS、普通 NAS 和 Docker 环境的 AList / OpenList 自动同步工具。它通过 AList / OpenList 连接本地目录、网盘、对象存储、WebDAV 等存储端，并用可视化任务完成备份、镜像、归档和迁移。
如果你在飞牛 NAS 上想找一个类似群晖 Cloud Sync 的同步工具，用来把照片库、影音库、下载目录或文档目录同步到网盘、对象存储或另一台存储设备，OpenSync 就是面向这个场景做的。
English Summary
OpenSync is an AList / OpenList automation tool for fnOS, NAS, and Docker environments. It provides visual sync jobs for backup, archive, mirroring, and migration workflows across local folders, cloud drives, object storage, WebDAV, and other AList-compatible backends.
- 多源多目标：支持单个或多个源目录同步到单个或多个目标目录。
- 三种同步模式：仅新增、全同步和移动模式，分别适合增量备份、目标镜像和归档迁移。
- 灵活调度：支持手动执行、按分钟间隔执行、Cron 定时执行，以及一键执行全部已启用任务。
- 精确筛选：支持 Gitignore 风格排除规则和最小/最大文件大小过滤。
- 实时进度：展示扫描数量、传输速度、剩余时间，以及已完成、失败、等待和运行中的文件明细。
- 任务管理：运行中的任务可以停止；历史任务可以查看详情、重试未完成项和删除记录。
- 多引擎：可管理多个 AList / OpenList 实例，保存前验证地址和令牌，已保存令牌不会回显。
- 通知渠道：支持自定义 Webhook、Server 酱、钉钉、企业微信和飞书 / Lark；可设置无文件需要同步时静默。
- Webhook 定制：支持 GET / POST / PUT、JSON 请求体模板、自定义请求头和发送测试。
- 在线运行配置：可调整历史任务保留时间、任务超时、复制/扫描并发和失败自动重试次数。
- 账号恢复：首次初始化生成 24 位恢复密钥，支持网页重置密码和
reset-passwordCLI 兜底重置。 - 自适应界面：支持桌面端和移动端布局、浅色/深色主题，任务结束后实时视图会立即更新。
在通知配置页新增通知时，选择“自定义Webhook”即可接入支持 HTTPS 回调的消息服务或自动化平台。
URL为必填项，必须填写有效的 HTTPS Webhook 地址。HTTP方法支持GET、POST、PUT，默认使用POST。GET会把通知标题和内容作为title、content查询参数发送。POST/PUT默认以application/json发送请求体。请求体模板可选，必须是 JSON 对象，支持{title}和{content}占位符；留空时默认发送{"title":"通知标题","content":"通知内容"}。请求头 JSON可选，必须是 JSON 对象，适合填写Authorization、X-Token等鉴权头。- 打开“无需同步时不发送”后，当任务没有需要同步的内容时不会发送通知。
- 保存前可以点击“测试”发送测试消息，确认目标服务能够正常接收。
示例请求体模板：
{
"msg_type": "text",
"text": {
"title": "{title}",
"content": "{content}"
}
}示例请求头：
{
"Authorization": "Bearer your-token"
}推荐使用 Docker Compose 部署：
mkdir -p opensync
cd opensync
curl -O https://raw.githubusercontent.com/chenbin3625/OpenSync/main/docker-compose.yml
docker compose up -d启动后访问：
http://你的设备IP:8023/
首次启动后，打开 Web 页面按提示创建管理员用户名和密码。创建完成时页面会一次性展示 24 位恢复密钥，请立即保存；忘记密码时可用“用户名 + 恢复密钥”在 Web 端设置新密码，成功后旧恢复密钥会失效并生成新的恢复密钥。
如果恢复密钥也丢失，需要登录服务器执行 CLI 兜底重置：
./opensync reset-password --user adminDocker Compose 部署可执行：
[ -f .env ] && . ./.env
docker compose exec --user "${PUID:-1000}:${PGID:-1000}" opensync ./opensync reset-password --user admin默认配置会把运行数据保存到当前目录的 data/ 文件夹。请保留这个目录，它包含数据库、密钥、配置和日志。
容器启动时会根据 PUID 和 PGID 检查 /app/data 的文件归属，并以该用户身份运行 OpenSync，避免宿主机 data/ 目录生成 root 权限文件。默认 UID:GID 为 1000:1000；如需改成其他宿主机用户，可在 .env 中设置 PUID 和 PGID。目录所有者已经匹配时不会重复递归修改，可通过 OPENSYNC_CHOWN=always 强制执行，或通过 OPENSYNC_CHOWN=never 跳过修改。
services:
opensync:
image: chenbin3625/opensync:latest
container_name: opensync
restart: unless-stopped
ports:
- "8023:8023"
volumes:
- ./data:/app/data
environment:
TZ: Asia/Shanghai
PUID: ${PUID:-1000}
PGID: ${PGID:-1000}
OPENSYNC_BIND: 0.0.0.0
OPENSYNC_PORT: 8023
GIN_MODE: release如需固定版本，可以把镜像改为：
image: chenbin3625/opensync:1.10.2docker run -d \
--name opensync \
--restart unless-stopped \
-p 8023:8023 \
-v opensync-data:/app/data \
-e TZ=Asia/Shanghai \
-e OPENSYNC_BIND=0.0.0.0 \
-e OPENSYNC_PORT=8023 \
-e GIN_MODE=release \
chenbin3625/opensync:latest- 备份当前挂载的
data/目录。 - 拉取最新镜像或指定版本镜像。
- 重新启动容器。
- 首次启动会自动执行数据库迁移。
升级时不要删除 data/secret.key，否则旧登录 Cookie 和敏感信息加解密会失效。Web 端密码重置只使用恢复密钥，不会要求输入或暴露 data/secret.key。
定时任务时区始终由 TZ 控制；当 data/config.ini 不存在时，其它启动配置会读取环境变量：
| 变量 | 默认值 | 说明 |
|---|---|---|
TZ |
Asia/Shanghai |
容器和定时任务使用的时区 |
OPENSYNC_BIND |
0.0.0.0 |
HTTP 监听地址 |
OPENSYNC_PORT |
8023 |
HTTP 服务端口 |
OPENSYNC_EXPIRES |
7 |
登录有效期，单位天 |
OPENSYNC_LOG_LEVEL |
1 |
文件日志等级 |
OPENSYNC_CONSOLE_LEVEL |
2 |
控制台日志等级 |
OPENSYNC_LOG_SAVE |
7 |
日志保留天数 |
OPENSYNC_TASK_SAVE |
30 |
历史任务保留天数，0 表示保留全部；过期记录会在保存配置、服务启动和每日凌晨 3:00 自动清理 |
OPENSYNC_TASK_TIMEOUT |
48 |
单次任务超时时间，单位小时，0 表示不限制 |
OPENSYNC_COPY_CONCURRENCY |
5 |
单个任务的复制并发数，范围 1 到 100 |
OPENSYNC_SCAN_CONCURRENCY |
8 |
单个任务的扫描并发数，范围 1 到 20 |
OPENSYNC_MAX_RETRIES |
2 |
单个复制项失败后的最大自动重试次数，0 表示不自动重试 |
OPENSYNC_CHOWN |
自动 | 容器数据目录权限策略：always 强制递归修改，never 跳过，未设置时仅在目录所有者不匹配时修改 |
如果需要使用配置文件，可以创建或通过系统设置页生成 data/config.ini：
[opensync]
bind=0.0.0.0
port=8023
expires=7
log_level=1
console_level=2
log_save=7
task_save=30
task_timeout=48
copy_concurrency=5
scan_concurrency=8
max_retries=2系统设置页可在线调整历史任务保留、任务超时、复制并发、扫描并发和自动重试次数。历史任务会在保存配置时立即清理过期记录，并在每日凌晨 3:00 按保留天数再次清理。端口、日志等级等启动期配置仍建议通过环境变量或配置文件维护。
docker build -t opensync .
docker run -d \
--name opensync \
--restart unless-stopped \
-p 8023:8023 \
-v opensync-data:/app/data \
-e TZ=Asia/Shanghai \
-e OPENSYNC_PORT=8023 \
-e GIN_MODE=release \
opensync先构建前端，构建结果会写入 Go 的静态资源嵌入目录：
cd frontend
npm install
npm run build再构建并运行后端：
cd ../backend
go build -o opensync ./cmd/server
./opensync启动后端：
cd backend
go run ./cmd/server启动前端开发服务：
cd frontend
npm install
npm run dev前端开发服务地址：
http://127.0.0.1:3000/
开发服务会把 /svr 接口代理到：
http://localhost:8023
cd frontend
npm run build
cd ../backend
go test ./...OpenSync 默认推荐使用 Docker Hub 镜像：
chenbin3625/opensync:latestchenbin3625/opensync:1.10.2chenbin3625/opensync:1.10
镜像支持以下平台：
linux/amd64linux/arm64linux/arm/v7
适合常见 x86_64、ARM64 和 ARMv7 架构的飞牛系统、NAS 和服务器设备。
每个正式 Release 会同时上传免 Docker 的二进制压缩包，适合不方便使用容器的环境：
linux-amd64linux-arm64linux-armv7darwin-amd64darwin-arm64windows-amd64windows-arm64
二进制文件已内嵌前端静态资源，解压后运行 opensync 或 opensync.exe 即可。运行数据仍会保存在程序工作目录下的 data/ 目录，请和 Docker 部署一样保留该目录。
- 不要提交或公开
backend/data、Docker 挂载的data/目录或任何包含 AList / OpenList Token 的文件。 data/secret.key会影响登录 Cookie 和敏感信息加解密，部署后应通过持久化目录保留；它不用于 Web 端密码重置。- 如果误分享了运行数据目录，请及时更换 AList / OpenList Token。
- 升级前建议先备份
data/目录。