From b85be20cba95603ce94e269374785a5d4e4a2d2d Mon Sep 17 00:00:00 2001 From: xiaoyaofenfen <1254525673@qq.com> Date: Thu, 29 Sep 2022 19:48:25 +0800 Subject: [PATCH] update document for sync command --- README.md | 11 +++++++++-- docker/sync/Dockerfile | 2 ++ docker/sync/app.sh | 2 +- docker/sync/docker-compose.yml | 5 ++++- docs/manual.md | 20 ++++++++++++++++++-- 5 files changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 062d0d8..f733bb6 100644 --- a/README.md +++ b/README.md @@ -81,13 +81,14 @@ sudo curl -fsSL http://file.tickstep.com/rpm/aliyunpan/aliyunpan.repo | sudo tee 2. 备份云盘文件，即下载网盘文件到本地，始终保持网盘的文件有一个完整的备份在本地 3. 双向备份，保持网盘文件和本地文件严格一致 ``` -docker run -d --name=aliyunpan-sync --restart=always -v ":/home/app/data" -e TZ="Asia/Shanghai" -e ALIYUNPAN_REFRESH_TOKEN="" -e ALIYUNPAN_PAN_DIR="" -e ALIYUNPAN_SYNC_MODE="upload" tickstep/aliyunpan-sync:v0.2.1 +docker run -d --name=aliyunpan-sync --restart=always -v ":/home/app/data" -e TZ="Asia/Shanghai" -e ALIYUNPAN_REFRESH_TOKEN="" -e ALIYUNPAN_PAN_DIR="" -e ALIYUNPAN_SYNC_MODE="upload" -e ALIYUNPAN_TASK_STEP="sync" tickstep/aliyunpan-sync:v0.2.1 ：本地目录绝对路径，例如：/tickstep/Documents/设计文档 ALIYUNPAN_PAN_DIR：云盘目录 ALIYUNPAN_REFRESH_TOKEN：RefreshToken ALIYUNPAN_SYNC_MODE：备份模式，支持三种: upload(备份本地文件到云盘),download(备份云盘文件到本地),sync(双向同步备份) +ALIYUNPAN_TASK_STEP：任务步骤, 支持两种: scan(只扫描并建立同步数据库),sync(正常启动同步任务)。如果你同步目录文件非常多，首次运行最好先跑一次scan步骤，然后再正常启动文件同步任务 ``` 更详情文档请参考dockerhub网址：[tickstep/aliyunpan-sync](https://hub.docker.com/r/tickstep/aliyunpan-sync) @@ -244,10 +245,16 @@ aliyunpan:/ tickstep$ upload /Users/tickstep/Downloads/apt.zip /tmp ### 同步备份文件 同步备份功能，支持备份本地文件到云盘，备份云盘文件到本地，双向同步备份三种模式。支持JavaScript插件对备份文件进行过滤。 -使用以下命令运行即可，该命令是阻塞的不会退出。 + +***注意：如果同步目录下有非常多的文件，最好在首次备份前先运行一次scan任务，等scan任务完成并建立起同步数据库后，再正常启动同步任务。这样同步任务可以更加快速同步并且能有效避免同步重复文件。*** + 例如：将本地目录 `/tickstep/Documents/设计文档` 中的文件备份上传到云盘目录 `/备份盘/我的文档` ```shell +首次运行建议先扫描并构建同步数据库，如下： +aliyunpan:/ tickstep$ sync start -ldir "/tickstep/Documents/设计文档" -pdir "/备份盘/我的文档" -mode "upload" -step scan + +然后再正常启动同步任务，如下： aliyunpan:/ tickstep$ sync start -ldir "/tickstep/Documents/设计文档" -pdir "/备份盘/我的文档" -mode "upload" 启动同步备份进程 diff --git a/docker/sync/Dockerfile b/docker/sync/Dockerfile index eb2e624..317d050 100644 --- a/docker/sync/Dockerfile +++ b/docker/sync/Dockerfile @@ -60,6 +60,8 @@ ENV ALIYUNPAN_PAN_DIR=/sync_drive ENV ALIYUNPAN_SYNC_MODE=upload ENV ALIYUNPAN_SYNC_PRIORITY=time ENV ALIYUNPAN_SYNC_LOG=false +ENV ALIYUNPAN_LOCAL_DELAY_TIME=3 +ENV ALIYUNPAN_TASK_STEP=sync # 运行 ENTRYPOINT ./app.sh \ No newline at end of file diff --git a/docker/sync/app.sh b/docker/sync/app.sh index 26d2261..03aaf9c 100755 --- a/docker/sync/app.sh +++ b/docker/sync/app.sh @@ -40,4 +40,4 @@ else fi ./aliyunpan config set -transfer_url_type ${ALIYUNPAN_TRANSFER_URL_TYPE} -./aliyunpan sync start -dp ${ALIYUNPAN_DOWNLOAD_PARALLEL} -up ${ALIYUNPAN_UPLOAD_PARALLEL} -dbs ${ALIYUNPAN_DOWNLOAD_BLOCK_SIZE} -ubs ${ALIYUNPAN_UPLOAD_BLOCK_SIZE} -log ${ALIYUNPAN_SYNC_LOG} +./aliyunpan sync start -dp ${ALIYUNPAN_DOWNLOAD_PARALLEL} -up ${ALIYUNPAN_UPLOAD_PARALLEL} -dbs ${ALIYUNPAN_DOWNLOAD_BLOCK_SIZE} -ubs ${ALIYUNPAN_UPLOAD_BLOCK_SIZE} -log ${ALIYUNPAN_SYNC_LOG} -ldt ${ALIYUNPAN_LOCAL_DELAY_TIME} -step ${ALIYUNPAN_TASK_STEP} diff --git a/docker/sync/docker-compose.yml b/docker/sync/docker-compose.yml index 95f9092..ffcd756 100644 --- a/docker/sync/docker-compose.yml +++ b/docker/sync/docker-compose.yml @@ -33,4 +33,7 @@ services: - ALIYUNPAN_SYNC_PRIORITY=time # 是否显示文件备份过程日志，true-显示，false-不显示 - ALIYUNPAN_SYNC_LOG=true - + # 本地文件修改检测延迟间隔，单位秒。如果本地文件会被频繁修改，例如录制视频文件，配置好该时间可以避免上传未录制好的文件 + - ALIYUNPAN_LOCAL_DELAY_TIME=3 + # 任务步骤, 支持两种: scan(只扫描并建立同步数据库),sync(正常启动同步任务) + - ALIYUNPAN_TASK_STEP=sync diff --git a/docs/manual.md b/docs/manual.md index 50cda14..c1993ba 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -485,6 +485,8 @@ aliyunpan share mc share_folder/ 备份功能一般用于NAS等系统，进行文件备份。比如备份照片，就可以使用这个功能定期备份照片到云盘，十分好用。 +***如果你同步目录下有非常多的文件，最好在首次备份前先运行一次scan任务，等scan任务完成并建立起同步数据库后，再正常启动同步任务。这样同步任务可以更加快速并且能有效避免同步重复文件。*** + ### 常用命令说明 ``` 查看同步备份功能说明 @@ -508,6 +510,10 @@ aliyunpan sync start 使用配置文件启动同步备份服务，并配置下载并发为2，上传并发为1，下载分片大小为256KB，上传分片大小为1MB aliyunpan sync start -dp 2 -up 1 -dbs 256 -ubs 1024 + +当你本地同步目录文件非常多，或者云盘同步目录文件非常多，为了后期更快更精准同步文件，可以先进行文件扫描并构建同步数据库，然后再正常启动同步任务。如下所示： +aliyunpan sync start -step scan +aliyunpan sync start ``` ### 备份配置文件说明 @@ -649,12 +655,14 @@ D:\Program Files\aliyunpan>alisync stop 1. 直接运行 ``` -docker run -d --name=aliyunpan-sync --restart=always -v ":/home/app/data" -e TZ="Asia/Shanghai" -e ALIYUNPAN_REFRESH_TOKEN="" -e ALIYUNPAN_PAN_DIR="" -e ALIYUNPAN_SYNC_MODE="upload" tickstep/aliyunpan-sync - +docker run -d --name=aliyunpan-sync --restart=always -v ":/home/app/data" -e TZ="Asia/Shanghai" -e ALIYUNPAN_REFRESH_TOKEN="" -e ALIYUNPAN_PAN_DIR="" -e ALIYUNPAN_SYNC_MODE="upload" -e ALIYUNPAN_TASK_STEP="sync" tickstep/aliyunpan-sync: + + ：本地目录绝对路径，例如：/tickstep/Documents/设计文档 ALIYUNPAN_PAN_DIR：云盘目录 ALIYUNPAN_REFRESH_TOKEN：RefreshToken ALIYUNPAN_SYNC_MODE：备份模式，支持三种: upload(备份本地文件到云盘),download(备份云盘文件到本地),sync(双向同步备份) +ALIYUNPAN_TASK_STEP：任务步骤, 支持两种: scan(只扫描并建立同步数据库),sync(正常启动同步任务)。如果你同步目录文件非常多，首次运行最好先跑一次scan步骤，然后再正常启动文件同步任务 ``` 2. docker-compose运行 @@ -692,6 +700,14 @@ services: - ALIYUNPAN_PAN_DIR=/备份盘/我的文档 # 备份模式：upload(备份本地文件到云盘), download(备份云盘文件到本地), sync(双向同步备份) - ALIYUNPAN_SYNC_MODE=upload + # 优先级，只对双向同步备份模式有效。选项支持三种: time-时间优先，local-本地优先，pan-网盘优先 + - ALIYUNPAN_SYNC_PRIORITY=time + # 是否显示文件备份过程日志，true-显示，false-不显示 + - ALIYUNPAN_SYNC_LOG=true + # 本地文件修改检测延迟间隔，单位秒。如果本地文件会被频繁修改，例如录制视频文件，配置好该时间可以避免上传未录制好的文件 + - ALIYUNPAN_LOCAL_DELAY_TIME=3 + # 任务步骤, 支持两种: scan(只扫描并建立同步数据库),sync(正常启动同步任务) + - ALIYUNPAN_TASK_STEP=sync ``` 3. sync_handler.js插件说明