# Sync同步管家 **Repository Path**: cncsrf/SyncManager ## Basic Information - **Project Name**: Sync同步管家 - **Description**: No description available - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-13 - **Last Updated**: 2026-11-16 ## Categories & Tags **Categories**: Uncategorized **Tags**: sync同步 ## README # 同步管家 SyncManager 轻量级、可自托管的 **rsync / rclone 同步备份管理平台**。把复杂的命令行装进网页里:鼠标点点点,就能完成网站发布、数据备份等单向同步任务,并纳管多台服务器与对象存储,全程有日志可查。 ![License](https://img.shields.io/badge/License-MIT-blue) ![Python](https://img.shields.io/badge/Python-3.11+-green) ![Vue](https://img.shields.io/badge/Vue-3-brightgreen) ## 一、项目简介 rsync 本身是极优秀的数据同步引擎,但命令行参数繁杂(`-avz --delete --exclude`、SSH 端口、密钥认证……),没有文档沉淀的人很难用对。**同步管家**解决的就是这个问题: - **统一管理**:一个网页纳管多台服务器,无需逐台登录敲命令 - **开箱即用**:单容器部署,SQLite 内置,装完即用 - **自托管**:全部组件跑在自己的机器上,数据不出内网 - **可视化**:同步方式、传输结果、历史日志全部页面可查 ## 二、核心功能 | 模块 | 能力 | |------|------| | 服务器管理 | 增删改查、一键测试 SSH 连接;支持密码(Fernet 加密存储)与私钥两种认证 | | 对象存储 | 目标支持腾讯云 COS / 阿里 OSS / AWS S3 等(rclone s3 协议) | | 同步任务 | 源/目标服务器与目录、`--delete` 镜像删除、传输压缩 `-z`、排除规则(通配符,每行一条);保存时自动校验源目录是否存在 | | 比对方式 | **标准**(mtime+size)/ **仅比对大小**(`--size-only`,忽略 mtime 变化)/ **校验和**(`-c`) | | 同步方式 | **手动** / **定时**(每天、每周、按小时间隔)/ **监控**(定期对比源目录快照,有变化才同步),任务可暂停/恢复调度,同任务不重叠执行 | | 同步预览 | Dry-Run 预览将要传输/删除的文件,不真正执行(开启 `--delete` 前建议先预览) | | 同步日志 | 按任务/状态/时间范围筛选、分页浏览,详情含同步工具完整输出与错误信息;自动保留最近 500 条 | | 配置备份 / 恢复 | 一键备份全部配置(数据库 + 加密密钥)下载到本地;上传备份包一键恢复,恢复前自动备份当前数据,恢复后自动重启 | > **说明**:同步为**单向**(源 → 目标),这是网站发布、数据备份的标准方式;目标端的修改不会反向同步回源端。创建任务时页面内有明确提示。 ## 三、系统架构 ``` ┌──────────┐ HTTPS ┌─────────────────────────────┐ │ 浏览器 │ ────────→ │ SyncManager 容器 (:8080) │ └──────────┘ │ ├─ Vue3 静态页面 │ │ ├─ FastAPI (REST API) │ │ ├─ 线程池(异步执行 rsync) │ │ ├─ 调度线程(定时/监控触发) │ │ └─ SQLite (/data) │ └──────────┬──────────┬────────┘ │ SSH │ SSH ┌─────▼────┐ ┌───▼──────┐ │ 服务器 A │ │ 服务器 B │ │ /var/www │ │ /var/www │ └──────────┘ └──────────┘ ``` - 单容器运行:FastAPI 同端口(8080)提供页面与 API,无外部数据库、无消息队列 - 同步执行由容器直接发起:SSH 目标走 rsync,对象存储目标走 rclone(s3 协议);源或目标为本机时按本地路径执行 - SQLite 存储服务器凭据(Fernet 加密)、任务配置与同步日志 ## 四、环境要求 - Docker & Docker Compose - 被同步的两端机器:`rsync` + 可用的 SSH 服务(Ubuntu 24.04 多数已预装 rsync,无则 `apt install -y rsync openssh-client`) - 网络放行:管理端到各服务器的 SSH 端口(默认 22,自定义端口在页面填写) ## 五、安装部署 镜像已发布到 Docker Hub:[ad80a1/syncmanager](https://hub.docker.com/r/ad80a1/syncmanager) **方式一:docker run 一条命令** ```bash docker pull ad80a1/syncmanager:latest docker run -d --name syncmanager -p 8080:8080 \ -v syncmanager-data:/data \ -v /var/www:/var/www \ -e MANAGER_HOST=192.168.1.10 \ --restart unless-stopped \ ad80a1/syncmanager:latest ``` - `-v syncmanager-data:/data`:数据库与加密密钥(必须) - `-v /var/www:/var/www`:把本机待同步目录挂进容器(按需修改路径;仅同步远程目录时可省略) - `MANAGER_HOST`:改成部署 SyncManager 的主机 IP,源/目标填这个 IP 时按本地路径执行 **方式二:Docker Compose** ```bash mkdir -p /opt/syncmanager && cd /opt/syncmanager # 下载本仓库的 docker-compose.yml(镜像版,免构建) docker compose up -d ``` 访问 `http://服务器IP:8080` 即可使用。数据(数据库 + 加密密钥)持久化在 `syncmanager-data` 卷(compose 方式为 `api-data` 卷)中。 > 部署前请把 compose 中的 `MANAGER_HOST` 改成本机实际 IP。 ## 演示截图 ![仪表盘](screenshots/dashboard.jpg) ## 六、快速使用 1. 浏览器打开 `http://服务器IP:8080`,用 `admin / admin888` 登录,**立即修改默认密码** 2. 「服务器管理」→ 添加源服务器和目标服务器(填 IP、SSH 端口、用户名、密码或私钥),点「测试连接」确认可用 3. 「同步任务」→ 创建任务:选源服务器/目录 → 目标服务器/目录,按需开启 `--delete`、压缩、排除规则 4. 点「预览」确认将要传输/删除的文件,再点「立即同步」 5. 「同步日志」查看每次传输的文件数、大小与完整同步输出 6. 需要自动化?编辑任务把同步方式改为「定时」或「监控」 ## 七、默认端口 | 端口 | 用途 | |------|------| | 8080 | Web 界面 + REST API(同端口) | ## 八、仓库目录结构 ``` SyncManager/ ├── docker-compose.yml # 单服务编排 ├── Dockerfile # 多阶段构建(前端编译 + Python 运行时) ├── LICENSE # MIT ├── backend/ │ ├── requirements.txt │ └── app/ │ ├── main.py # FastAPI 入口 + 认证中间件 + 静态托管 │ ├── config.py # 配置(数据库、加密密钥、日志保留) │ ├── database.py # SQLAlchemy 引擎 + 轻量列迁移 │ ├── models.py # User / Token / Server / SyncTask / SyncLog │ ├── schemas.py # Pydantic 模型与表单校验 │ ├── auth.py # PBKDF2 密码哈希 + token 签发 │ ├── security.py # Fernet 加解密(服务器密码/私钥) │ ├── rsync_executor.py # rsync 命令构建、执行、结果解析 │ ├── object_storage.py # rclone 命令构建(对象存储目标)与统计解析 │ ├── runner.py # 线程池执行同步、按目标类型分流引擎、连接测试 │ ├── scheduler.py # 定时/监控调度线程 + 日志清理 │ └── routers/ # auth / servers / tasks / logs / dashboard └── frontend/ └── src/ ├── views/ # Dashboard / Servers / Tasks / Logs / Help / Login ├── components/ # StatusTag / FooterBar / Logo ├── api/index.js # axios 封装(token、统一错误处理) └── router/ # 路由 + 登录守卫 ``` ## 九、配套文档 - [开发文档](开发文档.md):架构详解、数据模型、API 一览、二次开发指南、排查手册 ## 十、注意事项 - **首次登录后请立即修改默认密码** `admin888` - 服务器密码使用 Fernet 对称加密入库;密钥随数据库一起存放在数据卷,请通过环境变量 `FERNET_KEY` 固定密钥以便迁移 - 推荐使用 SSH 密钥认证;使用密码认证时,两端密码需一致(sshpass 机制限制) - 排除规则、`--delete` 等参数影响数据安全,建议开启 `--delete` 前先使用「预览」 - 同步日志默认保留最近 500 条,可在 compose 中通过 `LOG_KEEP_COUNT` 调整 ## 开源协议 [MIT](LICENSE)