Self-hosted LiveSync
Sync your Obsidian notes across devices using a server you run yourself (CouchDB or object storage), or directvrtmrz/obsidian-livesync
- Stars
- 12.9k
- Forks
- 500
- Licence
- MIT
- Language
- TypeScript
- Last update
- 4 days ago
- Type
- App
What it is
Self-hosted LiveSync is a community-built Obsidian plug-in that keeps your vault in sync across devices. It stores data on a server you set up, such as CouchDB or S3-compatible object storage, or can sync devices directly over WebRTC with a signalling relay used for peer discovery. People use it when they want their notes kept on infrastructure they control rather than a hosted sync service.
- Keep a vault in sync between a desktop and a phone using a CouchDB server you host
- Sync devices directly peer-to-peer without a central data store, with a signalling relay for discovery
- Sync settings, snippets, themes, and plug-ins via Customisation Sync or Hidden File Sync
- Test P2P connectivity on your devices with the experimental WebPeer utility
Great for
- Obsidian users who want notes kept on a server they manage
- Researchers or engineers with strict privacy or self-hosting requirements
- People comfortable setting up a CouchDB or object storage server
- Users who want end-to-end encryption for synced notes
Not ideal for
- Users who want zero setup: the README says you must set up and maintain your own server, though a community-run managed option is listed
- Anyone who wants to combine it with Obsidian Sync or iCloud: the README says it is not compatible with Obsidian Sync and should not run alongside other sync solutions
How to get it
- 1
Download the app
You'll need: Obsidian 1.7.2 or later (for version 1.0) · A CouchDB-compatible server or S3-compatible storage, or two devices for peer-to-peer
Clone the repository
git clone https://github.com/vrtmrz/obsidian-livesync - 2
Run it
- Back up your vault before installing.
- Install the plug-in in Obsidian and follow Quick Setup (CouchDB), Object Storage Setup, or Peer-to-Peer Setup.
- Generate a Setup URI on the first device and use it to configure your other devices.
- Create test notes and confirm they sync in both directions.
- 3
Get the most out of it
- Use the Fast Setup Guide to speed up initial replication on additional devices
- Configure Hidden File Sync only after ordinary note sync works
- Use Customisation Sync to share settings, snippets, themes, and plug-ins
- Consult Recovery and flag files before resetting a remote database
- Use Differential ZIP Backup (a separate plug-in by the same author) for backups
Downloads
Strengths
- Data can stay on a server you choose, with optional end-to-end encryption
- Supports several backends: CouchDB, S3-compatible storage, and WebRTC peer-to-peer
- Large community with many contributors and a MIT license
Trade-offs
- Requires you to set up, secure, and maintain a server (or accept a third-party host) for most setups
- The README says to back up your vault before installing or upgrading, and not to mix it with other sync tools
- Peer-to-peer still needs a signalling relay, and at least one device must be online for others to sync
Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.