update docs

This commit is contained in:
vorotamoroz
2026-06-05 03:05:13 +09:00
parent 1b44ab9f2b
commit 31050c9cb8
11 changed files with 343 additions and 40 deletions
+68 -9
View File
@@ -247,7 +247,8 @@ TURNサーバーでの認証に使用するパスワード(クレデンシャ
このオプションはLiveSyncと同時には使用できません。
### minimum chunk size と LongLine threshold
チャンクの分割についての設定です。
チャンクの分割についての設定です。※現在これらの項目はUIから直接設定することはできません(デフォルト値で自動処理されます)。
Self-hosted LiveSyncは一つのチャンクのサイズを最低minimum chunk size文字確保した上で、できるだけ効率的に同期できるよう、ノートを分割してチャンクを作成します。
これは、同期を行う際に、一定の文字数で分割した場合、先頭の方を編集すると、その後の分割位置がすべてずれ、結果としてほぼまるごとのファイルのファイル送受信を行うことになっていた問題を避けるために実装されました。
具体的には、先頭から順に直近の下記の箇所を検索し、一番長く切れたものを一つのチャンクとします。
@@ -291,15 +292,17 @@ Self-hosted LiveSyncは一つのチャンクのサイズを最低minimum chunk s
## Sync setting
同期に関する設定です。
### LiveSync
LiveSyncを行います。
他の同期方法では、同期の順序が「バージョン確認を行い、ロックが行われていないか確認した後、リモートの変更を受信した後、デバイスの変更を送信する」という挙動になります。
### 同期モード (Sync Mode)
設定キー: syncMode
### Periodic Sync
定期的に同期を行います。
同期処理を実行するトリガーとなる条件を設定します。
- **LiveSync** (`LIVESYNC`): リアルタイムかつ継続的な双方向同期を行います。
注意: このモードには CouchDB または WebRTC P2P リモートサーバーが必要です。S3互換オブジェクトストレージではサポートされていません。
- **Periodic Sync** (`PERIODIC`): **Periodic Sync Interval** で指定した一定の間隔ごとに同期処理を実行します。
- **On Events** (`ONEVENTS`): ファイルの保存、ファイルを開く、起動時など、特定のイベントが発生した際に同期をトリガーします(詳細は下部の設定スイッチで制御します)。
### Periodic Sync Interval
定期的に同期を行う場合の間隔です。
定期的に同期を行う場合の間隔(秒単位)です。
### 同期の最小間隔
設定キー: syncMinimumInterval
@@ -382,6 +385,40 @@ Self-hosted LiveSyncはPouchDBを使用し、リモートと[このプロトコ
メガバイト(MB)単位で指定します。
## Customisation Sync (カスタマイズ同期)
プラグイン、ホットキー、テーマ、スニペットなどのObsidianのカスタマイズ設定を同期する機能です(以前は **Plugin Sync** と呼ばれていました)。
### デバイス名 (Device name)
設定キー: deviceAndVaultName
同期するすべてのデバイス間で一意となるデバイス名です。この設定を編集するには、一度カスタマイズ同期を無効にする必要があります。
### ファイル保存ごとのカスタマイズ同期 (Per-file-saved customisation sync)
設定キー: usePluginSyncV2
有効な場合、ファイルごとの効率的なカスタマイズ同期が使用されます。有効にする際には簡単な移行作業が必要であり、すべてのデバイスを v0.23.18 以降にアップデートする必要があります。この機能を有効にすると、古いバージョンとの互換性が失われます。
### カスタマイズ同期を有効にする (Enable customisation sync)
設定キー: usePluginSync
テーマ、スニペット、ホットキー、プラグイン設定などの同期を有効にします。
注意: 安全上の理由から、この機能を使用するにはエンドツーエンド暗号化(End-to-End Encryption)が有効になっている必要があります。
### カスタマイズの自動スキャン (Scan customisation automatically)
設定キー: autoSweepPlugins
レプリケーション(同期処理)を実行する前に、カスタマイズ設定の変更をスキャンします。
### 定期的なカスタマイズのスキャン (Scan customisation periodically)
設定キー: autoSweepPluginsPeriodic
1分ごとにカスタマイズ設定の変更を定期的にスキャンします。
### カスタマイズ更新の通知 (Notify customised)
設定キー: notifyPluginOrSettingUpdated
他のデバイスで新しくカスタマイズ設定が更新されたときに通知を表示します。
## Miscellaneous
その他の設定です
### Show status inside editor
@@ -423,8 +460,30 @@ Vault内のファイルを全て読み込み直し、もし差分があったり
万が一同期に不具合が発生していて、使用しているデバイスのデータ+サーバーのデータを保護する場合などに、緊急避難的に使用してください。
### Suspend file watching
ファイルの更新の監視を止めます。
### Scram スイッチ (Scram Switches)
データベースの破損や予期しないデータ喪失を防ぐために、同期処理を緊急停止するためのスイッチです。重大な設定不一致や同期エラーが発生した場合、プラグインは自動的に Scram 状態に移行し、同期動作を一時停止することがあります。
#### ファイルの更新監視を一時停止 (Suspend file watching)
設定キー: suspendFileWatching
ローカルファイル変更の監視と検知を停止します。
#### データベース反映を一時停止 (Suspend database reflecting)
設定キー: suspendParseReplicationResult
データベースでの変更をストレージファイル(Vault内のファイル)へ書き戻す処理を停止します。
### 互換性(メタデータ)(Compatibility (Metadata))
#### 削除済みファイルのメタデータを保持しない (Do not keep metadata of deleted files.)
設定キー: deleteMetadataOfDeletedFiles
ファイルを削除した際に、そのファイルの同期履歴メタデータも即座にデータベースから削除し、保持しないようにします。
#### 削除済みデータのメタデータをクリーンナップする (Delete old metadata of deleted files on start-up)
設定キー: automaticallyDeleteMetadataOfDeletedFiles
ファイルを削除した際のメタデータを保持する期間(日数)を設定します。指定した日数を経過した古い削除済みファイルのメタデータは、プラグイン起動時にデータベースから自動的に削除(クリーンナップ)されます。`0` を指定すると自動削除は無効になります。
### 破損している可能性があるファイルも処理する
設定キー: processSizeMismatchedFiles