快速开始

安装 Obsidian 插件

从插件市场安装

由于插件尚未上架官方社区的插件市场, 所以此方法暂不可用

1. 打开“设置”, 在“设置”窗口左侧点击“第三方插件”
2. 如果你是首次使用插件功能, 在“第三方插件”界面会提示你需要关闭“安全模式”
3. 在“第三方插件”界面点击”关闭安全模式“
4. 关闭安全模式后点击“社区插件市场”右侧的“浏览”按钮
5. 在“浏览”界面输入BetaX NAS Sync搜索本服务的插件, 然后点击搜索结果
6. 在弹出的BetaX NAS Sync插件详情界面点击“安装”按钮, 至此安装即为完成

从仓库手动安装

1. 打开仓库发布页面
2. 下载最新版本中的main.js与manifest.json
3. 打开你的Obsidian存储库目录, 在路径末尾添加/.obsidian, 然后回车
4. 在.obsidian中创建plugins目录, 然后进入plugins目录
5. 在plugins中创建ons目录, 然后将下载的main.js与manifest.json放入其中
6. 重启Obsidian即可在“已安装插件”中看到BetaX NAS Sync, 至此安装即为完成

安装 NAS 服务

应用市场安装

目前暂无支持的厂商, 后续计划支持群晖spk的安装

Docker 容器安装

1. 拉取skyezhang/ons-nas
2. 映射容器中的/app/vault目录到你的 NAS 中Obsidian的存储库目录, 并允许读写
3. 在UDP侧开放全部端口, 在TCP侧开放9892端口
4. 配置完成后启动容器即可

请注意, 本服务采用了UDP打洞技术, 所以需要在UDP侧开放全部端口, 而9892端口是可视化控制界面