知识与效率

Obsidian 与 Syncthing:同步本地笔记库

  • 0 次阅读
  • 0 条评论
文章摘要

Obsidian 的笔记库是本地文件夹,可以交给 Syncthing 在设备之间同步。同步和备份解决不同问题,应同时保留历史版本或独立备份。 Obsidian 负责编辑笔记和附件,Syncthing 负责在已配对设备之间同步文件变化。这种分工保留了本地文件夹结构,不需要先把笔记转换成某个平台专有格式。 适合已有多台常用电脑或常开设备的笔记工作流。不同系统的路径、大小写和文件权限可能不同,首次接入先统一目录结构,插件设置和临时缓存可以按需单独决定是否同步。

项目介绍

Obsidian 的笔记库是本地文件夹,可以交给 Syncthing 在设备之间同步。同步和备份解决不同问题,应同时保留历史版本或独立备份。

Obsidian 负责编辑笔记和附件,Syncthing 负责在已配对设备之间同步文件变化。这种分工保留了本地文件夹结构,不需要先把笔记转换成某个平台专有格式。

适合已有多台常用电脑或常开设备的笔记工作流。不同系统的路径、大小写和文件权限可能不同,首次接入先统一目录结构,插件设置和临时缓存可以按需单独决定是否同步。

核心功能

功能 作用与使用方式
本地笔记 Markdown 和附件仍放在自己的文件夹中。
设备配对 仅向选定设备共享目标目录。
增量同步 跟踪文件修改并传递变化。
冲突识别 同时修改时检查冲突副本并人工合并。
版本保留 结合 Syncthing 版本策略与独立备份恢复误改。

功能示意

Obsidian 与 Syncthing 功能示意图

图 1:自制功能示意图,概括本文的使用要点。

项目信息

项目 说明
类型 配置指南
分类 知识与效率
项目仓库 syncthing/syncthing
官方入口或文档 直接访问
整理日期 2026-11-14

群晖 Compose 安装

先完整备份现有 Obsidian vault。本配置将 NAS 笔记目录映射到 /notes,Syncthing 自身的设备配置和索引保存在独立 data 目录。它同步文件,不是具有历史版本保护的云备份。

1. 创建项目目录

群晖先安装并启动 Container Manager。通过 SSH 登录后执行下列命令,只为本项目准备目录:

sudo -i
mkdir -p /volume1/docker/obsidian-syncthing /volume1/docker/obsidian-syncthing/data /volume1/notes
cd /volume1/docker/obsidian-syncthing

2. 保存完整 Compose

在 /volume1/docker/obsidian-syncthing/compose.yaml 保存下面的配置。在 Container Manager 中新建项目时,项目路径选择 /volume1/docker/obsidian-syncthing 并导入该文件;有 .env 的项目要保留它与 Compose 在同一目录。

services:
  obsidian-syncthing:
    image: syncthing/syncthing:latest
    container_name: obsidian-syncthing
    restart: unless-stopped
    ports:
    - 8384:8384
    - 22000:22000/tcp
    - 22000:22000/udp
    - 21027:21027/udp
    volumes:
    - /volume1/docker/obsidian-syncthing/data:/var/syncthing
    - /volume1/notes:/notes
    environment:
      PUID: '0'
      PGID: '0'
      TZ: Asia/Shanghai

挂载参数冒号左侧是群晖的实际目录,右侧是应用内目录。以上只挂载本项目所需的数据;若已有同类数据,请先备份再调整路径。端口冲突时只改宿主机一侧,应用内端口保持不变。

3. 检查、拉取与启动

cd /volume1/docker/obsidian-syncthing
docker compose config --quiet
docker compose pull
docker compose up -d
docker compose ps
docker compose logs --tail=100

浏览器访问 http://群晖IP:8384。群晖IP 替换为自己的 NAS 局域网地址;首次启动时先等待初始化,再检查日志。若群晖仍使用旧 Docker 套件且只有 docker-compose,将命令中的 docker compose 替换为对应命令。

首次使用与验证

打开 8384 后设置 GUI 用户名和强密码。在 NAS 添加文件夹 /notes,与自己的客户端通过设备 ID 配对,保持两端文件夹 ID 一致。先测试一个独立小 vault,验证冲突副本、删除传播和排除规则,再接入正式笔记。不要让多个不同同步插件同时写同一个 vault。

先保存一条测试数据或完成一次最小任务,再执行 docker compose restart,确认设置及应该持久化的数据仍在。无服务端持久化目录的纯前端工具,应通过自身导出功能保存工作结果。

常见问题

  • 页面打不开:运行 docker compose ps 检查状态;查看日志里的初始化错误,核对端口冲突和 DSM 防火墙。不要把容器的 IP 当作固定访问地址。
  • 数据目录为空:应用内应填写 Compose 冒号右侧的目录;核对宿主机文件是否已放到对应左侧目录。
  • 目录无法写入:先查看日志和目录权限,仅为对应数据目录授予镜像实际运行用户需要的权限,不对整个 /volume1 设置 777。
  • 拉取镜像失败:先排查 Container Manager 的仓库网络;应用自己的 HTTP 代理设置与 Docker 守护进程拉取镜像的代理设置是两件事。

更新、备份与停止

更新前保存 compose.yaml,并备份上面映射的项目数据。数据库服务应先使用自身的数据库备份,或停止整个项目后复制完整数据目录,不能只复制运行中的单个数据库文件。

cd /volume1/docker/obsidian-syncthing
docker compose pull
docker compose up -d
docker compose logs --tail=100

临时停止使用 docker compose stop,重新启动使用 docker compose start。卸载容器用 docker compose down,不要附加 -v,也不要直接删除宿主机数据目录。涉及数据库迁移的升级,先保留原镜像版本和完整备份,再安排维护窗口。

官方资料