Syncthing文件版本管理机制详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00763/article/details/148323627

Syncthing文件版本管理机制详解

syncthing Open Source Continuous File Synchronization 项目地址: https://gitcode.com/gh_mirrors/sy/syncthing

什么是文件版本管理

Syncthing的文件版本管理功能允许用户在文件被其他节点删除或替换时自动保留旧版本备份。这个功能在文件夹级别进行配置，且针对每个同步设备可以单独设置，默认情况下是关闭的。

重要说明：版本管理仅适用于从其他设备接收的变更。也就是说，如果Alice开启了版本管理而Bob修改了文件，当这个变更从Bob同步到Alice时，旧版本会在Alice的设备上被归档。如果Alice在本地直接修改文件，Syncthing不会也无法归档旧版本。

版本管理策略类型

Syncthing提供了四种版本管理策略，每种策略都有其独特的工作方式和适用场景。

1. 回收站模式(Trash Can)

这种策略模拟了常见的"回收站"行为：

当文件因远程设备变更被删除或替换时，会被移动到.stversions文件夹（类似回收站）
如果回收站中已存在同名文件，则会被新版本覆盖

配置选项：

cleanoutDays：设置文件在回收站中的保留天数，设为0表示永久保留

2. 简单版本管理(Simple)

这种策略在回收站模式基础上增加了版本保留数量控制：

文件被移动到.stversions文件夹
可以设置保留的旧版本数量（如设置为5则保留最近的5个版本）
同样支持cleanoutDays清理设置

3. 阶梯式版本管理(Staggered)

这种策略提供了更智能的版本保留机制，根据文件修改时间自动调整保留策略：

| 时间区间 | 保留规则 | |---------|----------| | 第1小时 | 每30秒保留最早版本 | | 第1天 | 每小时保留最早版本 | | 前30天 | 每天保留最早版本 | | 超过30天 | 每周保留最早版本 | | 最大保留时间 | 通过maxAge设置(天) |

特点：

自动删除超过最大保留时间的版本
每个时间区间只保留一个版本
保留最早的版本而非最新版本，确保文件被覆盖时能保留原始内容

4. 外部命令管理(External)

这种策略允许用户通过外部脚本或程序自定义版本管理行为：

在文件被替换前执行指定命令
命令必须负责移除原文件，否则Syncthing会报错
支持两个模板参数：
- %FOLDER_PATH%：文件夹绝对路径
- %FILE_PATH%：文件夹内文件相对路径

实用示例

Unix/Linux示例：实现回收站功能

#!/bin/sh
versionspath=~/.trashcan
folderpath="$1"
filepath="$2"
outpath=$(dirname "$versionspath/$filepath")
mkdir -p "$outpath"
mv -f "$folderpath/$filepath" "$versionspath/$filepath"

Windows CMD示例：

@echo off
set "versions_path=%USERPROFILE%\.trashcan"
set "folder_path=%~1"
set "file_path=%~2"
for %%f in ("%versions_path%\%file_path%") do set "output_path=%%~dpf"
if not exist "%output_path%" md "%output_path%" || exit /b
move /y "%folder_path%\%file_path%" "%versions_path%\%file_path%"

Windows PowerShell示例：移动到回收站

Add-Type -AssemblyName Microsoft.VisualBasic
[Microsoft.VisualBasic.FileIO.FileSystem]::DeleteFile($args,'OnlyErrorDialogs','SendToRecycleBin')
if ($?) {
  Write-Output ("Recycled " + $args + ".")
}

配置参数详解

版本管理配置位于文件夹配置的versioning部分，主要参数包括：

基础参数：
- type：版本策略类型(trashcan/simple/staggered/external)
- fsPath：版本存储路径(默认为.stversions)
- fsType：文件系统类型(通常保持默认)
- cleanupIntervalS：清理间隔(秒)
策略特定参数：
- cleanoutDays：文件保留天数
- keep：保留版本数量(Simple策略)
- maxAge：最大保留时间(秒，Staggered策略)
- command：外部命令路径(External策略)