Synchronizing files between machines using Syncthing

Why Syncthing

为什么选择 Syncthing ？

• 有备份文件/实时同步文件的需求
• 开源可控

Getting Started

Prerequisites:

• 主机间能够进行通信（在同一局域网内/至少有 一台主机具有公网 ip）。

本文的场景为一台阿里云服务器 + 一台本地主机，系统均为 Debian 系，外加一台 Windows10 电脑。系统可能和你的存在差异，你可以在 这里 参考官方的教程。

Installation

你可以在 Community Contributions 根据你的平台选择合适的安装方式。

下面提供了两种安装方式：

• 使用 Docker 安装

• 以 Packages and Bundlings 方式安装。

Run Syncthing in Docker

根据 Example Usage 文档进行配置。

建议使用 docker-compose.yml 文件，方便修改配置，复制对应配置内容，然后输入以下命令启动容器。

docker compse up -d

Debian/Ubuntu Packages

根据 这里 的指令进行安装。

使用以下命令进行启动：

syncthing

NOTE

也可以参照 Cross-platform 安装跨平台版本。

Run Syncthing on Windows

选择跨平台版本进行安装：Cross-platform

由于 Windows 下使用的时最新的 Powershell，需要对安装指令进行修改：

curl.exe -A MS https://webinstall.dev/syncthing | pwsh

安装完毕后重新打开 Powershell，就可以启动 syncthing 了：

syncthing

IMPORTANT

默认端口被占用时，会启动失败。这通常发生在你先使用 VSCode 连接并启动远程服务器的 Syncthing 时，其占用了本地相同端口，从而导致启动失败。

你应当先启动本地 Syncthing，然后再使用 VSCode 启动远程 Syncthing。因为当 VSCode 检测到端口被占用时，会将其转发到未被占用的端口。

Config

TIP

主机的 IP 会被编码到 ID，所以添加远程设备后，便能知道对方地址。

可以把共享文件夹想象成一个点，当主机设置为 发送和接收 时与该点的联系是双向的，仅发送 时箭头指向该点，仅接收 时则从该点指向主机。需要访问该文件夹的主机之间由此建立联系。

实时同步文件夹

1. 添加远程设备：

本地主机启动 Syncthing ，复制其 ID。

在 VSCode 中下载 Remote SSH 插件连接到云服务器，以使用 VSCode 的端口转发功能，从而能在本地配置同步相关的设置，不用开放服务器的端口。

启动云服务器上的 Syncthing ，点击添加远程设备，粘贴本地主机的 ID 。

复制云服务器 ID ，然后在本地主机上添加远程设备。

2. 本地添加同步文件夹：

在常规选项卡设置同步文件夹在本机的路径。

在共享选项卡选择需要同步该文件夹的远程设备。

在高级选项卡设置文件夹类型为 发送和接收 ，可在完整扫描间隔处设置同步间隔。

3. 云服务器重复步骤 2 ，注意：需保证文件夹 ID 一致。

4. 配置云服务器安全组

备份本地主机数据到云服务器

步骤与实时同步文件夹基本相同，只是文件夹类型有差异：

• 本地文件夹类型设置为仅发送

• 云服务器文件夹类型设置为仅接收

TODO:

• 补充图片

Start Syncthing on Startup

IMPORTANT

具体路径可能存在差异，注意使用 which syncthing 查看路径是否与下面服务文件中的路径一致，不一致则需要修改。

Linux

如果你使用的是 Docker 安装方式则一直保持容器处于运行状态即可，如果采用上述提到的非 Docker 安装方式则可参照下列教程进行配置。

vim /etc/systemd/system/syncthing.service

输入以下内容：

[Unit]
Description=Syncthing - Open Source Continuous File Synchronization
After=syslog.target network.target
Wants=network.target

[Service]
User=root
ExecStart=/usr/bin/syncthing -no-browser -no-restart -logflags=0
ExecStop=/usr/bin/killall syncthing
Restart=always

[Install]
WantedBy=multi-user.target

启用脚本：

sudo systemctl enable syncthing.service
sudo systemctl start syncthing.service

查看运行状态：

sudo systemctl status syncthing.service

Windows

按 Windows 键，键入 任务计划程序。

打开后，右键左侧边栏的 任务计划程序库，选择创建任务，对每个选项卡依次按需配置。

• 在常规一栏设置名称即可。

• 触发器一栏设置登录时（当任何用户登录时），防止电脑名更改需要手动启动，启动时。

• 在操作一栏，点击 新建，操作为 启动程序，点击 浏览，找到 C:\Users\<user>\/.local\bin\syncthing.exe ，添加参数 -no-browser -no-restart -logflags=0。

• 建议在条件一栏只勾选 网络。