Documentated, added feature.

- Toggle All Sync (command) for suspend all sync.
- Batch database update (beta)

docs/settings.md

@@ -0,0 +1,208 @@
+# Settings of this plugin
+
+## Remote Database Configurations
+Configure settings of synchronize server. If any synchronization is enabled, you can't edit this section. Please disable all synchronization to change.
+
+### URI
+URI of CouchDB. In the case of Cloudant, It's "External Endpoint(preferred)".  
+**Do not end it up with a slash** when it doesn't contain the database name.
+
+### Username
+Your CouchDB's Username. With administrator's privilege is preferred.
+
+### Password
+Your CouchDB's Password.  
+Note: This password is saved into your Obsidian's vault in plain text.
+
+### Database Name
+The Database name to synchronize.  
+⚠️If not exist, created automatically.
+
+### Test Database connection
+
+## Local Database Configurations
+"Local Database" is created inside your obsidian.
+
+### Batch database update (beta)
+Delay database update until raise replication, open another file, window visibility changed, or file events except for file modification.  
+This option can not be used with LiveSync at the same time.
+
+### Auto Garbage Collection delay
+When the note has been modified, Self-hosted LiveSync splits the note into some chunks by parsing the markdown structure. And saving only file information and modified chunks into the Local Database. At this time, do not delete old chunks.
+So, Self-hosted LiveSync has to delete old chunks somewhen.
+
+However, the chunk is represented as the crc32 of their contents and shared between all notes. In this way, Self-hosted LiveSync dedupes the entries and keeps low bandwidth and low transfer amounts.
+
+In addition to this, when we edit notes, sometimes back to the previous expression. So It cannot be said that it will be unnecessary immediately.
+
+Therefore, the plugin deletes unused chunks at once when you leave Obsidian for a while (after this setting seconds).
+
+This process is called "Garbage Collection"
+
+As a result, Obsidian's behavior is temporarily slowed down.
+
+Default is 300 seconds.
+If you are an early adopter, maybe this value is left as 30 seconds. Please change this value to larger values.
+
+### Manual Garbage Collect
+Run "Garbage Collection" manually.
+
+### End to End Encryption (beta)
+Encrypt your database. It affects only the database, your files are left as plain.
+
+The encryption algorithm is AES-GCM.
+
+### Passphrase
+The passphrase to used as the key of encryption. Please use the long text.
+
+### Apply
+To enable End-to-End encryption, there must be no items of the same content encrypted with different passphrases to avoid attackers guessing passphrases. Self-hosted LiveSync uses crc32 of the chunks, It is really a must.
+
+So, this plugin completely deletes everything from both local and remote databases before enabling it and then synchronizing again.
+
+To enable, "Apply and send" from the most powerful device, and "Apply and receive" from every other device.
+
+- Apply and send
+1. Initialize the Local Database and set (or clear) passphrase, put all files into the database again.
+2. Initialize the Remote Database.
+3. Lock the Remote Database.
+4. Send it all.
+
+This process is simply heavy. Using a PC or Mac is preferred.
+- Apply and receive
+1. Initialize the Local Database and set (or clear) the passphrase.
+2. Unlock the Remote Database.
+3. Retrieve all and decrypt to file.
+
+When running these operations, every synchronization settings is disabled.
+
+**And even your passphrase is wrong, It doesn't be checked before the plugin really decrypts. So If you set the wrong passphrase and run "Apply and Receive", you will get an amount of decryption error. But, this is the specification.**
+
+## General Settings
+
+### Do not show low-priority log
+If you enable this option, log only the entries with the popup.
+
+### Verbose log
+
+## Sync setting
+
+### LiveSync
+Do LiveSync.
+
+It is the one of raison d'être of this plugin.
+
+Useful, but this method drains many batteries on the mobile and uses not the ignorable amount of data transfer.
+
+This method is exclusive to other synchronization methods.
+
+### Periodic Sync
+Synchronize periodically. 
+
+### Periodic Sync Interval
+Unit is seconds.
+
+### Sync on Save
+Synchronize when the note has been modified or created.
+
+### Sync on File Open
+Synchronize when the note is opened.
+
+### Sync on Start
+Synchronize when Obsidian started.
+
+### Use Trash for deleted files
+When the file has been deleted on remote devices, deletion will be replicated to the local device and the file will be deleted.
+
+If this option is enabled, move deleted files into the trash instead delete actually.
+
+### Do not delete empty folder
+Self-hosted LiveSync will delete the folder when the folder becomes empty. If this option is enabled, leave it as an empty folder.
+
+### minimum chunk size and LongLine threshold
+The configuration of chunk splitting.
+
+Self-hosted LiveSync splits the note into chunks for efficient synchronization. This chunk should be longer than "Minimum chunk size".
+
+Specifically, the length of the chunk is determined by the following orders.
+
+1. Find the nearest newline character, and if it is farther than LongLineThreshold, this piece becomes an independent chunk.
+
+2. If not, find nearest to these items.
+    1. Newline character
+    2. Empty line (Windows style)
+    3. Empty line (non-Windows style)
+3. Compare the farther in these 3 positions and next "\[newline\]#" position, pick a shorter piece to as chunk.
+
+This rule was made empirically from my dataset. If this rule acts as badly on your data. Please give me the information.
+
+You can dump saved note structure to `Dump informations of this doc`. Replace every character to x except newline and "#" when sending information to me.
+
+Default values are 20 letters and 250 letters.
+
+## Hatch
+From here, everything is under the hood. Please handle it with care.
+
+When there are problems with synchronization, the warning message is shown Under this section header.
+
+- Pattern 1  
+![CorruptedData](../images/lock_pattern1.png)  
+This message is shown when the remote database is locked and your device is not marked as "resolved".  
+Almost it is happened by enabling End-to-End encryption or History has been dropped.  
+If you enabled End-to-End encryption, you can unlock the remote database by "Apply and receive" automatically. Or "Drop and receive" when you dropped. If you want to unlock manually, click "mark this device as resolved".
+
+- Pattern 2  
+![CorruptedData](../images/lock_pattern2.png)  
+The remote database indicates that has been unlocked Pattern 1.  
+When you mark all devices as resolved, you can unlock the database.
+But, there's no problem even if you leave it as it is.
+
+### Drop history
+Drop all histories on the local database and the remote database, and initialize When synchronization time has been prolonged to the new device or new vault, or database size became to be much larger. Try this.
+
+Note: When CouchDB deletes entries, to merge confliction, there left old entries as deleted data before compaction. After compaction has been run, deleted data are become "tombstone". "tombstone" uses less disk, But still use some. 
+
+It's the specification, to shrink database size from the root, re-initialization is required, even it's explicit or implicit.
+
+Same as a setting passphrase, database locking is also performed.
+
+
+- Drop and send (Same as "Apply and send")
+1. Initialize the Local Database and set (or clear) passphrase, put all files into the database again.
+2. Initialize the Remote Database.
+3. Lock the Remote Database.
+4. Send it all. 
+
+- Drop and receive (Same as "Apply and receive")
+1. Initialize the Local Database and set (or clear) the passphrase.
+2. Unlock the Remote Database.
+3. Retrieve all and decrypt to file.
+
+
+### Lock remote database
+Lock the remote database to ban out other devices for synchronization. It is the same as the database lock that happened in dropping databases or applying passphrases.
+
+Use it as an emergency evacuation method to protect local or remote databases when synchronization has been broken.
+
+### Suspend file watching
+If enable this option, Self-hosted LiveSync dismisses every file change or deletes the event.
+
+From here, these commands are used inside applying encryption passphrases or dropping histories.
+
+Usually, doesn't use it so much. But sometimes it could be handy.
+
+### Reset remote database
+Discard the data stored in the remote database.
+
+### Reset local database
+Discard the data stored in the local database.
+
+### Initialize local database again
+Discard the data stored in the local database and initialize and create the database from the files on storage.
+
+### Corrupted data
+![CorruptedData](../images/corrupted_data.png)
+
+When Self-hosted LiveSync could not write to the file on the storage, the files are shown here. If you have the old data in your vault, change it once, it will be cured. Or you can use the "File History" plugin.
+
+But if you don't, sorry, we can't rescue the file, and error messages are shown frequently, and you have to delete the file from here.

