Client setup

Connect Obsidian on desktop or mobile to this sync gateway.

  1. Install Vault Relay Sync (beta via BRAT)
    Vault Relay Sync is not listed in the official Community plugins store. Install the BRAT plugin first (Settings → Community plugins → Browse → “BRAT”), then add the beta: 
    vault-relay/obsidian-vault-relay
    In BRAT: Add Beta plugin → paste the repo above → enable Vault Relay Sync under Community plugins. Updates ship through BRAT until the plugin graduates from beta.
  2. Configure CouchDB
    Open Vault Relay Sync → CouchDB connection. Set URI to https://as.obsidian-sync-selfhosted.projaias.com/obsidian-vault. Enter database username and password created on this server.
  3. Set encryption
    Choose End-to-end encryption and set a passphrase. This passphrase is never sent to the server; loss means data cannot be recovered.
  4. Initial sync
    Run Fetch from remote on first device, then Upload local changes on others. Wait until the status bar shows green sync.
  5. Mobile (optional)
    On iOS/Android, enable background sync only if your OS allows; otherwise open Obsidian briefly to pull changes.

Recommended plugin settings

Relay mode: Continuous
Sync on save: On
Sync on editor save: On
Batch size: 50
Use history: On
P2P relay: Off

Health check

Gateway JSON status (read-only):

/api/status.json