Documentated!

docs/quick_setup.md

@@ -0,0 +1,100 @@
+# Quick setup
+The Setup wizard has been implemented since v0.15.0. This simplifies the initial set-up.
+
+Note: The subsequent devices should be set up using the `Copy setup URI` and `Open setup URI`.
+
+## How to open and use wizard
+Open from `🪄 Setup wizard` in the setting dialogue. If there is no configuration or no synchronisation settings have been activated, it should already be open.
+
+![](../images/quick_setup_1.png)
+
+### Discard the existing configuration and set up
+If you have made any settings, this button allows you to discard them all before setting 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 any of these will put the configuration dialog into wizard mode.
+
+### Wizard mode
+
+![](../images/quick_setup_2.png)
+
+We can set it up step by step.
+
+## Remote Database configuration
+
+### Remote database configuration 
+
+Enter the information in the database we have set up.  
+
+![](../images/quick_setup_3.png)  
+
+### End to End Encryption
+
+![](../images/quick_setup_4.png)
+
+If End to End encryption is enabled, the possibility of a third party who does not know the Passphrase being able to read the contents of the Remote database in the event that they are leaked is reduced. So we strongly recommend to enable 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とCheck database configuraion
+
+Here we can check the status of the connection 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 a number of reasons, but once you have done the `Check database configuration`, check if it fails there too.
+
+#### Check database configuration
+
+Check the database settings and fix any deficiencies 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.
+
+![](../images/quick_setup_7.png)
+
+### Next 
+Go to the Local Database configuration.
+
+### Discard exist database and proceed
+Discard the contents of the Remote database and go to the Local Database configuration.
+
+## Local Database confiuration
+
+![](../images/quick_setup_8.png)
+
+Configure the local database. If we already have a Vaults with Self-hosted LiveSync installed and having same directory name as currently we are 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.
+
+![](../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.
+
+![](../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`.
+
+![](../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.
+
+# How to set up the second and subsequent units
+After installing Self-hosted LiveSync on the 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.
+
+- `Yes` to `Importing LiveSync's conf, OK?`
+- `No` to `Keep local DB?`
+- `Yes` to `Keep remote DB?`
+- `No` to `Rebuild the database?`
+- `Yes` to `Replicate once?`
+
+Then, The configuration will now take effect and replication will start. Your files will be synchronised soon!

docs/quick_setup_ja.md

@@ -0,0 +1,97 @@
+# Quick setup
+v0.15.0からSetup wizardが実装されました。これで、初回セットアップがシンプルになります。  
+※なお、次のデバイスからは、`Copy setup URI`と`Open setup URI`を使ってセットアップしてください。
+
+
+## Wizardの使い方
+`🪄 Setup wizard` から開きます。もしセットアップされていなかったり、同期設定が何も有効になっていない場合はデフォルトで開いています。
+
+![](../images/quick_setup_1.png)
+
+### Discard the existing configuration and set up
+今設定されている内容をいったん全部消してから、ウィザードを始めます。
+
+### Do not discard the existing configuration and set up
+今の設定を消さずにウィザードを開始します。  
+たとえ設定されていたとしても、ウィザードモードではすべての設定を見ることができません。
+
+いずれかのNextを押すと、設定画面がウィザードモードになります。
+
+### Wizardモード
+
+![](../images/quick_setup_2.png)
+
+順番に設定を行っていきます。
+
+## Remote Database configuration
+
+### Remote databaseの設定
+セットアップしたデータベースの情報を入力していきます。
+
+![](../images/quick_setup_3.png)
+
+これらはデータベースをセットアップした際に決めた情報です。
+
+### End to End暗号化の設定
+
+![](../images/quick_setup_4.png)
+
+End to End暗号化を有効にした場合、万が一Remote databaseの内容が流出してもPassphraseを知らない第三者にそれを読まれる可能性が低くなります。そのため、有効化を強く推奨します。  
+暗号化は256bitのAES-GCMを採用しています。  
+この設定は、あなたが閉じたネットワークの内側にいて、かつ第三者からアクセスされない事が明確な場合には無効にできます。
+
+### Test database connectionとCheck database configuraion
+ここで、データベースへの接続状況と、データベース設定を確認します。  
+![](../images/quick_setup_5.png)  
+
+#### Test Database Connection
+データベースに接続出来るか自体を確認します。失敗する場合はいくつか理由がありますが、一度Check database configurationを行ってそちらでも失敗するか確認してください。
+
+#### Check database configuration
+データベースの設定を確認し、不備がある場合はその場で修正します。
+
+![](../images/quick_setup_6.png)
+
+この項目は接続先によって異なる場合があります。上記の場合、みっつのFixボタンを順にすべて押してください。  
+Fixボタンがなくなり、すべてチェックマークになれば完了です。
+
+![](../images/quick_setup_7.png)
+
+### Next 
+次へ進みます
+
+### 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
+最後にその他の設定を行います。
+
+![](../images/quick_setup_9_1.png)
+
+`Show status inside editor`はお好みで有効化してください。有効にするとエディターの右上にステータスが表示されます。
+
+![](../images/quick_setup_9_2.png)
+
+Presetsから、使用する同期方法を選び`Apply`を行うと、必要に応じてローカル・リモートのデータベースを初期化・構築します。  
+All done! と表示されれば完了です。自動的に、`Copy setup URI`が開き、`Setup URI`を暗号化するパスフレーズを聞かれます。
+
+![](../images/quick_setup_10.png)
+
+お好みのパスフレーズを設定してください。  
+クリップボードにSetup URIが保存されますので、これを2台目以降のデバイスに何らかの方法で転送してください。
+
+# 2台目以降の設定方法
+２台目の端末にSelf-hosted LiveSyncをインストールしたあと、コマンドパレットから`Open setup URI`を選択し、転送したsetup URIを入力します。その後、パスフレーズを入力するとセットアップ用のウィザードが開きます。  
+下記のように答えてください。
+
+- `Importing LiveSync's conf, OK?` に `Yes`
+- `Keep local DB?` に `No`
+- `Keep remote DB?`  に `Yes`
+- `Rebuild the database?` に `No`
+- `Replicate once?` に `Yes`
+
+これで設定が反映され、レプリケーションが開始されます。