vault-link/docs/index.md
2025-11-30 15:24:52 +00:00

2.3 KiB

layout hero features
home
name text tagline image actions
VaultLink Self-Hosted Sync for Obsidian Real-time collaborative file synchronization for your knowledge base
src alt
/logo.svg VaultLink
theme text link
brand Get Started /guide/getting-started
theme text link
alt View on GitHub https://github.com/schmelczer/vault-link
icon title details
🚀 Real-Time Synchronization Operational transformation-based conflict resolution ensures your files stay in sync across devices without data loss
icon title details
🔒 Self-Hosted & Private Run your own sync server. Your data stays on your infrastructure with full control over access and privacy
icon title details
🎯 Obsidian Plugin Native integration with Obsidian for seamless synchronization directly within your favorite note-taking app
icon title details
🖥️ CLI Client Sync vaults to any system using the standalone CLI client. Perfect for servers, automation, or headless setups
icon title details
Built for Performance Rust-powered WebSocket server with SQLite backend delivers blazing-fast sync performance
icon title details
🛠️ Flexible Deployment Deploy via Docker, binary releases, or build from source. Configure authentication and access controls to fit your needs

Quick Start

Deploy the sync server:

docker run -d \
  -p 3000:3000 \
  -v $(pwd)/data:/data \
  ghcr.io/schmelczer/vault-link-server:latest \
  /app/sync_server config.yml

Install the Obsidian plugin or use the CLI client:

docker run -v /path/to/vault:/vault \
  ghcr.io/schmelczer/vault-link-cli:latest \
  -l /vault -r wss://your-server.com -t your-token -v default

Learn more →

VaultLink provides a complete self-hosted synchronization solution for Obsidian:

  • No third-party services: Your data never leaves your infrastructure
  • Operational transformation: Smart conflict resolution that preserves all changes
  • Multi-platform: Works with Obsidian plugin or standalone CLI on any system
  • Production-ready: Docker images, health checks, and comprehensive logging
  • Open source: MIT licensed with active development

Read the architecture overview →