下载并安装 Obsidian
打开 https://obsidian.md/download,点击 Download for Windows。下载完成后运行官方安装程序,按提示完成安装并打开 Obsidian。
完成标志: Obsidian 安装完成,可以打开。
Windows
每人使用独立账号;同一人的多台电脑使用同一账号和加密设置。
首台设备:向管理员领取服务地址、同步用户名、同步密码和数据库名。确认这是为你新建、尚无笔记的数据库;笔记加密口令由你在首台设备设置并保管。此时还没有 Setup URI,不能直接跳到导入配置。
第二台及后续设备:从自己已正常同步的设备导出 Setup URI 和链接解锁口令。完整配置链接通常以 obsidian://setuplivesync?settings= 开头,包含连接和笔记加密设置,不放到公共聊天或官网。
本手册先在新建空库接入。已有笔记先单独备份,完成双向验证后再复制到新库。不要让其他同步工具同时写入这个笔记库。
| 名称 | 用途 | 从哪里获得 |
|---|---|---|
| 服务地址、用户名、数据库名 | 定位自己的同步空间 | 管理员分配同步账号时提供 |
| 同步账号密码 | 连接笔记服务器 | 管理员创建账号或重设密码时提供 |
| 笔记加密口令 | 保护笔记内容;同一人的各设备使用相同设置 | 在首台设备设置并保管 |
| 配置链接及解锁口令 | 将首台设备的配置导入其他设备 | 首台设备正常同步后导出 |
已经安装 Obsidian 且有一个用于此次接入的空库,可以从“打开第三方插件”继续。
打开 https://obsidian.md/download,点击 Download for Windows。下载完成后运行官方安装程序,按提示完成安装并打开 Obsidian。
完成标志: Obsidian 安装完成,可以打开。
如果已经进入某个笔记库,点击左下角的库名称,再点击“管理仓库…”。第一次打开 Obsidian 时会直接进入仓库选择界面。
完成标志: 显示仓库管理窗口。
在“新建仓库”一行点击“创建”。这里的仓库(Vault)就是保存笔记的本地文件夹。
完成标志: 显示库名称与保存位置填写页。
仓库名称可以填写“我的同步笔记”。点击“浏览”选择本机保存位置,再点击“创建”。请选择不受 OneDrive 等其他同步工具管理的普通文件夹。
完成标志: 进入刚创建的空笔记库。
点击左下角齿轮打开设置,选择“第三方插件”。如果出现受限模式或“信任仓库作者”的提示,请先确认这是你自己建立的库,再按界面提示允许社区插件。随后点击“浏览”。
完成标志: 可以打开社区插件市场。
在插件市场搜索框输入 Self-hosted LiveSync,打开同名结果。核对作者为 vrtmrz;已安装插件列表中的作者可能显示 vorotamoroz。
完成标志: 找到作者为 vrtmrz 的 Self-hosted LiveSync。
点击“安装”;如完成后显示“启用”,再点击“启用”。启用后回到设置,点击左侧 Self-hosted LiveSync;首次启用时也可能直接弹出设置向导。
完成标志: 插件已启用,可以进入首次设置向导或插件设置。
适用于刚分配的同步账号:服务器已为你建好数据库,还没有任何设备完成同步。先配置这一台电脑,再生成供其他设备使用的配置链接。
本服务已为每个账号建立独立数据库。先按本节填写连接信息与笔记加密口令,再导出配置给其他设备。
欢迎页的“我是第一次进行设置”包含初始化或重建服务器的分支。本服务使用已建好的数据库,按下列“远程配置”入口操作。
如果是在删除插件后重新安装并恢复已有库,必须复用该库原来的笔记加密口令,不要为恢复临时另设新口令。
首次启用插件出现欢迎页时,两项都不要选择,点击底部“不,返回上一步”(No, please take me back)退出欢迎向导。
完成标志: 回到 Self-hosted LiveSync 设置页。
打开“设置 → Self-hosted LiveSync → 远程配置”,在 E2EE Configuration 区域点击 Configure And Change Remote,一起配置笔记加密与服务器连接。
完成标志: 出现 End-to-End Encryption(端到端加密)页面。
勾选 End-to-End Encryption,填写并妥善保存自己的笔记加密口令,勾选 Obfuscate Properties(混淆文件属性),加密算法保持默认,然后点击 Proceed。
完成标志: 进入服务器类型选择页面。
在服务器类型页面选择 CouchDB,确认该项处于选中状态,再点击 Continue to CouchDB setup(继续进行 CouchDB 设置)。
完成标志: 进入 CouchDB 连接信息填写页面。
逐项填写分配给你的 URL、用户名、同步账号密码和数据库名称。
完成标志: 四项连接信息填写完整,可以继续测试。
向下滚动,点击 Test connection and save(测试连接并保存),等待进入下一页。
完成标志: 测试成功,出现 Mostly Complete: Decision Required。
选择 My remote server is already set up. I want to join this device.(远端服务器已设置,接入这台设备),点击 Proceed to the next step,再点击 Restart and Fetch Data。
这里的“服务器已设置”指数据库已由服务方建好;这仍然是你第一台客户端的手动配置,不需要先有另一台设备或配置链接。
完成标志: 已安排重启并获取服务器数据。重启后继续检查是否需要启用 LiveSync。
首次重启后,进入“设置 → Self-hosted LiveSync”。如果“快速设置”仍显示“启用 LiveSync”,点击它;如果已直接出现 Data retrieval scheduled,跳到后面的获取数据步骤。
完成标志: 点击启用后,出现是否重启的确认框;已启用的设备可继续获取数据。
在重启确认框中点击 Yes, restart immediately(立即重启)。重启后等待 Data retrieval scheduled 弹窗。
完成标志: 重启后进入 Data retrieval scheduled。若没有弹窗,检查快速设置是否仍显示“启用 LiveSync”。
在 Data retrieval scheduled 中点击 Compare time and take newer(比较修改时间,保留较新的文件)。本指南以新建空库接入为起点,空库将获取服务器已有内容。
完成标志: 进入 Conflict & Deletion Options。
在 Conflict & Deletion Options 中点击 Keep local files even if deleted on remote(即使远端已删除,仍保留本地文件),继续首次获取。
完成标志: 继续读取服务器配置并初始化。
已有数据库可能出现如图提示:部分设置已按服务器的兼容配置调整。确认接入的是自己的数据库后点击 OK,等待获取完成。
全新数据库若显示 No Synchronisation Settings Found,确认库中尚无旧笔记后选择 Use this device's settings,使用本设备的设置。
完成标志: 获取流程结束且没有错误;若曾出现 flag_fetch 标记,它应由插件自动清除。随后设置持续同步模式。
首次数据获取完成后,打开“设置 → Self-hosted LiveSync → 同步设置”。在“预设”中选择 LiveSync 同步并点击“应用”,确认下方“同步模式”为“LiveSync 同步”。
每台设备完成初次获取后都检查一次。若手动 Sync now 可以传输,但新增内容不自动出现,优先核对这一项。
完成标志: 同步模式显示为 LiveSync 同步。
按 Ctrl + N 新建“我的第一篇同步笔记”,写入一句自己的测试文字,例如“A端测试”。需要附件时,把图片或 PDF 放进笔记库并在笔记中引用。
保持应用联网并打开,确认没有上传或加密错误,再导出配置链接。外部文件路径链接不会把原文件带到另一台电脑;另一端收到新写的测试文字后,才证明发生了传输。
完成标志: 测试笔记及附件保存在当前库内。
首台设备完成配置、测试笔记同步无错误后,再生成 Setup URI。每位使用者保留自己的配置;同一人的其他设备复用这一套设置。
在已配置好的首台设备进入“设置 → Self-hosted LiveSync”,找到“设置其他设备”,点击“将当前设置复制为设置 URI”。请先确认账号信息最新、同步状态无错误。
完成标志: 出现配置链接加密口令弹窗。
在 Encrypt your settings 中设置一个用于保护配置链接的口令,点击 OK。随后在 Setup URI 弹窗中点击文本框右侧的 📋 复制按钮,看到 ✔️ 或 copied 提示后再点 OK。将完整链接粘贴到新电脑的 Setup-URI 输入框。
记住这次填写的链接解锁口令,新电脑导入时需要使用。同一条配置链接与对应口令配套使用。
完成标志: 已获得完整配置链接及其解锁口令。
适用于第二台及后续电脑:先完成“安装与建库”,再使用首台设备导出的 Setup URI。每台新设备都新建空库,同一人的设备继续使用原同步账号。
首次启用插件时会出现欢迎向导。选择“我要将设备加入现有同步配置”,然后点击“是的,我要把这台设备加入现有同步”。
完成标志: 进入添加现有同步设备的设置流程。
在“设备设置方式”中选择“使用 Setup URI(推荐)”,点击“继续使用 Setup URI”。
完成标志: 出现 Setup-URI 和口令输入栏。
将完整配置链接粘贴到 Setup-URI,在“密码”一栏填入这条链接的解锁口令,点击 Test Settings and Continue。
按下面的顺序完成获取;获取结束后,再到同步设置应用 LiveSync 同步预设。
完成标志: 首次获取完成,同步模式已确认;接着用下面的双向测试验收。
保持两端 Obsidian 都联网并打开。在第一台电脑新增“A端测试”,检查第二台是否自动出现;然后在第二台追加“B端回复”,回到第一台确认这句也出现。
同时打开图片和 PDF,确认附件内容可读。若只有手动 Sync now 后才收到,请在发送端核对 LiveSync 同步模式。
完成标志: 验收目标:两端的新修改均能自动到达,附件可以打开。
两端都能收到对方的修改后,再把需要的正式笔记和附件复制进已接入的库。
在左侧文件列表右键点击笔记,可以重命名、移动或删除。正常同步时,这些操作也会传到其他设备。重命名、删除或添加较多附件后,等待处理完成再关闭 Obsidian。
完成标志: 文件操作完成,待处理同步结束后再关闭应用。
用于检查已配置设备或更新同步账号密码。首台设备的接入流程见“首台设备:手动配置”。
进入“设置 → Self-hosted LiveSync → 远程配置”。Saved connections 下标有 Active 的是当前连接。点击这一行的扳手按钮(Configure)查看它的连接信息。
完成标志: 打开当前 Active 连接的编辑页。
将 URL、用户名、密码和数据库名称逐项与分配信息核对。同步账号密码更新后,每台设备都要在这里填写新密码。
核对完成后,向下滚动并点击 Test connection and save。成功返回后,验证新修改能否继续传输。
完成标志: 连接测试通过,新修改仍可正常传输。
容量说明:所有使用者的笔记与附件合计预计不超过 5 GB;这是使用规模规划。服务器磁盘占用还可能包含历史版本和索引。
适用版本:Windows Obsidian 1.13.7、Self-hosted LiveSync 1.0.28。截图来自同一台 Windows 电脑上的 A/B 演示库;首次接入的界面会因已有配置和数据库内容而有所不同。
验证范围:本轮已完成已有库恢复的界面操作与 B 库首次获取,用户确认 A 手动同步后 B 收到。重装后的双向自动同步仍须按本手册验收。新账号空数据库的首次完整流程尚未单独实测;先前预配置库的双向与附件测试记录不代替这项验证。
| 现象 | 先怎么处理 |
|---|---|
| 刚拿到账号,没有配置链接 | 先按“首台设备:手动配置”填写连接信息并设置加密口令;配置链接在首台设备正常同步后导出。 |
| 配置链接无法解锁 | 确认粘贴了完整链接,使用的是该链接的解锁口令;请生成者重新核对。 |
| 账号或权限错误 | 核对同步用户名、数据库名和最新密码,联系管理员确认账号已启用或请管理员重设同步密码。 |
| 证书、网络或连接失败 | 检查电脑联网和服务地址;保留错误提示交给管理员,不跳过 HTTPS 证书检查。 |
| 启用后没有 Data retrieval scheduled | 检查“快速设置”是否仍有“启用 LiveSync”;如有,点击后立即重启。不要手动删除 flag_fetch。 |
| Decryption with HKDF failed | 拉取的数据无法用当前加密配置解开。恢复已有库时先核对原笔记加密口令;它不同于账号密码或配置链接解锁口令。仍失败时保留新日志,请维护者协助。 |
| ERR_CONNECTION_ABORTED 或连接中断 | 逐字核对 HTTPS 地址及端口,排除复制错误,再检查网络。不要自行改用其他端口或跳过证书校验。 |
| 日志里的 Replication paused | 这个状态也会在等待新修改时出现;结合是否有报错、以及新增内容能否到达判断,不单凭一个状态词认定失败。 |
| 设置数据库大小通知 | 可选 2GB(标准)作为当前数据库的提醒阈值。它用于提示检查空间,不是 2GB 的硬容量上限。 |
| 能下载,但后来不自动同步 | 在两端获取完成后分别应用 LiveSync 同步预设。可按 Ctrl + P 执行 Self-hosted LiveSync: Sync now 判断手动传输是否正常,再用 Show log 查看本次操作时间对应的日志。 |
| 正文同步了,附件没有 | 确认附件本体保存在库内,检查文件大小、同步排除规则和插件错误提示。外部路径链接不会上传原文件。 |
| 重装、恢复或升级后提示兼容性暂停 | 点击 Review compatibility details 阅读原因。缺少旧的内部数据库版本确认记录也会暂停。确认使用同一数据库的各设备插件版本兼容后,返回点击 Resume synchronisation;只关闭窗口仍会保持暂停。 |
| 同时修改后出现冲突 | 先保留两边内容和备份,暂停在同一段继续编辑,查看插件的冲突处理提示;不能确定时交给管理员。 |
| 误删或想找回旧版本 | 先停止继续改动,联系管理员检查独立备份。本服务没有在本指南中承诺自动历史恢复。 |