public/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2026-07-27 23:13:03 +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
src/modules/features/SetupWizard/dialogs/SelectMethodExisting.svelte
+4 -3
View File
@@ -7,6 +7,7 @@
import Options from "@/modules/services/LiveSyncUI/components/Options.svelte";
import Instruction from "@/modules/services/LiveSyncUI/components/Instruction.svelte";
import UserDecisions from "@/modules/services/LiveSyncUI/components/UserDecisions.svelte";
import { $msg as translateMessage } from "@/common/translation";
import {
TYPE_USE_SETUP_URI,
TYPE_SCAN_QR_CODE,
@@ -24,7 +25,7 @@
if (userType === TYPE_USE_SETUP_URI) {
return "Proceed with Setup URI";
} else if (userType === TYPE_CONFIGURE_MANUALLY) {
return "I know my server details, let me enter them";
return translateMessage("Ui.SetupWizard.SelectExisting.ProceedManual");
} else if (userType === TYPE_SCAN_QR_CODE) {
return "Scan the QR code displayed on an active device using this device's camera.";
} else {
@@ -49,10 +50,10 @@
</Option>
<Option
selectedValue={TYPE_CONFIGURE_MANUALLY}
title="Enter the server information manually"
title={translateMessage("Ui.SetupWizard.SelectExisting.ManualOption")}
bind:value={userType}
>
Configure the same server information as your other devices again, manually, very advanced users only.
{translateMessage("Ui.SetupWizard.SelectExisting.ManualOptionDesc")}
</Option>
</Options>
</Instruction>
src/modules/features/SetupWizard/dialogs/SelectMethodNewUser.svelte
+6 -9
View File
@@ -24,7 +24,7 @@
if (userType === TYPE_USE_SETUP_URI) {
return "Proceed with Setup URI";
} else if (userType === TYPE_CONFIGURE_MANUALLY) {
return "I know my server details, let me enter them";
return translateMessage("Ui.SetupWizard.SelectNew.ProceedManual");
} else {
return "Please select an option to proceed";
}
@@ -35,22 +35,19 @@
</script>
<DialogHeader title="Connection Method" />
<Guidance>We will now proceed with the server configuration.</Guidance>
<Guidance>{translateMessage("Ui.SetupWizard.SelectNew.Guidance")}</Guidance>
<Instruction>
<Question>How would you like to configure the connection to your server?</Question>
<Question>{translateMessage("Ui.SetupWizard.SelectNew.Question")}</Question>
<Options>
<Option selectedValue={TYPE_USE_SETUP_URI} title="Use a Setup URI (Recommended)" bind:value={userType}>
A Setup URI is a single string of text containing your server address and authentication details. Using a
URI, if one was generated by your server installation script, provides a simple and secure configuration.
{translateMessage("Ui.SetupWizard.SelectNew.SetupUriOptionDesc")}
</Option>
<Option
selectedValue={TYPE_CONFIGURE_MANUALLY}
title="Enter the server information manually"
title={translateMessage("Ui.SetupWizard.SelectNew.ManualOption")}
bind:value={userType}
>
This is an advanced option for users who do not have a URI or who wish to configure detailed settings.
You can also select this option if you intend to use <strong>P2P (Peer-to-Peer) synchronisation</strong>
instead of a CouchDB/S3 server.
{translateMessage("Ui.SetupWizard.SelectNew.ManualOptionDesc")}
{translateMessage(
"P2P requires no central data-storage server, but it still uses a signalling relay for peer discovery."
)}
src/modules/features/SetupWizard/dialogs/SetupRemote.svelte
+15 -7
View File
@@ -24,9 +24,9 @@
if (userType === TYPE_COUCHDB) {
return "Continue to CouchDB setup";
} else if (userType === TYPE_BUCKET) {
return "Continue to S3/MinIO/R2 setup";
return translateMessage("Ui.SetupWizard.SetupRemote.ProceedBucket");
} else if (userType === TYPE_P2P) {
return "Continue to Peer-to-Peer only setup";
return translateMessage("Ui.SetupWizard.SetupRemote.ProceedP2P");
} else {
return "Please select an option to proceed";
}
@@ -36,18 +36,26 @@
});
</script>
<DialogHeader title="Enter Server Information" />
<DialogHeader title={translateMessage("Ui.SetupWizard.SetupRemote.Title")} />
<Instruction>
<Question>Please select the type of server to which you are connecting.</Question>
<Question>{translateMessage("Ui.SetupWizard.SetupRemote.Guidance")}</Question>
<Options>
<Option selectedValue={TYPE_COUCHDB} title="CouchDB" bind:value={userType}>
This is the most suitable synchronisation method for the design. All functions are available. You must have
set up a CouchDB instance.
</Option>
<Option selectedValue={TYPE_BUCKET} title="S3/MinIO/R2 Object Storage" bind:value={userType}>
Synchronisation utilising journal files. You must have set up an S3/MinIO/R2 compatible object storage.
<Option
selectedValue={TYPE_BUCKET}
title={translateMessage("Ui.SetupWizard.SetupRemote.BucketOption")}
bind:value={userType}
>
{translateMessage("Ui.SetupWizard.SetupRemote.BucketOptionDesc")}
</Option>
<Option selectedValue={TYPE_P2P} title="Peer-to-Peer only" bind:value={userType}>
<Option
selectedValue={TYPE_P2P}
title={translateMessage("Ui.SetupWizard.SetupRemote.P2POption")}
bind:value={userType}
>
{translateMessage(
"No central data-storage server is required, but a signalling relay is required for peer discovery. Both devices must be online at the same time. Vault data travels through the encrypted P2P connection, not through the signalling relay. Some features may be limited."
)}