Posted in手册

Obsidian Sync Vault 设备互联模式配置指南

简介

Obsidian Sync Vault 插件的设备互联模式是一个基于 WebSocket 和 Yjs 的点对点实时同步功能，让多个设备之间可以实时同步笔记内容，无需通过云盘中转。本文将介绍如何配置和使用这个功能。

前提条件

  • 已安装 Obsidian Sync Vault 插件
  • 已完成插件激活
  • 了解基本的网络知识

配置步骤

1. 启用实时同步模式

  1. 打开 Obsidian 设置
  2. 找到 Sync Vault 插件设置
  3. 在”开始使用”部分，找到”设备互联模式”开关
  4. 打开开关启用设备互联模式

2. 配置信令服务器

设备互联模式需要一个 WebSocket 信令服务器来帮助建立点对点连接。你可以：

  • 使用默认配置：ws://localhost:1234（本地测试用）
  • 使用自己搭建的服务器
  • 使用公共可用的信令服务器

自建服务器步骤

  1. 准备一台具有公网 IP 的服务器（或者局域网内设备可访问的机器）
  2. 安装 Node.js 环境
  3. 安装并运行 webrtc-signaling-server 服务器：
$ git clone git@github.com:abcamus/webrtc-signaling-server.git
$ cd webrtc-signaling-server
$ npm install && npm run build && npm start
$ npm install && npm run docker:build && npm run docker:run # docker

3. 配置房间名称

房间名称用于标识同步组，确保需要同步的设备都使用相同的房间名称。默认使用当前 vault 的名称。

4. 开始使用

配置完成后，打开相同仓库的设备之间将自动建立连接并开始同步。

注意事项

  1. 确保所有设备都能访问到信令服务器
  2. 使用公共服务器时注意数据安全
  3. 建议在局域网环境下使用自建服务器
  4. 实时同步模式开启时会自动关闭云盘同步功能

常见问题

  1. 设备未连接
  • 检查服务器地址是否正确
  • 确认服务器是否正常运行
  • 检查网络连接

技术原理

实时同步模式基于以下技术：

  • WebSocket：用于建立持久连接
  • Yjs：实现文档的实时协同编辑
  • WebRTC：实现点对点通信

后续计划

  • 添加权限控制功能
  • 优化冲突处理机制
  • 提供更多服务器选项
  • 支持离线编辑

欢迎通过 GitHub Issues 提供反馈和建议。

Tags: