diff --git a/docs/quick_setup.md b/docs/quick_setup.md index 9b5afee..1720cc9 100644 --- a/docs/quick_setup.md +++ b/docs/quick_setup.md @@ -1,17 +1,17 @@ # Quick setup -The Setup wizard has been implemented since v0.15.0 simplifying the initial setup. +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. -Note: Subsequent devices should be set up using the `Copy setup URI` and `Open setup URI` functionality. +Note: Subsequent devices are recommended to be set up using the `Copy setup URI` and `Open setup URI`. -## How to open and use the wizard -Open the `🪄 Setup wizard` in the settings dialogue. If the plugin has not been configured before, it should already be open. +## The Setup wizard +Open the `🧙‍♂️ Setup wizard` in the settings dialogue. If the plugin has not been configured before, it should already be open. ![](../images/quick_setup_1.png) -### Discard the existing configuration and set up +- Discard the existing configuration and set up If you have changed any settings, this button allows you to discard all changes before setting up. -### Do not discard the existing configuration and set up +- 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. Pressing `Next` on one of the above options will put the configuration dialog into wizard mode. @@ -30,17 +30,10 @@ Enter the information for the database we have set up. ![](../images/quick_setup_3.png) -### End to End Encryption -![](../images/quick_setup_4.png) +#### Test database connection and Check database configuration -When End to End encryption is enabled, a third party will be less likely to be able to read your Remote database in the event of a data breach/leak (assuming they do not know the Passphrase). We strongly recommend enabling it. -Encryption is based on 256-bit AES-GCM. -This setting can be disabled if you are inside a closed network and it is clear that you will not be accessed by third parties. - -### Test database connection and Check database configuration - -Here we can check the status of the connection to the database and the database settings. +We can check the connectivity to the database, and the database settings. ![](../images/quick_setup_5.png) @@ -49,38 +42,36 @@ Check whether we can connect to the database. If it fails, there are several pos #### Check database configuration -Check the database settings and fix any deficiencies on the spot. +Check the database settings and fix any problems on the spot. ![](../images/quick_setup_6.png) 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 + +![](../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. + ![](../images/quick_setup_7.png) -### Next -Go to the Local Database configuration. +#### Next +Go to the Sync Settings. -### Discard existing database and proceed -Discard the contents of the Remote database and go to the Local Database configuration. +#### Discard existing database and proceed +Discard the contents of the Remote database and go to the Sync Settings. -## Local Database configuration - -![](../images/quick_setup_8.png) - -Configure the local database. If we already have a Vault with Self-hosted LiveSync installed which has the same directory name as the one we are currently setting up, please specify a different suffix than the Vault you have already set up here. - -## Miscellaneous -Finally, finish the miscellaneous configurations and select a preset for synchronisation. +### Sync Settings +Finally, finish the wizard by selecting a preset for synchronisation. ![](../images/quick_setup_9_1.png) -The `Show status inside editor` can be enabled to your liking. If enabled, the status is displayed in the top right-hand corner of the editor. Learn how to read the status bar [here](/README.md#information-in-statusbar). - -![](../images/quick_setup_9_2.png) - -From Presets, select the synchronisation method 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` 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`. ![](../images/quick_setup_10.png) diff --git a/docs/quick_setup_ja.md b/docs/quick_setup_ja.md index 19ee84b..8af0779 100644 --- a/docs/quick_setup_ja.md +++ b/docs/quick_setup_ja.md @@ -1,10 +1,10 @@ # Quick setup -v0.15.0からSetup wizardが実装されました。これで、初回セットアップがシンプルになります。 +このプラグインには、いろいろな状況に対応するための非常に多くの設定オプションがあります。しかし、実際に使用する設定項目はそれほど多くはありません。そこで、初期設定を簡略化するために、「セットアップウィザード」を実装しています。 ※なお、次のデバイスからは、`Copy setup URI`と`Open setup URI`を使ってセットアップしてください。 ## Wizardの使い方 -`🪄 Setup wizard` から開きます。もしセットアップされていなかったり、同期設定が何も有効になっていない場合はデフォルトで開いています。 +`🧙‍♂️ Setup wizard` から開きます。もしセットアップされていなかったり、同期設定が何も有効になっていない場合はデフォルトで開いています。 ![](../images/quick_setup_1.png) @@ -32,20 +32,12 @@ v0.15.0からSetup wizardが実装されました。これで、初回セット これらはデータベースをセットアップした際に決めた情報です。 -### End to End暗号化の設定 - -![](../images/quick_setup_4.png) - -End to End暗号化を有効にした場合、万が一Remote databaseの内容が流出してもPassphraseを知らない第三者にそれを読まれる可能性が低くなります。そのため、有効化を強く推奨します。 -暗号化は256bitのAES-GCMを採用しています。 -この設定は、あなたが閉じたネットワークの内側にいて、かつ第三者からアクセスされない事が明確な場合には無効にできます。 - -### Test database connectionとCheck database configuraion +### Test database connectionとCheck database configuration ここで、データベースへの接続状況と、データベース設定を確認します。 ![](../images/quick_setup_5.png) #### Test Database Connection -データベースに接続出来るか自体を確認します。失敗する場合はいくつか理由がありますが、一度Check database configurationを行ってそちらでも失敗するか確認してください。 +データベースに接続できるか自体を確認します。失敗する場合はいくつか理由がありますが、一度Check database configurationを行ってそちらでも失敗するか確認してください。 #### Check database configuration データベースの設定を確認し、不備がある場合はその場で修正します。 @@ -55,6 +47,15 @@ End to End暗号化を有効にした場合、万が一Remote databaseの内容 この項目は接続先によって異なる場合があります。上記の場合、みっつのFixボタンを順にすべて押してください。 Fixボタンがなくなり、すべてチェックマークになれば完了です。 +### 機密性設定 + +![](../images/quick_setup_4.png) + +意図しないデータベースの暴露に備えて、End to End Encryptionを有効にします。この項目を有効にした場合、デバイスを出る瞬間にノートの内容が暗号化されます。`Path Obfuscation`を有効にすると、ファイル名も難読化されます。現在は安定しているため、こちらも推奨されます。 +暗号化には256bitのAES-GCMを採用しています。 +これらの設定は、あなたが閉じたネットワークの内側にいて、かつ第三者からアクセスされない事が明確な場合には無効にできます。 + + ![](../images/quick_setup_7.png) ### Next @@ -63,20 +64,13 @@ Fixボタンがなくなり、すべてチェックマークになれば完了 ### Discard exist database and proceed すでにRemote databaseがある場合、Remote databaseの内容を破棄してから次へ進みます -## Local Database confiuration -![](../images/quick_setup_8.png) -ローカルのデータベースを設定します。もし、すでにSelf-hosted LiveSyncをインストールしたVaultがあり、そのVaultと同じデータベース名を使用している場合は、ここですでに設定したVaultとは異なるsuffixを指定してください。 -## Miscellaneous -最後にその他の設定を行います。 +## Sync Settings +最後に同期方法の設定を行います。 ![](../images/quick_setup_9_1.png) -`Show status inside editor`はお好みで有効化してください。有効にするとエディターの右上にステータスが表示されます。 - -![](../images/quick_setup_9_2.png) - -Presetsから、使用する同期方法を選び`Apply`を行うと、必要に応じてローカル・リモートのデータベースを初期化・構築します。 +Presetsから、いずれかの同期方法を選び`Apply`を行うと、必要に応じてローカル・リモートのデータベースを初期化・構築します。 All done! と表示されれば完了です。自動的に、`Copy setup URI`が開き、`Setup URI`を暗号化するパスフレーズを聞かれます。 ![](../images/quick_setup_10.png) diff --git a/images/quick_setup_1.png b/images/quick_setup_1.png index 7d37f81..0c1c92e 100644 Binary files a/images/quick_setup_1.png and b/images/quick_setup_1.png differ diff --git a/images/quick_setup_2.png b/images/quick_setup_2.png index 3459cf5..5862399 100644 Binary files a/images/quick_setup_2.png and b/images/quick_setup_2.png differ diff --git a/images/quick_setup_4.png b/images/quick_setup_4.png index 4f72332..e7748d9 100644 Binary files a/images/quick_setup_4.png and b/images/quick_setup_4.png differ diff --git a/images/quick_setup_9_1.png b/images/quick_setup_9_1.png index 703d0d9..b19e66b 100644 Binary files a/images/quick_setup_9_1.png and b/images/quick_setup_9_1.png differ