docs/settings_ja.md

@@ -0,0 +1,201 @@
+# このプラグインの設定項目
+
+## Remote Database Configurations
+同期先のデータベース設定を行います。何らかの同期が有効になっている場合は編集できないため、同期を解除してから行ってください。
+
+### URI
+CouchDBのURIを入力します。Cloudantの場合は「External Endpoint(preferred)」になります。  
+**スラッシュで終わってはいけません。**  
+こちらにデータベース名を含めてもかまいません。
+
+### Username 
+ユーザー名を入力します。このユーザーは管理者権限があることが望ましいです。
+
+### Password
+パスワードを入力します。
+
+### Database Name
+同期するデータベース名を入力します。  
+⚠️存在しない場合は、テストや接続を行った際、自動的に作成されます[^1]。
+[^1]:権限がない場合は自動作成には失敗します。 
+
+### Test Database connection
+上記の設定でデータベースに接続できるか確認します。
+
+## Local Database Configurations
+端末内に作成されるデータベースの設定です。
+
+### Batch database update (beta)
+データベースの更新を以下の事象が発生するまで遅延させます。
+- レプリケーションが発生する
+- 他のファイルを開く
+- ウィンドウの表示状態を変更する
+- ファイルの修正以外のファイル関連イベント
+このオプションはLiveSyncと同時には使用できません。
+
+### Auto Garbage Collection delay
+Self-hosted LiveSyncはノートの変更時、ノートをmarkdownの構造を鑑みてチャンクに分割し、ファイルの情報と更新があったチャンクのみ保存していきます。この際、古いチャンクの削除は行いません。  
+そのため、使わなくなったチャンクをどこかのタイミングで消去する必要があります。  
+ただし、このチャンクはチャンクの内容から作成されるため、同一の内容からは同一のチャンクが作成され、同じノートだけではなく、すべてのノートから共有されます。これによってデータベースの使用容量とデバイス‐サーバー間での転送量を削減しています。  
+執筆を繰り返す上で、元の文書に戻したりすることもあるため、一概に「すぐに不要になる」とは言い切れません。そこで、プラグインはObsidianを開いたまま操作しなくなってからこの設定値秒後、まとめて使用していないチャンクを削除します。  
+この処理をGarbage Collectionと呼んでいます。  
+この作業はすべてのファイル変更の反映を停止して一気に行う必要があります。そのため、一時的にObsidianの動作がかなり重くなります。
+
+
+Obsidianでのファイル操作が終わってから指定秒数が経過した際に実行されます。  
+デフォルト値は300秒です。  
+※ごく初期は30秒でした。初期から使用されている方は、是非300秒ぐらいまで伸ばしてください。ストレスが違います。
+
+### Manual Garbage Collect
+上記のGarbage Collectionを手動で行います。
+
+### End to End Encryption (beta)
+データベースを暗号化します。この効果はデータベースに格納されるデータに限られ、ディスク上のファイルは平文のままです。  
+暗号化はAES-GCMを使用して行っています。
+
+### Passphrase
+暗号化を行う際に使用するパスフレーズです。充分に長いものを使用してください。
+
+### Apply
+End to End 暗号化を行うに当たって、異なるパスフレーズで暗号化された同一の内容を入手されることは避けるべきです。また、Self-hosted LiveSyncはコンテンツのcrc32を重複回避に使用しているため、その点でも攻撃が有効になってしまいます。
+
+そのため、End to End 暗号化を有効にする際には、ローカル、リモートすべてのデータベースをいったん破棄し、新しいパスフレーズで暗号化された内容のみを、改めて同期し直します。
+
+有効化するには、一番体力のある端末からApply and sendを行い、他の端末でApply and receiveを行います。
+
+- Apply and send   
+1. ローカルのデータベースを初期化しパスフレーズを設定（またはクリア）します。その後、すべてのファイルをもう一度データベースに登録します。
+2. リモートのデータベースを初期化します。
+3. リモートのデータベースをロックし、他の端末を締め出します。
+4. すべて再送信します。
+
+負荷と時間がかかるため、デスクトップから行う方が好ましいです。
+- Apply and receive
+1. ローカルのデータベースを初期化し、パスフレーズを設定（またはクリア）します。
+2. リモートのデータベースにかかっているロックを解除します。
+3. すべて受信して、復号します。
+
+どちらのオペレーションも、実行するとすべての同期設定が無効化されます。  
+**また、パスフレーズのチェックは、実際に復号するまで行いません。そのため、パスフレーズを間違えて設定し、Apply and receiveで同期を行うと、大量のエラーが発生します。これは仕様です。**
+
+## General Settings
+一般的な設定です。
+
+### Do not show low-priority log
+有効にした場合、優先度の低いログを記録しません。通知を伴うログのみ表示されます。
+
+### Vervose log
+詳細なログをログに出力します。
+
+## Sync setting
+同期に関する設定です。
+
+### LiveSync
+LiveSyncを行います。
+他の同期方法では、同期の順序が「バージョン確認を行い、ロックが行われていないか確認した後、リモートの変更を受信した後、デバイスの変更を送信する」という挙動になります。
+
+### Periodic Sync
+定期的に同期を行います。
+
+### Periodic Sync Interval
+定期的に同期を行う場合の間隔です。
+
+### Sync on Save
+ファイルが保存されたときに同期を行います。  
+**Obsidianは、ノートを編集している間、定期的に保存を行います。添付ファイルを新しく追加した場合も同様に処理されます。**
+
+### Sync on File Open
+ファイルを開いた際に同期を行います。
+
+### Sync on Start
+Obsidianの起動時に同期を行います。
+
+備考:
+LiveSyncをONにするか、もしくはPeriodic Sync + Sync On File Openがオススメです。
+
+### Use Trash for deleted files
+リモートでファイルが削除された際、デバイスにもその削除が反映されます。  
+このオプションが有効になっている場合、実際に削除する代わりに、ゴミ箱に移動します。
+
+### Do not delete empty folder
+Self-hosted LiveSyncは通常、フォルダ内のファイルがすべて削除された場合、フォルダを削除します。  
+備考:Self-hosted LiveSyncの同期対象はファイルです。
+
+### minimum chunk size と LongLine threshold
+チャンクの分割についての設定です。  
+Self-hosted LiveSyncは一つのチャンクのサイズを最低minimum chunk size文字確保した上で、できるだけ効率的に同期できるよう、ノートを分割してチャンクを作成します。  
+これは、同期を行う際に、一定の文字数で分割した場合、先頭の方を編集すると、その後の分割位置がすべてずれ、結果としてほぼまるごとのファイルのファイル送受信を行うことになっていた問題を避けるために実装されました。  
+具体的には、先頭から順に直近の下記の箇所を検索し、一番長く切れたものを一つのチャンクとします。
+
+1. 次の改行を探し、それがLongLine Thresholdより先であれば、一つのチャンクとして確定します。
+
+2. そうではない場合は、下記を順に探します。
+	1. 改行
+	2. windowsでの空行がある所
+	3. 非Windowsでの空行がある所
+3. この三つのうち一番遠い場所と、 「改行後、#から始まる所」を比べ、短い方をチャンクとします。
+
+このルールは経験則的に作りました。実データが偏っているため。もし思わぬ挙動をしている場合は、是非コマンドから`Dump informations of this doc`を選択し、情報をください。  
+改行文字と#を除き、すべて●に置換しても、アルゴリズムは有効に働きます。  
+デフォルトは20文字と、250文字です。
+
+## Hatch
+ここから先は、困ったときに開ける蓋の中身です。注意して使用してください。
+
+同期の状態に問題がある場合、Hatchの直下に警告が表示されることがあります。
+
+- パターン１  
+![CorruptedData](../images/lock_pattern1.png)  
+データベースがロックされていて、端末が「解決済み」とマークされていない場合、警告が表示されます。  
+他のデバイスで、End to End暗号化を有効にしたか、Drop Historyを行った等、他の端末がそのまま同期を行ってはいない状態に陥った場合表示されます。  
+暗号化を有効化した場合は、パスフレーズを設定してApply and recieve、Drop Historyを行った場合は、Drop and recieveを行うと自動的に解除されます。  
+手動でこのロックを解除する場合は「mark this device as resolved」をクリックしてください。
+
+- パターン２  
+![CorruptedData](../images/lock_pattern2.png)  
+リモートのデータベースが、過去、パターン１を解除したことがあると表示しています。  
+ご使用のすべてのデバイスでロックを解除した場合は、データベースのロックを解除することができます。  
+ただし、このまま放置しても問題はありません。
+
+### Drop history
+データベースに記録されている履歴を削除し、データベースを初期化します。  
+新しい端末や新しいVaultへの同期にやたらと時間がかかったり、データベースサイズが肥大化したりしてきた際に使用してください。  
+備考:CouchDBは、データを削除する際、衝突の解決のために、削除した痕跡を保存します。そのため、Garbage Collectしていたとしても、データは必ず増え続けます。  
+パスフレーズ設定と同様に、完全に同期されているのであれば、データを失う可能性は低いです。  
+また、同様にデータベースのロック等の処理も行われます。
+
+- Drop and send
+デバイスとリモートのデータベースを破棄し、ロックしてからデバイスのファイルでデータベースを構築後、リモートに上書きします。
+- Drop and receive
+デバイスのデータベースを破棄した後、リモートから、操作しているデバイスに関してロックを解除し、データを受信して再構築します。
+
+### Lock remote database
+リモートのデータベースをロックし、他の端末で同期を行おうとしてもエラーとともに同期がキャンセルされるように設定します。これは、データベースの再構築を行った場合、自動的に設定されるものと同じものです。
+
+万が一同期に不具合が発生していて、使用しているデバイスのデータ＋サーバーのデータを保護する場合などに、緊急避難的に使用してください。
+
+### Suspend file watching
+ファイルの更新の監視を止めます。
+
+
+これ以降の操作は、暗号化設定のApplyや、Drop Historyで行われる処理を手動で行うためのオプションです。
+
+あまり使用することはありませんがいざというときに使用します。
+
+### reset remote database
+リモートのデータベースを破棄します。
+
+### reset local database
+ローカルのデータベースを破棄します。
+
+### initialize local database again
+デバイスのデータベースを破棄し、実ファイルから再度データベースを構築します。
+
+### Corrupted data
+![CorruptedData](../images/corrupted_data.png)
+
+データベースからストレージに書き出せなかったファイルがここに表示されます。  
+もし、Obsidian内にそのデータが存在する場合は、一度編集を行い、上書きを行うと保存に成功する場合があります。（File Historyプラグインで救っても大丈夫です）  
+それ以外の場合は、残念ながら復旧手段がないため、データベース上の破損したファイルを削除しない限り、エラーが表示されます。  
+その「データベース上の破損したファイルを削除」するボタンです。
+

docs/setup_cloudant.md

@@ -0,0 +1,85 @@
+# Cloudant Setup
+
+## Creating an Instance
+
+In these instructions, create IBM Cloudant Instance for trial.
+
+1. Hit the "Create Resource" button.  
+   ![step 1](../instruction_images/cloudant_1.png)
+
+1. In IBM Cloud Catalog, search "Cloudant".  
+   ![step 2](../instruction_images/cloudant_2.png)
+
+1. You can choose "Lite plan" for free.  
+   ![step 3](../instruction_images/cloudant_3.png)
+
+1. Select Multitenant(it's the default) and the region as you like.  
+   ![step 4](../instruction_images/cloudant_4.png)
+
+1. Be sure to select "IAM and Legacy credentials" for "Authentication Method".  
+   ![step 5](../instruction_images/cloudant_5.png)
+
+1. Select Lite and be sure to check the capacity.  
+   ![step 6](../instruction_images/cloudant_6.png)
+
+1. And hit "Create" on the right panel.  
+   ![step 7](../instruction_images/cloudant_7.png)
+
+1. When all of the above steps have been done, open "Resource list" on the left pane. you can see the Cloudant instance in the "Service and software". Click it.  
+   ![step 8](../instruction_images/cloudant_8.png)
+
+1. In resource details, there's information to connect from Self-hosted LiveSync.  
+   Copy the "External Endpoint(preferred)" address. <sup>(\*1)</sup>. We use this address later, with the database name.  
+   ![step 9](../instruction_images/cloudant_9.png)
+
+## Database setup
+
+1.  Hit the "Launch Dashboard" button, Cloudant dashboard will be shown.  
+    Yes, it's almost CouchDB's fauxton.  
+    ![step 1](../instruction_images/couchdb_1.png)
+
+1.  First, you have to enable the CORS option.  
+    Hit the Account menu and open the "CORS" tab.  
+    Initially, "Origin Domains" is set to "Restrict to specific domains"., so set to "All domains(\*)"  
+    _NOTE: of course We want to set "app://obsidian.md" but it's not acceptable on Cloudant._
+    ![step 2](../instruction_images/couchdb_2.png)
+
+1.  Next, Open the "Databases" tab and hit the "Create Database" button.  
+    Enter the name as you like <sup>(\*2)</sup> and Hit the "Create" button below.  
+    ![step 3](../instruction_images/couchdb_3.png)
+
+1.  If the database was shown with joyful messages, the setup is almost done.  
+    And, once you have confirmed that you can create a database, usually there is no need to open this screen.  
+    You can create a database from Self-hosted LiveSync.
+    ![step 4](../instruction_images/couchdb_4.png)
+
+### Credentials Setup
+
+1.  Back into IBM Cloud, Open the "Service credentials". You'll get an empty list, hit the "New credential" button.  
+    ![step 1](../instruction_images/credentials_1.png)
+
+1.  The dialog to create a credential will be shown.  
+    type any name or leave it default, hit the "Add" button.  
+    ![step 2](../instruction_images/credentials_2.png)  
+    _NOTE: This "name" is not related to your username that uses in Self-hosted LiveSync._
+
+1.  Back to "Service credentials", the new credential should be created.  
+    open details.  
+    ![step 3](../instruction_images/credentials_3.png)  
+    The username and password pair is inside this JSON.  
+    "username" and "password" are so.  
+    follow the figure, it's  
+    "apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5"<sup>(\*3)</sup> and "c2c11651d75497fa3d3c486e4c8bdf27"<sup>(\*4)</sup>
+
+## Self-hosted LiveSync setting
+
+![Setting](../images/remote_db_setting.png)
+
+The Setting should be as below:
+
+| Items         | Value | example                                                           |
+| ------------- | ----- | ----------------------------------------------------------------- |
+| URI           | (\*1) | https://xxxxxxxxxxxxxxxxx-bluemix.cloudantnosqldb.appdomain.cloud |
+| Username      | (\*3) | apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5            |
+| Password      | (\*4) | c2c11651d75497fa3d3c486e4c8bdf27                                  |
+| Database name | (\*2) | sync-test                                                         |

docs/setup_cloudant_ja.md

@@ -0,0 +1,79 @@
+# IBM Cloudantのセットアップ
+
+## インスタンスの作成
+下記の手順で、試用のためにIBM Cloudantのインスタンスを作成できます。
+
+
+1. 「リソースの作成」ボタンをクリックします。  
+   ![step 1](../instruction_images/cloudant_1.png)
+
+1. カタログが開くので、「Cloudant」と検索してください。出てきた選択肢をクリックすると作成画面に進みます。  
+   ![step 2](../instruction_images/cloudant_2.png)
+
+1. Liteプランを選択してください。  
+   ![step 3](../instruction_images/cloudant_3.png)
+
+1. リージョンと環境を選択します。LiteではMultitenantしか選択できないので、Multitenantを選択してください。デフォルトで選択されています。  
+リージョンはお好みの場所で作成してください。
+![step 4](../instruction_images/cloudant_4.png) 
+
+3. "Authentication Method"で「IAM and legacy credentials」を選択します。  
+![step 5](../instruction_images/cloudant_5.png)
+
+4. Liteプランが選択されていることと、Capacityを確認します。  
+   ![step 6](../instruction_images/cloudant_6.png)
+
+5. 確認ができたら、右側のCreateボタンをクリックします。  
+   ![step 7](../instruction_images/cloudant_7.png)
+
+6. 上記の手順が正常に完了したら、左のメニューから「リソース・リスト」をクリックしてください。リソース・リストが表示され、「サービス及びソフトウエア」に作成したCloudantのインスタンスが表示されます。  
+インスタンス名をクリックしてください。  
+   ![step 8](../instruction_images/cloudant_8.png)
+
+7. ここで、"External Endpoint (preferred)" と記載されているアドレスを控えてください。後ほど使います。<sup>(\*1)</sup>  
+![step 9](../instruction_images/cloudant_9.png)
+
+## データベースの設定
+
+1. 「Launch Dashboard」ボタンをクリックします。そうすると、今度はデータベースのダッシュボードが表示されます。CouchDBには、Fauxtonというインターフェイスがあるのですが、それそのものです。  
+    ![step 1](../instruction_images/couchdb_1.png)
+
+1.  CORSの許可設定を行います。メニューの「Account」をクリックし、「CORS」タブを開きます。  
+最初は「Restrict to specific domains」が選択されているので、「All domains (\*)」を選択し直します。この反映は即座に行われますが、すぐに戻せるので大丈夫です。  
+    ![step 2](../instruction_images/couchdb_2.png)
+
+1. データベースが作成できるか確認します。メニューの「Databases」をクリックし、次に「Create Database」ボタンをクリックします。  
+右側にパネルが表示されますので、好きな名前を入力し、「Create」ボタンをクリックします。  
+    ![step 3](../instruction_images/couchdb_3.png)
+
+1.  それっぽいメッセージが表示された後、データベースが表示されていれば、ほとんどセットアップは完了です。今後、ほとんどこの画面は使いません。Self-hosted LiveSyncからデータベースは作成できます。  
+    ![step 4](../instruction_images/couchdb_4.png)
+
+### 資格情報のセットアップ
+
+1. IBM Cloudに戻って、「サービス資格情報」をクリックしてください。おそらく何も表示されていないので、「新規資格情報」をクリックします。  
+    ![step 1](../instruction_images/credentials_1.png)
+
+1.  資格情報を作成するダイアログが表示されるので、わかりやすい名前を入力します。その後、役割に「管理者」が選択されていることを確認してから、「追加」ボタンをクリックしてください。  
+    ![step 2](../instruction_images/credentials_2.png)  
+    備考: この「名前」はSelf-hosted LiveSyncで使用するUsernameとはまた別のものです。
+
+1. 「サービス資格情報」に戻ると、新しい資格情報が作成されています。~~わかりにくいことに名前は「鍵名」に変わります~~。左側のボタンを押すと詳細が開きます。  
+    ![step 3](../instruction_images/credentials_3.png)  
+    Self-hosted LiveSyncから使用するUsernameとPasswordは、表示されたJSONに記載されているものを使用します。  
+	今回の図で言うと、Usernameは"apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5"<sup>(\*3)</sup>、パスワードは"c2c11651d75497fa3d3c486e4c8bdf27"<sup>(\*4)</sup>になります。
+
+## Self-hosted LiveSyncに設定
+
+![Setting](../images/remote_db_setting.png)
+
+先ほどの設定例から引用すると、
+
+| Items               | Value                            | example                                                                     |
+| ------------------- | -------------------------------- | --------------------------------------------------------------------------- |
+| URI | (\*1) | https://xxxxxxxxxxxxxxxxx-bluemix.cloudantnosqldb.appdomain.cloud |
+| Username    | (\*3)                            | apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5                      |
+| Password    | (\*4)                            | c2c11651d75497fa3d3c486e4c8bdf27                                            |
+| Database name    | (\*2)                            | sync-test                                            |
+
+となります。

docs/setup_own_server.md

@@ -0,0 +1,3 @@
+# Setup CouchDB to your server
+
+Coming soon!

docs/setup_own_server_ja.md

@@ -0,0 +1,3 @@
+# CouchDB のセットアップ方法
+
+早めに作成します！

docs/tech_info.md

@@ -0,0 +1,16 @@
+# Designed architecture
+
+## How does this plugin synchronize.
+
+![Synchronization](../images/1.png)
+
+1. When notes are created or modified, Obsidian raises some events. Self-hosted LiveSync catches these events and reflects changes into Local PouchDB.
+2. PouchDB automatically or manually replicates changes to remote CouchDB.
+3. Another device is watching remote CouchDB's changes, so retrieve new changes.
+4. Self-hosted LiveSync reflects replicated changeset into Obsidian's vault.
+
+Note: The figure is drawn as single-directional, between two devices. But everything occurs bi-directionally between many devices at once in real.
+
+## Techniques to keep bandwidth low.
+
+![dedupe](../images/2.png)

docs/tech_info_ja.md

@@ -0,0 +1,16 @@
+# アーキテクチャ設計
+
+## 同期
+
+![Synchronization](../images/1.png)
+
+1. ノートが更新された際、Obsidianがイベントを発報します。Obsidian-LiveSyncはそれをハンドリングして、ローカルのPouchDBに変更を反映します。
+2. PouchDBは、リモートのCouchDBに差分をレプリケーションします。
+3. 他のデバイスは、リモートのCouchDBを監視しているので、変更が検出された場合はそのまま差分がダウンロードされます。
+4. Self-hosted LiveSyncはPouchDBに転送された変更を、ObsidianのVaultに反映していきます。
+
+図は2端末での単一方向として描きましたが、実際には双方向に、複数の端末間で実行されます。
+
+## 帯域幅低減のために
+
+![dedupe](../images/2.png)