[Feature Request]: Setup Wizard

[AB-boi]

Real Outcome

Hi! Thanks for making this plugin. Been looking to switch from Remotely Save for a long time but was waiting for v3.

My first sync was a bit confusing. I have never used webDAV before so to set it up I went through your docs and koofr's docs as well. The confusion was around how to set the Host URL and Base Directory. I included /dav/Koofr in the Base Directory field because of Koofr's documentation suggesting:

Note: If there is a Root or Path field available in the WebDAV settings of the service you are trying to connect, you must input https://app.koofr.net/ into the Host field and /dav/Koofr into the Root field.

Note: If you want to create a subfolder, include it into the Root field /dav/Koofr/pathtosubfolder.

so that failed. Then I tried to put it in the URL and the connection ping worked. Perhaps, some guidance about this can be included in the documentation?

The next issue was that I had installed and enabled all the modules needed (Encryption and webDAV) but I did not select the backend (left it blank) I think. I went ahead with the rest of the setup—passwords, username, config, encryption—and got ready to sync. Note that when I enabled encryption for the first time now, the migration warning did not appear. I pressed the sync button manually and it got stuck at the analyzing page for a good few seconds but then it came back with the sync plan. I clicked okay and it synced partially with many errors:

My Koofr populated with files that had original names with prefixes. I checked the settings and scrolled to the encryption toggle and it turned off in front of me! (Do note that before the sync I changed the IDs of the keychain entries).

So I had to retry the whole thing and as per your documentation I deleted the plugin, and restarted obsidian, cleared the broken files on Koofr and reinstalled the plugin. This time I made sure to select the backend and when I enabled the encryption toggle, the migration warning showed up. I manually synced but noticed that many of the files were planned for deletion in the sync plan. So, I cleared all records. And it worked perfectly this time!

Expected Outcome

So the things to note are:

1. Plugin config or at least the first sync after setup should not be allowed until backend is chosen.
2. Plugin uninstall doesn't seem to clear sync records. https://sync.consensia.cc/usage/migration#manual-migration
3. Would be nice to have some beginner friendly instructions for webDAV setup.

Backend

WebDAV

Steps to Reproduce

Install and enable necessary modules
Don't select backend
try syncing

Support Log

Issue Policies

• I agree to follow this project's issue policies and confirm:

[hesprs]

Oh my god, glad to hear that everything finally works for you. But if you clicked "Clear all records", next time you open Obsidian the plugin would warn against you like this:

The fastest solution is to click "Delete", and go to module management panel to download those modules back. You module configurations will be retained.

[hesprs]

And sorry for the confusion when setting this plugin up. A setup wizard is scheduled for next update.

[hesprs]

Encryption turning off feels abnormal, if you change Obsidian keychain IDs, the plugin would lose its password, and encryption will fail at start instead of proceed unencrypted.

[AB-boi]

@hesprs What's weird is I just relaunched obsidian and saw this unknown module error. I came to report but you have already mentioned it. I didn't show up till now tho. Something is weird.

[AB-boi]

The fastest solution is to click "Delete", and go to module management panel to download those modules back. You module configurations will be retained.

I tried this and it's fixed now.

[hesprs]

Sync Engine stores module information in the record store. When you click "Clear all records", they get cleared as well. So next time Sync Engine tries to start those modules, it does not see the download record, then thinks those modules are malicious attacks, so it reports them.

In most cases, "Clear vault records" is enough.

[hesprs]

Encryption turning off feels abnormal, if you change Obsidian keychain IDs, the plugin would lose its password, and encryption will fail at start instead of proceed unencrypted.

Could you provide more detail? And how it "turns of in front of you"? This could be a potential bug.

[AB-boi]

Encryption turning off feels abnormal, if you change Obsidian keychain IDs, the plugin would lose its password, and encryption will fail at start instead of proceed unencrypted.

Could you provide more detail? And how it "turns of in front of you"? This could be a potential bug.

I wish i could provide more detail but right now I have set up sync successfully for both my devices and it works well. But the initial experience is a bit rocky. I would have to recreate the bug to check again. I think the plugin's UI is probably lagging a little bit whenever it detects a change in config.

[AB-boi]

Sync Engine stores module information in the record store. When you click "Clear all records", they get cleared as well. So next time Sync Engine tries to start those modules, it does not see the download record, then thinks those modules are malicious attacks, so it reports them.

In most cases, "Clear vault records" is enough.

Oh I will use the right option the next time.
Why doesn't Clear all records delete the .js plugin as well?

[hesprs]

Why doesn't Clear all records delete the .js plugin as well?

Since the modules are stored in physical files but the records are stored in IndexedDB, a more secured location for critical data.

"Clear all records" is confusing for most users and only contributes chaos, I'm going to remove it next version.

[AB-boi]

"Clear all records" is confusing for most users and only contributes chaos, I'm going to remove it next version.

Yeah it is confusing. The docs say:

Clear all records removes records for all vaults on this machine and installed modules.

Why would it clear across all vaults on device? Doesn't each vault have its own copy of the plugin?

[hesprs]

Why would it clear across all vaults on device? Doesn't each vault have its own copy of the plugin?

Because IndexedDB is embedded in Obsidian APP and shared across the PC. The actual module files are separate, but their metadata are located in the same store.

And about the encryption disabled issue, I've found the cause, it is a true bug.

[AB-boi]

Ah okk. Thanks for explaining!