5 分钟部署 Fast Note Sync Service:Docker 一键搭建 Obsidian 私有笔记同步服务器教程
【免费下载链接】fast-note-sync-serviceHigh-performance, low-latency note synchronization, online management, and remote REST API service platform.项目地址: https://gitcode.com/gh_mirrors/fa/fast-note-sync-service
Fast Note Sync Service(简称 FNS)是一个高性能、低延迟的 Obsidian 笔记同步服务器,提供在线笔记管理和远程 REST API 服务。本教程带你通过 Docker 一键部署 FNS,5 分钟内拥有属于自己的私有笔记同步平台,实现多设备实时同步、附件同步与 Web 管理面板。
一、Fast Note Sync Service 是什么?📝
FNS 是一款基于 Golang + WebSocket + React 构建的自建笔记同步服务,需要配合 Obsidian 客户端插件使用。它的核心能力包括:
- 🔄多设备实时同步:笔记变更毫秒级推送到所有在线设备
- 🖼️附件同步:图片等大文件支持分块上传下载
- 💻Web 管理面板:浏览器直接管理库(Vault)、笔记和附件
- 🗄️多数据库支持:原生支持 SQLite、MySQL、PostgreSQL
- ⚙️REST API / MCP:可通过脚本或 AI 助手(如 Cherry Studio、Cursor)读写笔记
部署完成后,你可以像下面这样在浏览器中管理自己的笔记库,查看每个 Vault 的笔记数量与存储占用:
二、部署前准备:环境与端口说明
开始之前,请确认你的服务器已安装 Docker,并了解 FNS 使用的两个端口:
| 端口 | 用途 |
|---|---|
9000 | REST API + WebSocket 同步接口(/api/user/sync) |
9001 | 监控/度量端口 |
数据方面,FNS 依赖两个挂载目录,建议放在持久化磁盘上:
/data/fast-note-sync/storage/:笔记、附件、日志等数据/data/fast-note-sync/config/:配置文件(默认为 config/config.yaml)
三、一键启动:Docker Run 方式 🚀
只需两条命令即可完成部署:
# 1. 拉取官方镜像 docker pull haierkeys/fast-note-sync-service:latest # 2. 启动容器 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 ps中状态为Up,说明服务已成功运行。
💡 容器内部通过 docker/entrypoint.sh 自动创建日志目录并启动服务,日志滚动保存在
storage/logs/下,无需额外配置。
四、进阶方式:Docker Compose 部署
如果你希望服务随机器重启自动拉起,推荐使用 Compose 方式。参考仓库中的 docker/docker-compose.yaml,核心内容如下:
services: fast-note-sync-service: image: haierkeys/fast-note-sync-service:latest container_name: fast-note-sync-service restart: always ports: - "9000:9000" volumes: - ./storage:/fast-note-sync/storage - ./config:/fast-note-sync/config然后执行docker compose up -d即可。仓库还提供了带 Nginx 反向代理的完整示例,见 scripts/docker-composer/。
五、首次配置:注册管理员并连接 Obsidian
- 浏览器打开
http://服务器IP:9000 - 首次访问注册账号,该账号即为管理员(如需关闭注册功能,可在配置文件中将
user.register-is-enable设为false) - 登录后点击"Copy API Config"复制配置
- 打开 Obsidian 插件设置页,粘贴刚才复制的配置并保存
连接成功后,Obsidian 中的笔记会实时同步到服务器。在 Web 面板中,你可以按路径、内容或正则搜索笔记,并在线查看、编辑、恢复历史版本:
图片、音频等附件同样会同步上来,支持在线预览与浏览器直接下载:
六、管理面板上手:设置与版本检查
进入"系统设置"页面,可以查看当前版本、检查更新、自定义 Web 界面配色与字体,以及管理鉴权 Token 加密密钥。日常更新只需docker pull后重建容器,挂载的config/与storage/目录保证数据不受影响:
七、常见问题排查 🔧
打不开 9000 端口?检查云服务器安全组/防火墙是否放行,以及docker logs fast-note-sync-service中是否有报错。
想换端口?修改docker run的-p 9000:9000中左侧端口即可,容器内端口保持不变。
如何升级到新版本?
docker pull haierkeys/fast-note-sync-service:latest docker stop fast-note-sync-service docker rm fast-note-sync-service # 重新执行上面的 docker run 命令备份怎么办?定期备份storage/目录即可;服务也内置了面向 S3、OSS、WebDAV 等的定时 ZIP 备份与镜像同步能力,详见配置文件 config/config.yaml 中storage相关段落。
到这里,你的 Obsidian 私有笔记同步服务器就已经搭建完成了。接下来可以为每台设备安装插件、连接服务器,体验毫秒级的多端实时同步吧!
【免费下载链接】fast-note-sync-serviceHigh-performance, low-latency note synchronization, online management, and remote REST API service platform.项目地址: https://gitcode.com/gh_mirrors/fa/fast-note-sync-service
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考