Fixed:

- Fixed a problem with synchronisation taking a long time to start in some cases. - Now we can disable E2EE encryption. Improved: - `Setup Wizard` is now more clear. - `Minimal Setup` is now more simple. - Self-hosted LiveSync now be able to use even if there are vaults with the same name. - Now Self-hosted LiveSync waits until set-up is complete. - Show reload prompts when possibly recommended while settings. New feature: - A guidance dialogue prompting for settings will be shown after the installation. Changed - Some setting names has been changed
vrtmrz · Feb 20, 2024 · 65619c2 · 65619c2
1 parent 1552fa9
commit 65619c2
Show file tree

Hide file tree

Showing 13 changed files with 289 additions and 196 deletions.
diff --git a/README.md b/README.md
@@ -34,13 +34,15 @@ This plug-in might be useful for researchers, engineers, and developers with a n
 
 [![LiveSync Setup onto Fly.io SpeedRun 2024 using Google Colab](https://img.youtube.com/vi/7sa_I1832Xc/0.jpg)](https://www.youtube.com/watch?v=7sa_I1832Xc)
 
-- [Setup CouchDB on fly.io](docs/setup_flyio.md)
+1. [Setup CouchDB on fly.io](docs/setup_flyio.md)
+2. Configure plug-in in [Quick Setup](docs/quick_setup.md)
 
 ### Manually Setup
 
-1. [Setup CouchDB on fly.io](docs/setup_flyio.md)
-2. [Setup your CouchDB](docs/setup_own_server.md)
-3. [Configure plug-in](docs/quick_setup.md)
+1. Setup the server
+   1. [Setup CouchDB on fly.io](docs/setup_flyio.md)
+   2. [Setup your CouchDB](docs/setup_own_server.md)
+2. Configure plug-in in [Quick Setup](docs/quick_setup.md)
 
 > [!TIP]
 > We are still able to use IBM Cloudant. However, it is not recommended for several reasons nowadays. Here is [Setup IBM Cloudant](docs/setup_cloudant.md)

diff --git a/docs/quick_setup.md b/docs/quick_setup.md
@@ -2,48 +2,61 @@
 
 [Japanese docs](./quick_setup_ja.md) - [Chinese docs](./quick_setup_cn.md).
 
-The plugin has so many configuration options to deal with different circumstances. However, there are not so many settings that are actually used. Therefore, `The Setup wizard` has been implemented to simplify the initial setup.
+The plugin has so many configuration options to deal with different circumstances. However, only a few settings are required in the normal cases. Therefore, `The Setup wizard` has been implemented to simplify the setup.
 
-Note: Subsequent devices are recommended to be set up using the `Copy setup URI` and `Open setup URI`.
+![](../images/quick_setup_1.png)
 
-## The Setup wizard
-Open the `🧙‍♂️ Setup wizard` in the settings dialogue. If the plugin has not been configured before, it should already be open.
+There are three methods to set up Self-hosted LiveSync.
 
-![](../images/quick_setup_1.png)
+1. [Using setup URIs](#1-using-setup-uris) *(Recommended)*
+2. [Minimal setup](#2-minimal-setup)
+3. [Full manually setup the and Enable on this dialogue](#3-manually-setup)
 
-- Discard the existing configuration and set up  
-If you have changed any settings, this button allows you to discard all changes before setting up.
+## At the first device
 
-- Do not discard the existing configuration and set up  
-Simply reconfigure. Be careful. In wizard mode, you cannot see all configuration items, even if they have been configured.
+### 1. Using setup URIs
 
-Pressing `Next` on one of the above options will put the configuration dialog into wizard mode.
+> [!TIP] What is the setup URI? Why is it required?
+> The setup URI is the encrypted representation of Self-hosted LiveSync configuration as a URI. This starts `obsidian://setuplivesync?settings=`. This is encrypted with a passphrase, so that it can be shared relatively securely between devices. It is a bit long, but it is one line. This allows a series of settings to be set at once without any inconsistencies. 
+> 
+> If you have configured the remote database by [Automated setup on Fly.io](./setup_flyio.md#a-very-automated-setup) or [set up your server with the tool](./setup_own_server.md#1-generate-the-setup-uri-on-a-desktop-device-or-server), **you should have one of them** 
 
-### Wizard mode
+In this procedure, [this video](https://youtu.be/7sa_I1832Xc?t=146) may help us.
 
-![](../images/quick_setup_2.png)
+1. Click `Use` button (Or launch `Use the copied setup URI` from Command palette).
+2. Paste the Setup URI into the dialogue
+3. Type the passphrase of the Setup URI
+4. Answer `yes` for `Importing LiveSync's conf, OK?`.
+5. Answer `Set it up as secondary or subsequent device` for `How would you like to set it up?`.
+6. Initialisation will begin, please hold a while.
+7. You will asked about the hidden file synchronisation, answer as you like.
+   1. If you are new to Self-hosted LiveSync, we can configure it later so leave it once.
+8. Synchronisation has been started! `Reload app without saving` is recommended after the indicators of Self-hosted LiveSync disappear.
+
+OK, we can proceed the [next step](#).
 
-Let's see how to use it step-by-step.
+### 2. Minimal setup
 
-## Remote Database configuration
+If you do not have any setup URI, Press the `start` button. The setting dialogue turns into the wizard mode and will display only minimal items.
 
-### Remote database configuration 
+>[!TIP]
+> We can generate the setup URI with the tool in any time. Please use [this tool](./setup_own_server.md#1-generate-the-setup-uri-on-a-desktop-device-or-server).
 
-Enter the information for the database we have set up.  
+![](../images/quick_setup_2.png)
+
+#### Remote database configuration 
+
+1. Enter the information for the database we have set up.
 
 ![](../images/quick_setup_3.png)  
 
 
 #### Test database connection and Check database configuration
 
 We can check the connectivity to the database, and the database settings.
-
 ![](../images/quick_setup_5.png)  
 
-#### Test Database Connection
-Check whether we can connect to the database. If it fails, there are several possible reasons, but first attempt the `Check database configuration` check to see if it fails there too.
-
-#### Check database configuration
+#### Check and Fix database configuration
 
 Check the database settings and fix any problems on the spot.
 
@@ -52,40 +65,43 @@ Check the database settings and fix any problems on the spot.
 This item may vary depending on the connection. In the above case, press all three Fix buttons.  
 If the Fix buttons disappear and all become check marks, we are done.
 
-
-### Confidentiality configuration
+#### Confidentiality configuration (Optional but very preferred)
 
 ![](../images/quick_setup_4.png)
 
-Encrypt your database in case of unintended database exposure; enable End to End encryption and the contents of your notes will be encrypted at the moment it leaves the device. We strongly recommend enabling it. And `Path Obfuscation` also obfuscates filenames. Now stable and recommended.  
-Encryption is based on 256-bit AES-GCM.  
-These setting can be disabled if you are inside a closed network and it is clear that you will not be accessed by third parties.
+Enable End-to-end encryption and the contents of your notes will be encrypted at the moment it leaves the device. We strongly recommend enabling it. And `Path Obfuscation` also obfuscates filenames. Now stable and recommended.
 
-![](../images/quick_setup_7.png)
+These setting can be disabled if you are inside a closed network and it is clear that you will not be accessed by third parties.
 
-#### Next 
-Go to the Sync Settings.
+> [!TIP]
+> Encryption is based on 256-bit AES-GCM.  
 
-#### Discard existing database and proceed
-Discard the contents of the Remote database and go to the Sync Settings.
+We should proceed to the Next step.
 
-### Sync Settings
+#### Sync Settings
 Finally, finish the wizard by selecting a preset for synchronisation.
 
 ![](../images/quick_setup_9_1.png)
 
-Select any synchronisation methods we want to use and `Apply` to initialise and build the local and remote databases as required. If `All done!` is displayed, we are done. Automatically, `Copy setup URI` will open and we will be asked for a passphrase to encrypt the `Setup URI`.
+Select any synchronisation methods we want to use and `Apply`. If database initialisation is required, it will be performed at this time. When `All done!` is displayed, we are ready to synchronise.
+
+The dialogue of `Copy settings as a new setup URI` will be open automatically. Please input a passphrase to encrypt the new `Setup URI`. (This passphrase is to encrypt the setup URI, not the vault).
 
 ![](../images/quick_setup_10.png)
 
-Set the passphrase as you like.  
-The Setup URI will be copied to the clipboard, which you can then transfer to the second and subsequent devices in some way.
+The Setup URI will be copied to the clipboard, please make a note(Not in Obsidian) of this.
+
+>[!TIP]
+We can copy this in any time by `Copy current settings as a new setup URI`.
+
+### 3. Manually setup
+
+It is strongly recommended to perform a "minimal set-up" first and set up the other contents after making sure has been synchronised.
 
-# How to set up the second and subsequent units
-After installing Self-hosted LiveSync on the first device, select `Open setup URI` from the command palette and enter the setup URI you transferred. Afterwards, enter your passphrase and a setup wizard will open.  
-Answer the following.
+However, if you have some specific reasons to configure it manually, please click the `Enable` button of `Enable LiveSync on this device as the set-up was completed manually`.
+And, please copy the setup URI by `Copy current settings as a new setup URI` and make a note(Not in Obsidian) of this.
 
-- `Yes` to `Importing LiveSync's conf, OK?`
-- `Set it up as secondary or subsequent device` to `How would you like to set it up?`.
+## At the subsequent device
+After installing Self-hosted LiveSync on the first device, we should have a setup URI. **The first choice is to use it**. Please share it with the device you want to setup.
 
-Then, The configuration will take effect and replication will start. Your files will be synchronised soon! You may need to close the settings dialog and reopen it to see the settings fields populated properly, but they will be set.
+It is completely same as [Using setup URIs on the first device](#1-using-setup-uris). Please refer it.
diff --git a/docs/setup_flyio.md b/docs/setup_flyio.md
@@ -28,8 +28,10 @@ This is how to configure fly.io and CouchDB on it for Self-hosted LiveSync.
 2. Press the `Open in Colab` button.
 3. Choose a region and run all blocks (Refer to video).
    1. If you do not have the account yet, the sign-up page will be shown, please follow the instructions. The [Official document is here](https://fly.io/docs/hands-on/sign-up/).
-4. Copy the Setup-URI and open it in the Obsidian.
-5. You have been synchronised. Open the Setup-URI in subsequent devices.
+4. Copy the Setup-URI and Use it in the Obsidian.
+5. You have been synchronised. Use the Setup-URI in subsequent devices.
+
+Steps 4 and 5 are detailed in the [Quick Setup](./quick_setup.md#1-using-setup-uris).
 
 > [!NOTE]
 > Your automatically configured configurations will be shown on the result in the Colab note like below, and **it will not be saved**. Please make a note of it somewhere.
@@ -240,8 +242,8 @@ Note: Each of these should also be repeated until finished in 200.
 
 #### 6. Use it from Self-hosted LiveSync
 
-Now the CouchDB is ready to use from Self-hosted LiveSync. We can use `https://billowing-dawn-6619.fly.dev` in URI, `campanella` in `Username` and `dfusiuada9suy` in `Password` on Self-hosted LiveSync. `Database name` could be anything you want.
-`Enhance chunk size` could be up to around `100`.
+Now the CouchDB is ready to use from Self-hosted LiveSync. We can use `https://billowing-dawn-6619.fly.dev` in URI, `campanella` in `Username` and `dfusiuada9suy` in `Password` on Self-hosted LiveSync. The `Database name` could be anything you want.
+Please refer to the [Minimal Setup of the Quick Setup](./quick_setup.md#2-minimal-setup).
 
 ## Delete the Instance
 

diff --git a/docs/setup_own_server.md b/docs/setup_own_server.md
@@ -113,7 +113,7 @@ obsidian://setuplivesync?settings=%5B%22tm2DpsOE74nJAryprZO2M93wF%2Fvg.......4b2
 ### 2. Setup Self-hosted LiveSync to Obsidian
 [This video](https://youtu.be/7sa_I1832Xc?t=146) may help us.
 1. Install Self-hosted LiveSync
-2. Choose `Open the Setup URI` from the command palette and paste the setup URI. (obsidian://setuplivesync?settings=.....).
+2. Choose `Use the copied setup URI` from the command palette and paste the setup URI. (obsidian://setuplivesync?settings=.....).
 3. Type `welcome` for setup-uri passphrase.
 4. Answer `yes` and `Set it up...`, and finish the first dialogue with `Keep them disabled`.
 5. `Reload app without save` once.

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -14,7 +14,15 @@
 - Fixed at: v0.21.2 (Fixed but not reviewed)
 - Required action: larger files will not be fixed automatically, please perform `Verify and repair all files`. If our local database and storage are not matched, we will be asked to apply which one.
 
-<!-- Add here -->
+### Some setting name has been changed
+- Fixed at: v0.22.6
+
+| Previous name                | New name                                 |
+| ---------------------------- | ---------------------------------------- |
+| Open setup URI               | Use the copied setup URI                 |
+| Copy setup URI               | Copy current settings as a new setup URI |
+| Setup Wizard                 | Minimal Setup                            |
+| Check database configuration | Check and Fix database configuration     |
 
 ## FAQ
 

diff --git a/images/quick_setup_1.png b/images/quick_setup_1.png
diff --git a/images/quick_setup_5.png b/images/quick_setup_5.png
diff --git a/images/quick_setup_7.png b/images/quick_setup_7.png
diff --git a/src/CmdSetupLiveSync.ts b/src/CmdSetupLiveSync.ts
@@ -5,7 +5,7 @@ import { PouchDB } from "./lib/src/pouchdb-browser.js";
 import { askSelectString, askYesNo, askString } from "./utils";
 import { decrypt, encrypt } from "./lib/src/e2ee_v2";
 import { LiveSyncCommands } from "./LiveSyncCommands";
-import { delay } from "./lib/src/utils";
+import { delay, fireAndForget } from "./lib/src/utils";
 import { confirmWithMessage } from "./dialogs";
 import { Platform } from "./deps";
 import { fetchAllUsedChunks } from "./lib/src/utils_couchdb";
@@ -17,25 +17,25 @@ export class SetupLiveSync extends LiveSyncCommands {
 
         this.plugin.addCommand({
             id: "livesync-copysetupuri",
-            name: "Copy the setup URI",
-            callback: this.command_copySetupURI.bind(this),
+            name: "Copy settings as a new setup URI",
+            callback: () => fireAndForget(this.command_copySetupURI()),
         });
         this.plugin.addCommand({
             id: "livesync-copysetupuri-short",
-            name: "Copy the setup URI (With customization sync)",
-            callback: this.command_copySetupURIWithSync.bind(this),
+            name: "Copy settings as a new setup URI (With customization sync)",
+            callback: () => fireAndForget(this.command_copySetupURIWithSync()),
         });
 
         this.plugin.addCommand({
             id: "livesync-copysetupurifull",
-            name: "Copy the setup URI (Full)",
-            callback: this.command_copySetupURIFull.bind(this),
+            name: "Copy settings as a new setup URI (Full)",
+            callback: () => fireAndForget(this.command_copySetupURIFull()),
         });
 
         this.plugin.addCommand({
             id: "livesync-opensetupuri",
-            name: "Open the setup URI",
-            callback: this.command_openSetupURI.bind(this),
+            name: "Use the copied setup URI (Formerly Open setup URI)",
+            callback: () => fireAndForget(this.command_openSetupURI()),
         });
     }
     onInitializeDatabase(showNotice: boolean) { }
@@ -76,7 +76,7 @@ export class SetupLiveSync extends LiveSyncCommands {
         Logger("Setup URI copied to clipboard", LOG_LEVEL_NOTICE);
     }
     async command_copySetupURIWithSync() {
-        this.command_copySetupURI(false);
+        await this.command_copySetupURI(false);
     }
     async command_openSetupURI() {
         const setupURI = await askString(this.app, "Easy setup", "Set up URI", `${configURIBase}aaaaa`);
@@ -108,13 +108,15 @@ export class SetupLiveSync extends LiveSyncCommands {
                     newSettingW.configPassphraseStore = "";
                     newSettingW.encryptedPassphrase = "";
                     newSettingW.encryptedCouchDBConnection = "";
+                    newSettingW.additionalSuffixOfDatabaseName = `${("appId" in this.app ? this.app.appId : "")}`
                     const setupJustImport = "Just import setting";
                     const setupAsNew = "Set it up as secondary or subsequent device";
                     const setupAsMerge = "Secondary device but try keeping local changes";
                     const setupAgain = "Reconfigure and reconstitute the data";
                     const setupManually = "Leave everything to me";
                     newSettingW.syncInternalFiles = false;
                     newSettingW.usePluginSync = false;
+                    newSettingW.isConfigured = true;
                     // Migrate completely obsoleted configuration.
                     if (!newSettingW.useIndexedDBAdapter) {
                         newSettingW.useIndexedDBAdapter = true;
@@ -333,10 +335,18 @@ Of course, we are able to disable these features.`
 
             const ret = await confirmWithMessage(this.plugin, "Database adapter", message, choices, CHOICE_YES, 10);
             if (ret == CHOICE_YES) {
-                this.plugin.settings.useIndexedDBAdapter = false;
+                this.plugin.settings.useIndexedDBAdapter = true;
             }
         }
     }
+    async resetLocalDatabase() {
+        if (this.plugin.settings.isConfigured && this.plugin.settings.additionalSuffixOfDatabaseName == "") {
+            // Discard the non-suffixed database
+            await this.plugin.resetLocalDatabase();
+        }
+        this.plugin.settings.additionalSuffixOfDatabaseName = `${("appId" in this.app ? this.app.appId : "")}`
+        await this.plugin.resetLocalDatabase();
+    }
     async fetchRemoteChunks() {
         if (!this.plugin.settings.doNotSuspendOnFetching && this.plugin.settings.readChunksOnline) {
             Logger(`Fetching chunks`, LOG_LEVEL_NOTICE);
@@ -351,10 +361,11 @@ Of course, we are able to disable these features.`
     }
     async fetchLocal() {
         this.suspendExtraSync();
-        this.askUseNewAdapter();
+        await this.askUseNewAdapter();
+        this.plugin.settings.isConfigured = true;
         await this.suspendReflectingDatabase();
         await this.plugin.realizeSettingSyncMode();
-        await this.plugin.resetLocalDatabase();
+        await this.resetLocalDatabase();
         await delay(1000);
         await this.plugin.markRemoteResolved();
         await this.plugin.openDatabase();
@@ -369,10 +380,11 @@ Of course, we are able to disable these features.`
     }
     async fetchLocalWithKeepLocal() {
         this.suspendExtraSync();
-        this.askUseNewAdapter();
+        await this.askUseNewAdapter();
+        this.plugin.settings.isConfigured = true;
         await this.suspendReflectingDatabase();
         await this.plugin.realizeSettingSyncMode();
-        await this.plugin.resetLocalDatabase();
+        await this.resetLocalDatabase();
         await delay(1000);
         await this.plugin.initializeDatabase(true);
         await this.plugin.markRemoteResolved();
@@ -388,6 +400,7 @@ Of course, we are able to disable these features.`
     }
     async rebuildRemote() {
         this.suspendExtraSync();
+        this.plugin.settings.isConfigured = true;
         await this.plugin.realizeSettingSyncMode();
         await this.plugin.markRemoteLocked();
         await this.plugin.tryResetRemoteDatabase();
@@ -401,9 +414,10 @@ Of course, we are able to disable these features.`
     }
     async rebuildEverything() {
         this.suspendExtraSync();
-        this.askUseNewAdapter();
+        await this.askUseNewAdapter();
+        this.plugin.settings.isConfigured = true;
         await this.plugin.realizeSettingSyncMode();
-        await this.plugin.resetLocalDatabase();
+        await this.resetLocalDatabase();
         await delay(1000);
         await this.plugin.initializeDatabase(true);
         await this.plugin.markRemoteLocked();