Welcome to Synkk
2 min read
•
376 words
•
Synced 2 days ago
•
Sovereign Verified
⚡ Welcome to Synkk
Synkk Philosophy
Keep Markdown, permissions, versions, and trusted devices together on infrastructure you control. Synkk is a self-hosted team vault synchronization server, multi-user CRDT collaboration engine, and interactive publishing portal designed specifically for Obsidian.
🧭 Why Synkk?
Obsidian users and research teams frequently face a painful dilemma:
- Cloud proprietary silos (Notion, Google Docs) force you to give up local plaintext files.
- Generic cloud sync (iCloud, Dropbox, OneDrive) causes silent file corruption, merge collisions, and lacks granular team path permissions.
- Git setups are clunky on mobile devices and intimidating for non-technical team members.
Synkk solves this completely:
- Local-First Plaintext: Your notes remain standard Markdown (
.md) files on your filesystem. - Instant QR Pairing: Pair any iPhone, Android, Mac, or Windows device in under 3 seconds using Instant QR Pairing.
- Pre-Flight Migration Engine: Simulate your first sync and catch friction traps before sending a single byte via [[Pre-Flight Engine]].
- Zero-Knowledge E2EE: Secure notes with client-side WebCrypto AES-256-GCM encryption with E2EE.
- Interactive Livewire Portals: Publish your vaults as high-end websites in 1-click via Livewire Portals.
- Live Multiplayer CRDT: Co-author notes with team carets and presence using [[Multiplayer CRDT]].
- Vector RAG Copilot: Query your notes semantically with citations via [[Vault Copilot]].
🗺️ Documentation Map
- Getting Started:
- [[Installation & Deployment Guide]]
- 3-Second Instant QR Pairing
- Core Sync Architecture:
- [[First-Sync Pre-Flight & Migration Engine]]
- [[Live Multiplayer CRDT & Carets]]
- [[Mobile Ghost Files & Attachment Streaming]]
- Security & Permissions:
- Zero-Knowledge End-to-End Encryption
- Role-Based Scoped Path Permissions
- [[Atomic Safety Shield & Snapshots]]
- Publishing & Portals:
- AI & Knowledge Systems:
- [[Vault Copilot & Vector RAG Server]]
- Operations & Self-Hosting:
- [[Docker, Turnkey Installer & Production Setup]]
- REST API Reference (Protocol v2)