Zync

by Arman Hadi
5
4
3
2
1
Score: 50/100

Description

Obsidian plugin: two-way vault sync over S3-compatible storage (desktop + mobile)

Reviews

No reviews yet.

Stats

0
stars
16
downloads
0
forks
1
days
1
days
1
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
3
commits

Latest Version

2 days ago

Changelog

Zync 1.0.1

README file from

Github

Zync

Two-way Obsidian vault sync over S3-compatible storage. One plugin build works on desktop and mobile.

Works with Cloudflare R2, AWS S3, Backblaze B2, MinIO, and other SigV4 S3 APIs. No VPS required.

Features

  • Manual sync (ribbon + command) and optional interval / sync-on-load
  • Upload, download, and delete propagation across devices
  • Conflict copies when both sides edited the same file
  • Ignore globs (the vault config folder via Vault.configDir, and .trash, are always skipped)
  • Optional protected folder: password-lock one folder; Markdown notes are AES-256-GCM encrypted on disk when locked (and auto-encrypted when Obsidian closes) and always encrypted in S3
  • Mobile-safe networking via Obsidian requestUrl + Web Crypto SigV4

Install

From Community plugins (after approval)

Settings → Community plugins → Browse → search Zync → Install → Enable.

Manual / BRAT

  1. Create <vault>/.obsidian/plugins/zync/
  2. Copy manifest.json, main.js, and styles.css from a GitHub release
  3. Enable Zync under Community plugins

Setup

  1. Create an S3-compatible bucket and keys with list/get/put/delete.
  2. Open Settings → Zync.
  3. Enter endpoint, region, bucket, and keys.
  4. Click Test connection, then Sync.

Use the same bucket settings on every device.

Provider tips

Provider Endpoint Region Path-style
Cloudflare R2 https://<accountid>.r2.cloudflarestorage.com auto try either
AWS S3 (leave empty) your region usually off
MinIO your MinIO HTTPS URL e.g. us-east-1 on
Backblaze B2 S3 endpoint from B2 B2 region usually on

Optional key prefix lets several vaults share one bucket.

How sync works

  • Compares local files with remote objects under your prefix
  • Uploads newer/missing local files; downloads newer/missing remote files
  • Propagates deletes via tombstones
  • If both sides changed the same path: renames local to name (conflict YYYYMMDD-HHMM).ext and downloads remote

Privacy: by default, files are stored in your bucket in plain form. Notes inside an optional protected folder are encrypted with AES-256-GCM before upload (password never leaves the device). Credentials stay in the vault’s plugin data (data.json) on each device.

Desktop filesystem access: on desktop only, when Obsidian quits or hides while a protected folder is unlocked, Zync may use Node fs to synchronously write already-encrypted note contents under the vault path so plaintext is not left on disk if the process dies mid-async save. Mobile never uses Node fs.

Commands

  • Ribbon refresh icon → sync now
  • Command palette: Zync: Sync now, Zync: Test S3 connection, Zync: Lock/Unlock protected folder

Develop

npm install
npm run dev    # watch build → main.js
npm run build  # production build

Reload Obsidian (or toggle the plugin) after rebuilds.

License

MIT