Real-time Sync Obsidian

English | Español

📖 User Guide: English • Español  •  🛠️ Developer Guide: English • Español

⚡ Why OmniSync Changes Everything

Every common Obsidian sync alternative today forces you into an unwanted compromise:

1. Paying a recurring monthly subscription ($4 to $10/month per vault).
2. Entrusting your sensitive notes and thoughts to third-party tech giants (Dropbox, Google Drive, OneDrive).
3. Self-hosting and maintaining complex server stacks (CouchDB / Docker containers on a paid VPS).

OmniSync completely discards that premise. It turns your devices into direct peers. Notes travel directly peer-to-peer at lightning speed, encrypted before leaving your machine, with zero central authority tracking your activity.

🌟 Key Highlights & Architectural Advantages

⚡ 1. Free Real-Time Sync (Google Docs Experience)

• Real-time sync, free: Your notes sync across your devices the instant you type, with no subscription and nothing to pay.
• Live Remote Cursors & Selections: Deeply integrated into Obsidian's CodeMirror 6 editor engine. Watch remote cursors glide across the screen with distinct colors in real time.
• Simultaneous Live Typing: Type on your phone and watch words appear instantly on your desktop monitor without lag.
• Smart 3-Way Merge Engine: Divergent edits made while offline reconcile automatically at the character level using stored base snapshots. Zero overwritten paragraphs, zero messy conflict file duplicates (.sync-conflict).

🥷 2. Zero Accounts, Zero Central Servers, Zero Logs

• Complete Privacy: No email registration, no sign-ups, no passwords to create or leak.
• True Zero-Knowledge (E2EE): Everything is encrypted locally with AES-256-GCM before touching any network socket.
• Cryptographic Path Obfuscation (HMAC): File paths and directory trees are hashed deterministically (hmac("Secret/Note.md") → 8f2a...). Network observers only see encrypted payloads and never know your note titles or vault structure.
• No Server Footprint: Direct WebRTC channels and ephemeral signaling relays (Nostr or your own Serverless Worker) maintain zero activity logs or user identities.

📲 3. Instant Ephemeral QR Pairing (5 Seconds, Zero Typing)

• Forget manually typing long S3 keys, WebDAV endpoints, or GitHub Personal Access Tokens on mobile touchscreens.
• Open the pairing wizard on desktop, scan the QR code with your mobile camera, and confirm.
• An ECDH P-256 key exchange takes place using a single-use token with a 2-minute expiration (TTL). Once completed, keys are stored in-memory/keychain and the token is burnt forever.

🔄 4. Robust Asynchronous Sync (Offline & Sleep Support)

• Your phone doesn't need to be awake or online when you work on your computer.
• Pending changes sit securely encrypted in a transient mailbox (on public Nostr relays or your own free, 1-click deployable Cloudflare Worker). The moment your phone wakes up, it catches up seamlessly.

⚠️ OmniSync is not a backup. Mailbox notices expire after 7 days; R2 blobs after 10 days; public Blossom blobs in ≈7 days. It is a real-time transit layer — not permanent storage. Each device keeps its own vault. For long-term safety, pair it with a backup solution (iCloud, Dropbox, a manual copy, or Obsidian Sync).

📦 5. Native Large Binary & Media Handling (Blossom Protocol)

• Powered by the Blossom (BUD-01/02) protocol addressed directly by SHA-256 hash. Large images, PDFs, audio, and attachments sync smoothly without clogging memory or database records.

🛡️ 6. Safe Data Preservation (Obsidian Trash Integration)

• When a remote peer deletes a note, OmniSync never performs an irreversible disk wipe: files are safely routed to Obsidian's local .trash folder, ensuring human mistakes can always be undone.

📊 Quick Feature Comparison

(Read the comprehensive Technical Comparison Document for in-depth architecture benchmarks).

🚀 Quick Installation

OmniSync is currently under review for Obsidian's official community plugin directory. Until listed, install manually in under a minute:

1. Visit the Releases page and download:
   • main.js
   • manifest.json
   • styles.css
2. Navigate to your Obsidian vault's .obsidian/plugins/ directory and create a folder named omnisync/.
3. Copy the 3 downloaded files into .obsidian/plugins/omnisync/.
4. Open Obsidian, go to Settings → Community plugins, and toggle OmniSync on.
5. Go to Settings → OmniSync → Pairing Assistant to link your first phone or second computer.

For detailed walkthroughs and troubleshooting, see the User Guide.

🔒 Privacy & Transparency

• What does a public relay see? Only that an encrypted session is active and approximate packet sizes. Relays cannot decrypt your content, note names, or folder paths.
• Want 100% sovereign isolation? OmniSync features a built-in wizard to deploy your own free Cloudflare Worker in 1 click, bypassing public relays altogether.
• Security Audits & Tests: The codebase is validated by 502 automated tests across 22 suites (npm test) covering cryptography, real-time sync, and zero-knowledge privacy. View the full test suite and audit reports in docs/TESTS_AND_AUDITS_EN.md.

🛠️ Local Development

# Clone the repository
git clone https://github.com/abismalmx/OmniSync.git
cd OmniSync

# Install dependencies
npm install

# Start development compiler (watch mode)
npm run dev

# Production build
npm run build

# Run comprehensive test suite
npm test

Read the Developer Guide for full architecture breakdowns, security policies, and contribution guidelines.

📄 License

Distributed under the PolyForm Noncommercial 1.0.0 — Free for personal use, learning, non-profit organizations, and academic research.