beatsad_Vault2Dify/README_ZH.md

Vault2Dify

English | 中文

将选定的 Obsidian Markdown 笔记同步到一个或多个 Dify 知识库。

Vault2Dify 是一款桌面端 Obsidian 插件，适合使用 Obsidian 写个人笔记、项目资料或团队知识库，同时使用 Dify 做知识库问答的用户。插件只会把命中已启用路径映射的 Markdown 笔记同步到你配置的 Dify 服务地址。

插件界面默认使用英文。你可以在设置页顶部的语言图标中切换为中文。

功能

• 将 Obsidian 目录、单篇 Markdown 笔记或整个仓库映射到一个或多个 Dify 知识库。
• 通过 GET /v1/datasets 测试 Dify API Key，并自动读取可用知识库。
• 支持从功能区图标、命令面板或设置页手动同步。
• 可选监听 Markdown 创建、修改、重命名事件，并通过定时全量校验兜底。
• 使用一个 Dify 服务地址覆盖本机 Docker、NAS/Docker、局域网、Tailscale、反向代理或 Dify Cloud。
• 按知识库和 Obsidian 文件路径保存同步记录，避免不同目录下同名文件互相覆盖。
• 采用保守删除策略：删除本地笔记或路径映射不会自动删除 Dify 远端文档。
• 支持英文和中文设置、通知、命令与状态信息。

快速开始

构建插件：

npm install
npm run build

将发布文件复制到你的 Obsidian 仓库：

.obsidian/plugins/vault-to-dify/
├── main.js
├── manifest.json
└── styles.css

在 设置 -> 社区插件 -> 已安装插件 中启用 Vault2Dify，然后打开 设置 -> Vault2Dify。

首次配置：

1. 填写 Dify 知识库 API Key。
2. 填写运行 Obsidian 的设备可以访问的 Dify 服务地址。
3. 测试连接并读取知识库列表。
4. 新增路径映射。
5. 运行手动同步或启用自动同步。

新安装不会自动上传笔记；需要先配置映射并主动开始同步。

更多说明：

• 安装说明
• 用户指南
• 连接排错

Dify 服务地址示例

填写运行 Obsidian 的设备可以访问的服务根地址。插件会自动追加 /v1/datasets 等 Dify API 路径。

部署方式	示例
同一台电脑上的本机 Docker	http://localhost:5000
NAS/Docker 或局域网服务器	http://dify-host.example.test:5000
通过 Tailscale 访问 NAS	http://tailnet-device.example.test:5000
反向代理或 Dify Cloud	https://dify.example.com

除非 Dify 和 Obsidian 运行在同一台电脑上，否则不要填写 localhost。

隐私与网络使用

• 插件会读取当前 Obsidian 仓库中的 Markdown 文件。
• 只有命中已启用路径映射的 Markdown 文件会被发送到你配置的 Dify 服务地址。
• Dify API Key 保存在 Obsidian 插件本地数据中。
• 插件不会把笔记内容发送给插件作者，也不会发送到你配置的 Dify endpoint 以外的服务。
• 删除本地笔记不会自动删除 Dify 远端文档。
• 删除路径映射只会移除本地插件配置。

详见 SECURITY.md。

平台支持

当前版本仅支持桌面端。移动端支持需要单独测试后再启用。

开发命令

npm install
npm test
npm run typecheck
npm run build

发布文件

发布包只应包含：

main.js
manifest.json
styles.css

不要包含 node_modules、API Key、本地 Obsidian 仓库数据、插件本地数据、同步记录、原型文件或本地归档。

许可证

MIT License