obsidian-pocket-sync

Obsidian Pocket Sync

Sync your Obsidian vault across devices through a self-hosted PocketBase server. Bidirectional, conflict-aware sync with full support for attachments and binary files.

Quick Install

The button opens Obsidian and asks BRAT to add this repo. It needs the BRAT plugin installed and a published GitHub release. If your browser blocks the redirect, paste this into the address bar instead:

obsidian://brat?plugin=bilal-arikan/obsidian-pocket-sync

GitHub strips custom-scheme (obsidian://) links in markdown, so the button points to a tiny HTTPS redirect page (install.html on GitHub Pages) that forwards to the Obsidian URI. The official obsidian://show-plugin?id= deep link only works for store-listed plugins.

Features

• Bidirectional sync using a 3-way merge (last-sync snapshot as the base), so it knows exactly which side changed.
• Conflict handling — newer / local / remote strategies, with optional backups of the overwritten side into _sync_conflicts/.
• Any file type — notes and binary attachments are stored as file records.
• Manual, on-startup, and interval auto-sync, with a status bar indicator.
• Self-hosted — your data stays on your own PocketBase server.

Quick Start

1. Server (VPS, Docker)

git clone https://github.com/bilal-arikan/obsidian-pocket-sync.git
cd obsidian-pocket-sync/deploy
cp .env.example .env          # edit PB_DOMAIN, HTTPS_PORT, CF_API_TOKEN
docker compose up -d --build  # PocketBase + Caddy(rate_limit) + fail2ban
sudo ufw allow "$HTTPS_PORT"/tcp     # if the host uses ufw

# create the admin + the account the plugin logs in with
docker compose exec pocketbase /pb/pocketbase superuser upsert "you@example.com" "<strong-pass>"

Then open https://<PB_DOMAIN>:<HTTPS_PORT>/_/ → users collection → New record to create the login account the plugin will use. Full guide + DNS-01 details: deploy/README.md.

Just testing locally? Use deploy/docker-compose.simple.yml (plain HTTP on port 8095, no domain/TLS needed).

2. Plugin (each device)

Install — via BRAT (mobile-friendly) or copy main.js, manifest.json, styles.css into <Vault>/.obsidian/plugins/pocketbase-sync/.

Configure — open the plugin settings and fill in:

Setting	Value
Server URL	https://<PB_DOMAIN>:<HTTPS_PORT> (or http://127.0.0.1:8095 for local)
Email / Password	the users account you created
Vault ID	any name — identical on every device

Click Test connection (should go green), then Sync now (🔄). The status bar shows live progress: PB ⟳ 12/45 · 27% (↑8 ↓4).

Switching an existing vault to a new server? Hit Reset sync state in settings first, otherwise the 3-way diff may treat your files as remote deletions. After a reset the first sync simply pushes everything.

3. Build from source (optional)

npm install
npm run build
node scripts/deploy.mjs "/path/to/Your Vault"

Installing on Other Devices (macOS, iOS, Android)

The plugin is three files — main.js, manifest.json, styles.css — that must live in <Vault>/.obsidian/plugins/pocketbase-sync/ on each device. There are two ways:

Option A — BRAT (recommended for mobile)

1. In Obsidian, install the BRAT community plugin.
2. BRAT → Add beta plugin → enter bilal-arikan/obsidian-pocket-sync.
3. BRAT downloads the latest GitHub release and keeps it updated.
4. Enable PocketBase Sync in Community plugins and configure it.

Requires a GitHub release that includes main.js, manifest.json, styles.css.

Option B — Manual copy

• macOS: copy the three built files into <Vault>/.obsidian/plugins/pocketbase-sync/, then enable the plugin.
• Android: use a file manager to create the same folder inside your vault and copy the three files in.
• iOS: place the files via the Files app (vault must be under On My iPhone → Obsidian or iCloud Drive), then enable the plugin.

Server reachability: mobile/macOS devices cannot reach 127.0.0.1. Point the plugin’s Server URL at your public HTTPS endpoint (e.g. https://pb.example.com) or the server’s Tailscale IP if all devices share a tailnet.

How It Works

Files are stored in a vault_files collection (one record per file, keyed by (vault, path)). Each sync scans the vault, lists remote records, and diffs both against the last-sync snapshot to decide what to push, pull, or delete.

Development

npm run dev      # esbuild watch
npm run build    # type-check + production bundle

Module	Responsibility
src/main.ts	Plugin lifecycle, commands, auto-sync timer
src/sync-engine.ts	3-way diff and operation execution
src/pocketbase-client.ts	PocketBase REST wrapper
src/vault-index.ts	Local file scan + hashing
src/settings.ts	Settings UI

Author

Bilal Arikan

• GitHub: @bilal-arikan
• Email: bilal1993arikan@gmail.com

License

MIT © Bilal Arikan

This site is open source. Improve this page.