obsidian-livesync README

The project's README from github.com/vrtmrz/obsidian-livesync. As one markdown file: README.md.

Self-hosted LiveSync

Japanese docs - Chinese docs.

Self-hosted LiveSync is a community-developed synchronisation plug-in available on all Obsidian-compatible platforms. It leverages robust server solutions such as CouchDB or object storage systems (e.g., MinIO, S3, R2, etc.) to ensure reliable data synchronisation.

Additionally, it supports peer-to-peer synchronisation using WebRTC, enabling devices to exchange notes without a central data-storage server. A signalling relay is still required for peer discovery. See How peer-to-peer synchronisation works.

obsidian_live_sync_demo

[!IMPORTANT] This plug-in is not compatible with the official "Obsidian Sync" and cannot synchronise with it.

Features

This plug-in may be particularly useful for researchers, engineers, and developers who need to keep their notes fully self-hosted for security reasons. It is also suitable for anyone seeking the peace of mind that comes with knowing their notes remain entirely private.

[!IMPORTANT]

  • Before installing or upgrading this plug-in, please back up your vault.
  • Do not enable this plug-in alongside another synchronisation solution (including iCloud and Obsidian Sync).
  • For backups, we also provide a plug-in called Differential ZIP Backup.

How to Use

3-minute setup - CouchDB on fly.io

Recommended for beginners

LiveSync Setup onto Fly.io SpeedRun 2024 using Google Colab

  1. Set up CouchDB on fly.io
  2. Configure plug-in in Quick Setup

Setup workflows

Choose a synchronisation method, prepare its server where required, then follow the corresponding client setup:

  1. CouchDB
    1. Prepare the server:
    2. Configure the clients by following CouchDB Quick Setup.
  2. Object Storage
    1. Prepare the server. A maintained MinIO server installation guide is not currently available here, so set up an S3-compatible service or server of your choice.
    2. Configure the clients by following Object Storage Setup.
  3. Peer-to-Peer
    1. No central data-storage server is required. The project's public signalling relay requires no server provisioning; controlled deployments can provide another compatible relay.
    2. Configure the clients by following Peer-to-Peer Setup.

Each workflow establishes ordinary note synchronisation on the first device, generates a Setup URI for each additional device from that working device, and verifies synchronisation in both directions.

[!TIP] Fly.io is no longer free. Fortunately, we can still use IBM Cloudant despite some limitations. Refer to Set up IBM Cloudant. We can also use peer-to-peer synchronisation without a central data-storage server; a signalling relay is still used for peer discovery. Alternatively, cheap object storage like Cloudflare R2 can be used for free. However, most importantly, we can use a server that we trust. Therefore, please set up your own server. CouchDB can also be run on a Raspberry Pi (please be mindful of your server's security).

Third-party managed CouchDB hosting

[!NOTE] The following is a third-party hosting option proposed by Zenith Hosting. It is not an official Self-hosted LiveSync service, and it is neither endorsed nor recommended by this project.

If you would rather not set up and maintain a server yourself, Zenith Hosting offers a managed CouchDB server which this plug-in can be configured to connect to: Zenith Hosting. As with any hosted service, your data will reside on a server operated by a third party, so please consider whether that is acceptable for your vault before using it.

Information in the Status Bar

Synchronisation status is shown in the status bar with the following icons.

To prevent file and database corruption, please avoid closing Obsidian until all progress indicators have disappeared as much as possible (although the plug-in will attempt to resume if interrupted). This is especially important if you have deleted or renamed files.

Tips and Troubleshooting

Acknowledgements

The project has been in continual progress and harmony thanks to the following:

May those who have contributed be honoured and remembered for their kindness and generosity.

Development Guide

Please refer to the Development Guide for development setup, testing infrastructure, code conventions, and more.

License

Licensed under the MIT License.

obsidian-livesync (vrtmrz/obsidian-livesync)

Searching Database…

12.7K ·GitHub
Obsidian-livesync
What is this?Self-hosted LiveSync is a community-developed Obsidian plugin that synchronises your notes across devices using your own CouchDB or S3-compatible object storage server, or directly between devices via WebRTC peer-to-peer.
Is this a replacement for the official Obsidian Sync service?No, it's an independent Obsidian plugin that syncs through a server you control (CouchDB or object storage) or peer-to-peer; it does not talk to and is not compatible with Obsidian's paid Sync service.
How do I get it running?The recommended beginner path is the 3-minute setup: spin up CouchDB on fly.io, then configure the plugin using its Quick Setup, which generates a Setup URI to add further devices.
Do I need to host my own server?Yes — you need either a CouchDB server (self-hosted, fly.io, IBM Cloudant) or an S3-compatible object storage service (Cloudflare R2, MinIO), or for P2P mode a signalling relay for peer discovery.
Can I run this alongside iCloud or Obsidian Sync?No, you should not enable it together with another sync solution like iCloud or Obsidian Sync, and you should back up your vault before installing or upgrading.
Who is this mainly built for?It's aimed at researchers, engineers and developers who want their notes fully self-hosted for security, as well as anyone who wants complete privacy over their vault.
Does it work on mobile as well as desktop?Yes, it works on all Obsidian-compatible platforms, which includes Windows, macOS, Linux, iOS and Android.
Where does my note data actually live?Your notes stay on infrastructure you choose and control (your own CouchDB/object storage, or peer devices via WebRTC), rather than on Obsidian's or any third party's servers — unless you opt into a third-party managed host.
What is Customisation Sync?A beta feature (plus Hidden File Sync) that synchronises your Obsidian settings, snippets, themes and plug-ins across devices, in addition to your notes.
How does peer-to-peer sync work without a central server?Devices exchange notes directly over WebRTC with no central data-storage server, but a signalling relay is still required for peer discovery, and at least one device holding the data must stay online while another syncs.
What happens if I close Obsidian while it's syncing?You risk file and database corruption, especially after deletes or renames, so you should wait until all progress indicators in the status bar disappear; the plugin will try to resume if interrupted.
Is there a managed hosting option if I don't want to run my own server?A third party called Zenith Hosting offers managed CouchDB hosting compatible with the plugin, though it's unofficial, unendorsed, and your data would then live on their servers.
What are similar projects?yaos, spacedrive, EnvoyMesh, obsidian-git, rclone, ente, ds-harness-remote, kopia
Which topics is it in?obsidian-plugin, sync, webrtc, s3, p2p, storage, backup, note-taking, encryption, plugin, database, ios
Creator
vrtmrz
Size
19.1 MB
Stars
12.7K
Updated
CommitOct 17Release1.0.38Oct 17
Age
5y
Commits · 90 Days