Obsidian Stats logoObsidian Stats

Vault Base

by zeven
5
4
3
2
1
Score: 50/100
Install Code

Description

基于WebDav的Obsidian同步插件

Reviews

No reviews yet.

Stats

0
stars
16
downloads
0
forks
5
days
5
days
5
days
2
total PRs
0
open PRs
0
closed PRs
2
merged PRs
0
total issues
0
open issues
0
closed issues
7
commits

Latest Version

0.2.2
5 days ago

Changelog

  • Added English README content for the community directory listing.
See all version on GitHub

README file from

Github

Vault Base

Vault Base is a bidirectional WebDAV sync plugin for Obsidian. Use a NAS or self-hosted WebDAV server as the central store and keep desktop and mobile clients in sync.

Vault Base（项目名 vault-base-plugin）是面向 Obsidian 的双向 WebDAV 同步插件，同时兼容桌面端与移动端。适合以 NAS WebDAV 作为中央仓库，在多端之间同步。

Features

  • Three-way compare: local, remote, and last successful sync state
  • Bidirectional sync, delete propagation, smart merge, and conflict strategies
  • Startup sync, scheduled sync, and realtime sync
  • Optional client-side encryption
  • Remote directory picker and status bar progress
  • Concurrency, rate limits, and large-file handling

功能

  • 三方比较：本地、远端、上次成功记录
  • 双向同步、删除传播、智能合并与冲突策略
  • 启动同步、定时同步、实时同步
  • 可选客户端加密
  • 远程目录选择、状态栏进度
  • 并发、速率与大文件限制

Setup

  1. Open Settings → Community plugins → Vault Base.
  2. Enter your WebDAV server URL, account, and password.
  3. Click Check connection, then choose a remote directory.
  4. Run a manual sync or enable startup, scheduled, or realtime sync.

Back up your vault and test with a separate remote folder before syncing production data.

开发

npm install
npm run check
npm test
npm run dev

单元测试依赖 Bun。未安装时仍可进行类型检查与生产构建。

开发构建会写入 dist/，并同步复制到 release/。把 release/ 里的 main.js、manifest.json、styles.css 放到测试库的 .obsidian/plugins/vault-base/，然后在 Obsidian 中启用插件。

构建与发布

npm run package

Obsidian 商店产物在 release/：

  • main.js
  • manifest.json
  • styles.css

Git 标签必须与 manifest.json 版本完全一致，且不要加 v 前缀。

Sync notes

  • Conflicts default to smart merge. When merge is not possible, choose newest version, keep local, keep remote, or skip.
  • .obsidian, .git, .trash, and similar paths are excluded by default. Use include rules to allow specific config files.
  • WebDAV passwords are stored in the Obsidian secret storage.

同步说明

  • 冲突默认走智能合并；无法合并的文件可选择最新版本、保留本地、保留远端或跳过。
  • 默认排除 .obsidian、.git、.trash 等路径；可用包含规则单独放行配置文件。
  • WebDAV 密码保存在 Obsidian 密钥链中。
  • 首次使用前请备份 vault，并先用独立测试目录验证服务器兼容性。

License and attribution

This project is based on Obsidian WebDAV Sync and Nutstore Sync, and is released under the GNU Affero General Public License v3.0. See NOTICE for attribution and LICENSE for the full terms.

许可证与来源

本项目基于 Obsidian WebDAV Sync 与 Nutstore Sync，按 GNU Affero General Public License v3.0 发布。归属与修改说明见 NOTICE，完整条款见 LICENSE。

Sponsors