obsidian-livesync

应用介绍

Self-hosted LiveSync (Obsidian LiveSync) 是 Obsidian 笔记的社区开发同步插件，可以让你在所有设备之间实时同步你的 Obsidian 笔记库，完全自建服务器，不需要依赖官方的同步服务，保护你的笔记隐私。

Obsidian LiveSync 支持多种后端存储，可以使用 CouchDB 或者对象存储系统（如 MinIO、S3、Cloudflare R2 等），还支持基于 WebRTC 的点对点直接同步，不需要中转服务器。

主要功能特点： - 高效同步：最小化流量，只同步变更的部分 - 冲突处理：能够有效处理修改冲突，自动合并简单冲突 - 端到端加密：支持端到端加密保护你的笔记内容 - 同步设置：可以同步配置、代码片段、主题和插件 - 点对点同步：支持 WebRTC P2P 直接同步，不需要中心服务器 - 完全自托管：使用开源解决方案搭建自己的同步服务，数据完全可控

对于需要完全掌控笔记数据的研究人员、工程师和开发者来说，这是一个理想的解决方案，让你的笔记完全私有，不用担心第三方服务的数据收集。

安装说明

前提依赖

在NAS上运行 CouchDB 或者 MinIO
至少 1GB 内存，CouchDB 资源占用很低
如果需要公网访问设备，需要配置域名和端口映射

安装配置

这里我们使用 Docker Compose 部署 CouchDB 作为后端：

version: '3'

services:
  couchdb:
    image: apache/couchdb:latest
    restart: unless-stopped
    ports:
      - "5984:5984"
    environment:
      - COUCHDB_USER=admin
      - COUCHDB_PASSWORD=YOUR_PASSWORD
    volumes:
      - ./data:/opt/couchdb/data
      - ./local.ini:/opt/couchdb/etc/local.ini

配置 local.ini 启用 CORS：

[chttpd]
enable_cors = true

[cors]
origins = *
credentials = true
methods = GET,PUT,POST,DELETE,HEAD,OPTIONS
headers = accept,authorization,content-type,origin,referer,x-requested-with

启动 CouchDB 后，在 Obsidian 中安装 Self-hosted LiveSync 插件，然后按照快速设置向导配置连接信息即可。

如果你已经在NAS上运行 MinIO 等对象存储，也可以直接使用它作为后端，不需要额外部署 CouchDB。

使用说明

在NAS上部署好 CouchDB 或对象存储
在 Obsidian 的社区插件市场搜索 “Self-hosted LiveSync” 并安装
进入插件设置，选择快速设置
输入你的服务器地址、用户名、密码和数据库名称
点击连接并完成初始化
在所有需要同步的设备上重复上述配置
插件会自动在后台实时同步你的笔记变更
支持自动合并简单冲突，复杂冲突会提示你手动处理
可以在设置中开启同步配置、主题和插件，实现全设备环境一致

如果不需要中心服务器，也可以使用点对点 P2P 同步模式，直接在设备之间同步笔记。

开源信息

GitHub 地址: https://github.com/vrtmrz/obsidian-livesync
中文文档: https://github.com/vrtmrz/obsidian-livesync/blob/main/README_cn.md
Obsidian 插件页面: https://obsidian.md/plugins?id=obsidian-livesync
开源协议: MIT