public/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2026-07-25 05:53:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify remote setup and verify manual CouchDB onboarding

Browse Source
This commit is contained in:
vorotamoroz
2026-07-23 16:46:50 +00:00
parent 1df034f12a
commit c8050322e4
14 changed files with 492 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/quick_setup.md
+22 -2
View File
@@ -100,6 +100,26 @@ Add optional features separately so that their ownership and initialisation dire
Do not enable both features for the same files.
## Manual configuration
## Configure CouchDB manually on the first device
If a Setup URI is unavailable, choose `Enter the server information manually` during onboarding. Manual configuration is an advanced path: verify the connection, encryption, remote profile, and synchronisation preset before initialising either side. After the first device works, use `Copy settings as a new Setup URI` from the command palette to add later devices through the recommended path.
Use this path when CouchDB is ready but a Setup URI is unavailable. It configures one first device through the visible onboarding dialogue; it does not provision or repair the CouchDB server. Add later devices with a Setup URI generated by this working first device instead of entering the credentials again.
1. Install and enable Self-hosted LiveSync in the intended Vault.
2. Select the `Welcome to Self-hosted LiveSync` Notice, choose `I am setting this up for the first time`, then confirm that you want to set up a new synchronisation.
3. On `Connection Method`, select `Configure a remote manually`, then select `Proceed with manual configuration`.
4. On `End-to-End Encryption`, decide how the synchronised data will be protected.
- For an ordinary new Vault, enable `End-to-End Encryption` and enter a strong Vault encryption passphrase.
- Enable `Obfuscate Properties` if remote document properties should also be concealed.
- Store the Vault encryption passphrase securely. It is separate from the passphrase used to protect a Setup URI.
5. On `Choose a synchronisation remote`, select `CouchDB`, then select `Continue to CouchDB setup`.
6. Enter the complete CouchDB URL, username, password, and database name.
- Obsidian Mobile requires HTTPS. Plain HTTP is suitable only for a trusted local connection from a desktop device.
- Use credentials which are allowed to connect to the selected database and, for this first-device path, create it when it does not exist.
7. `Check server requirements` is optional. It sends the displayed credentials to the configured server through Obsidian's internal request API, and some checks require CouchDB administrator access. The initial check is read-only. If it offers a server change, review and confirm that individual change separately.
8. Select `Create or connect to database and continue`. Onboarding requires this connection test to succeed.
9. Review `Setup Complete: Preparing to Initialise Server`, then select `Restart and Initialise Server`.
10. Read the final overwrite warning. Select `I Understand, Overwrite Server` only when this device is intentionally the source of truth and a current backup exists.
11. A newly created database can show `Fetch Remote Configuration Failed` because it does not yet contain a saved preferred configuration. Select `Skip and proceed` only for this known new database.
12. Acknowledge `All optional features are disabled`, then keep Obsidian open until the initialisation progress has cleared.
Create and synchronise an ordinary test note. Once it has reached CouchDB, follow [Create a Setup URI for another device](#create-a-setup-uri-for-another-device), then [Add another device](#add-another-device). This keeps the second device aligned with the remote profile and encryption settings which the first device actually applied.