profileName: youpingfang postId: 274 postType: post categories:

- 5

Fast Note Sync Service 使用指南

概述

Fast Note Sync Service 是一款基于 Golang + WebSocket + React 构建的高性能笔记同步服务,专为 Obsidian 用户设计。它提供了毫秒级实时同步、远端 REST API 服务平台,需配合客户端插件 Obsidian Fast Note Sync Plugin 使用。

核心功能

同步能力

  • 多端实时同步:笔记变更毫秒级实时分发至所有在线设备,支持 Vault 自动创建
  • 附件同步:完美支持图片等非笔记文件,提供大附件分片上传下载功能
  • 配置同步:支持 .obsidian 配置文件和 PDF 进度状态同步
  • 目录同步:支持文件夹的创建、重命名、移动、删除同步
  • 离线同步:支持笔记离线编辑自动合并,离线删除后重连自动补全或删除同步

高级特性

  • 笔记历史:可在 Web 和插件端查看每个笔记的历史修改版本(需服务端 v1.2+)
  • 回收站:支持笔记删除后进入回收站,支持恢复功能
  • 分享功能:支持笔记分享、自动解析分享笔记中的图片和音视频附件、提供访问统计、密码保护和短链接
  • Git 自动化:附件和笔记变更时自动更新并推送至远程 Git 仓库,任务结束后自动释放内存

扩展能力

  • MCP 原生支持:可作为 MCP 服务端接入 Cherry Studio、Cursor 等 AI 客户端,让 AI 具备读写私人笔记与附件的能力
  • REST API 支持:提供标准 REST API 接口,支持编程方式对 Obsidian 笔记进行增删改查
  • Web 管理面板:内置现代化管理界面,可创建用户、生成插件配置、管理仓库及笔记内容
  • 多存储备份:适配 S3/OSS/R2/WebDAV/本地等多种存储协议,支持全量/增量 ZIP 定时归档备份,支持 Vault 单向镜像同步至远程存储,支持自定义保留天数
  • 多数据库支持:原生支持 SQLite、MySQL、PostgreSQL 等主流数据库

快速部署

方式一:一键脚本(推荐)

bash <(curl -fsSL https://raw.githubusercontent.com/haierkeys/fast-note-sync-service/master/scripts/quest_install.sh)

中国地区使用腾讯镜像源:

bash <(curl -fsSL https://cnb.cool/haierkeys/fast-note-sync-service/-/git/raw/master/scripts/quest_install.sh) --cnb

脚本自动下载适配当前系统的 Release 二进制文件,默认安装至 /opt/fast-note,创建全局快捷命令 fns,配置 Systemd(Linux)或 Launchd(macOS)服务实现开机自启。

方式二:Docker 部署

Docker Run:

docker run -tid --name fast-note-sync-service \
    -p 9000:9000 \
    -v /data/fast-note-sync/storage/:/fast-note-sync/storage/ \
    -v /data/fast-note-sync/config/:/fast-note-sync/config/ \
    haierkeys/fast-note-sync-service:latest

Docker Compose: 创建 docker-compose.yaml 文件后执行 docker compose up -d

方式三:手动二进制安装

Releases 下载对应系统版本,解压后运行:

./fast-note-sync-service run -c config/config.yaml

使用流程

  1. 访问管理面板:在浏览器打开 http://{服务器IP}:9000
  2. 初始化设置:首次访问需注册账号(如需关闭注册功能,在配置文件中设置 user.register-is-enable: false
  3. 配置客户端:登录管理面板,点击 "复制 API 配置"
  4. 连接 Obsidian:打开 Obsidian 插件设置页面,粘贴配置信息即可

相关资源

可以看看一些闪光点的地方: 同步到 github image.png 同步到 webdav 等存储库 image.png 一键授权: image.png