diff --git a/docs/p2p_sync_updates_2026.md b/docs/p2p_sync_updates_2026.md index b6f3903..9507360 100644 --- a/docs/p2p_sync_updates_2026.md +++ b/docs/p2p_sync_updates_2026.md @@ -53,7 +53,7 @@ This command synchronises with every peer whose **SYNC** toggle is enabled in th *Tip: Pair this command with a hotkey for a quick, keyboard-driven sync workflow.* ## 6. Technical Improvements in 2026 -- **Decoupled Architecture:** The UI is now strictly separated from the core logic, making the plugin more stable across different platforms (Mobile, Desktop, and Web). +- **Decoupled Architecture:** The UI is now strictly separated from the core logic, making the plug-in more stable across different platforms (Mobile, Desktop, and Web). - **Svelte 5 UI:** The interface has been rebuilt for better responsiveness and clearer status indicators. - **Security:** All data remains end-to-end encrypted. Even the signalling relay never sees your actual notes. diff --git a/docs/quick_setup.md b/docs/quick_setup.md index c6e1aef..7139b53 100644 --- a/docs/quick_setup.md +++ b/docs/quick_setup.md @@ -2,7 +2,7 @@ [Japanese docs](./quick_setup_ja.md) - [Chinese docs](./quick_setup_cn.md). -The plugin has so many configuration options to deal with different circumstances. However, only a few settings are required in the normal cases. Therefore, `The Setup wizard` has been implemented to simplify the setup. +The plug-in has so many configuration options to deal with different circumstances. However, only a few settings are required in the normal cases. Therefore, `The Setup wizard` has been implemented to simplify the setup. ![](../images/quick_setup_1.png) @@ -10,7 +10,7 @@ There are three methods to set up Self-hosted LiveSync. 1. [Using setup URIs](#1-using-setup-uris) *(Recommended)* 2. [Minimal setup](#2-minimal-setup) -3. [Full manually setup the and Enable on this dialogue](#3-manually-setup) +3. [Fully manual setup and enabling on this dialogue](#3-manually-setup) ## At the first device @@ -24,7 +24,7 @@ There are three methods to set up Self-hosted LiveSync. In this procedure, [this video](https://youtu.be/7sa_I1832Xc?t=146) may help us. -1. Click `Use` button (Or launch `Use the copied setup URI` from Command palette). +1. Click the `Use` button (or launch the `Use the copied setup URI (Formerly Open setup URI)` command from the command palette). 2. Paste the Setup URI into the dialogue 3. Type the passphrase of the Setup URI 4. Answer `yes` for `Importing LiveSync's conf, OK?`. @@ -107,21 +107,21 @@ Note: If you are going to use Object Storage, you cannot select `LiveSync`. Select any synchronisation methods we want to use and `Apply`. If database initialisation is required, it will be performed at this time. When `All done!` is displayed, we are ready to synchronise. -The dialogue of `Copy settings as a new setup URI` will be open automatically. Please input a passphrase to encrypt the new `Setup URI`. (This passphrase is to encrypt the setup URI, not the vault). +The dialogue of `Copy current settings as a new setup URI` will open automatically. Please input a passphrase to encrypt the new `Setup URI`. (This passphrase is to encrypt the setup URI, not the vault). ![](../images/quick_setup_10.png) The Setup URI will be copied to the clipboard, please make a note(Not in Obsidian) of this. >[!TIP] -We can copy this in any time by `Copy current settings as a new setup URI`. +We can copy this at any time by running the "Copy settings as a new setup URI" command from the command palette (or clicking the "Copy the current settings to a Setup URI" button in the settings UI). ### 3. Manually setup It is strongly recommended to perform a "minimal set-up" first and set up the other contents after making sure has been synchronised. However, if you have some specific reasons to configure it manually, please click the `Enable` button of `Enable LiveSync on this device as the set-up was completed manually`. -And, please copy the setup URI by `Copy current settings as a new setup URI` and make a note(Not in Obsidian) of this. +And, please copy the setup URI by running the "Copy settings as a new setup URI" command (or using the "Copy the current settings to a Setup URI" button) and make a note(Not in Obsidian) of this. ## At the subsequent device After installing Self-hosted LiveSync on the first device, we should have a setup URI. **The first choice is to use it**. Please share it with the device you want to setup. diff --git a/docs/quick_setup_ja.md b/docs/quick_setup_ja.md index 8af0779..8bd2932 100644 --- a/docs/quick_setup_ja.md +++ b/docs/quick_setup_ja.md @@ -1,6 +1,6 @@ # Quick setup このプラグインには、いろいろな状況に対応するための非常に多くの設定オプションがあります。しかし、実際に使用する設定項目はそれほど多くはありません。そこで、初期設定を簡略化するために、「セットアップウィザード」を実装しています。 -※なお、次のデバイスからは、`Copy setup URI`と`Open setup URI`を使ってセットアップしてください。 +※なお、次のデバイスからは、`現在の設定をセットアップURIにコピー`と`セットアップURIで接続`を使ってセットアップしてください。 ## Wizardの使い方 @@ -71,7 +71,8 @@ Fixボタンがなくなり、すべてチェックマークになれば完了 ![](../images/quick_setup_9_1.png) Presetsから、いずれかの同期方法を選び`Apply`を行うと、必要に応じてローカル・リモートのデータベースを初期化・構築します。 -All done! と表示されれば完了です。自動的に、`Copy setup URI`が開き、`Setup URI`を暗号化するパスフレーズを聞かれます。 +「All done!」（日本語環境では「完了！」）と表示されれば完了です。自動的に、「現在の設定をセットアップURIにコピー」のダイアログが開き、Setup URIを暗号化するためのパスフレーズを求められます（このパスフレーズはSetup URIを暗号化するためのもので、Vault自体の暗号化キーではありません）。 +パスフレーズを入力すると、クリップボードにSetup URIが保存されますので、これを2台目以降のデバイスに何らかの方法で転送してください。 ![](../images/quick_setup_10.png) @@ -79,7 +80,7 @@ All done! と表示されれば完了です。自動的に、`Copy setup URI`が クリップボードにSetup URIが保存されますので、これを2台目以降のデバイスに何らかの方法で転送してください。 # 2台目以降の設定方法 -2台目の端末にSelf-hosted LiveSyncをインストールしたあと、コマンドパレットから`Open setup URI`を選択し、転送したsetup URIを入力します。その後、パスフレーズを入力するとセットアップ用のウィザードが開きます。 +2台目の端末にSelf-hosted LiveSyncをインストールしたあと、コマンドパレットから`Use the copied setup URI (Formerly Open setup URI)`を選択し、転送したsetup URIを入力します。その後、パスフレーズを入力するとセットアップ用のウィザードが開きます。 下記のように答えてください。 - `Importing LiveSync's conf, OK?` に `Yes` diff --git a/docs/settings.md b/docs/settings.md index 29fbcd6..a067df1 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -12,7 +12,7 @@ There are many settings in Self-hosted LiveSync. This document describes each se | 🛰️ | [3. Remote Configuration](#3-remote-configuration) | | 🔄 | [4. Sync Settings](#4-sync-settings) | | 🚦 | [5. Selector (Advanced)](#5-selector-advanced) | -| 🔌 | [6. Customization sync (Advanced)](#6-customization-sync-advanced) | +| 🔌 | [6. Customisation sync (Advanced)](#6-customisation-sync-advanced) | | 🧰 | [7. Hatch](#7-hatch) | | 🔧 | [8. Advanced (Advanced)](#8-advanced-advanced) | | 💪 | [9. Power users (Power User)](#9-power-users-power-user) | @@ -68,7 +68,7 @@ Following panes will be shown when you enable this setting. | Icon | Description | | :--: | ------------------------------------------------------------------ | | 🚦 | [5. Selector (Advanced)](#5-selector-advanced) | -| 🔌 | [6. Customization sync (Advanced)](#6-customization-sync-advanced) | +| 🔌 | [6. Customisation sync (Advanced)](#6-customisation-sync-advanced) | | 🔧 | [8. Advanced (Advanced)](#8-advanced-advanced) | #### Enable poweruser features @@ -120,6 +120,18 @@ Setting key: showStatusOnStatusbar We can show the status of synchronisation on the status bar. (Default: On) +#### Show status icon instead of file warnings banner + +Setting key: hideFileWarningNotice + +If enabled, the ⛔ icon will be shown inside the status instead of the file warnings banner. No details will be shown. + +#### Network warning style + +Setting key: networkWarningStyle + +How to display network errors when the sync server is unreachable. + ### 2. Logging #### Show only notifications @@ -138,11 +150,19 @@ Show verbose log. Please enable when you report the logs ### 1. Remote Server +Self-hosted LiveSync supports multiple remote connection profiles under **Remote Server** -> **Remote Databases**. This allows you to save and switch between multiple databases or bucket configurations in a single vault. + +- **➕ Add new connection**: Create a new connection profile by launching the setup dialogue. +- **📥 Import connection**: Paste a connection string (e.g., `sls+https://...`, `sls+s3://...`, `sls+p2p://...`) to import a remote configuration profile. +- **🔧 Configure**: Open the setup dialogue to edit settings for the selected connection profile. +- **✅ Activate**: Select and activate this profile as the current active remote. +- **🗑️ Delete**: Remove this connection profile from the list. + #### Remote Type Setting key: remoteType -Remote server type +The active remote server type. This is automatically projected to the legacy configuration when you activate a connection profile. ### 2. Notification @@ -172,6 +192,14 @@ Setting key: usePathObfuscation In default, the path of the file is not obfuscated to improve the performance. If you enable this, the path of the file will be obfuscated. This is useful when you want to hide the path of the file. +#### Encryption Algorithm + +Setting key: E2EEAlgorithm + +The encryption algorithm version used for end-to-end encryption. +- `v2` (V2: AES-256-GCM With HKDF): Recommended and default version. +- `forceV1` or `""` (V1: Legacy): Older legacy encryption. Only use this if you have an existing vault encrypted in the legacy format. + #### Use dynamic iteration count (Experimental) Setting key: useDynamicIterationCount @@ -192,30 +220,62 @@ Fetch necessary settings from already configured remote server. ### 5. Minio,S3,R2 +These settings are configured within the S3/MinIO/R2 Setup dialogue when adding (`➕`) or editing (`🔧`) an Object Storage connection profile. + #### Endpoint URL Setting key: endpoint +The URL of the remote storage endpoint. +Note: Only Secure (HTTPS) connections can be used on Obsidian Mobile. + #### Access Key Setting key: accessKey +The Access Key ID used for authentication. + #### Secret Key Setting key: secretKey +The Secret Access Key used for authentication. + #### Region Setting key: region +The storage region (e.g., `us-east-1`, or `auto` for Cloudflare R2). + #### Bucket Name Setting key: bucket +The name of the bucket to store synchronised files. + #### Use Custom HTTP Handler Setting key: useCustomRequestHandler -Enable this if your Object Storage doesn't support CORS + +This option is labeled **Use internal API** in the setup dialogue. Enable this if your Object Storage does not support CORS. It uses Obsidian's internal API to communicate with the S3 server, which is not compliant with web standards but can bypass CORS restrictions. Note that this might break in future Obsidian versions. + +#### File prefix on the bucket + +Setting key: bucketPrefix + +This option is labeled **Folder Prefix** in the setup dialogue. Effectively a directory. Should end with `/`. e.g., `vault-name/`. Leave blank to store data at the root of the bucket. + +#### Enable forcePathStyle + +Setting key: forcePathStyle + +This option is labeled **Use Path-Style Access** in the setup dialogue. If enabled, the forcePathStyle option will be used for bucket operations. + +#### Custom Headers + +Setting key: bucketCustomHeaders + +Custom HTTP headers to include in every request sent to the Object Storage bucket. Specify them in the format `Header-Name: Value`, with each header on a new line. #### Test Connection @@ -223,24 +283,82 @@ Enable this if your Object Storage doesn't support CORS ### 6. CouchDB +These settings are configured within the CouchDB Setup dialogue when adding (`➕`) or editing (`🔧`) a CouchDB connection profile. + #### Server URI Setting key: couchDB_URI +The URI of the CouchDB server. +Note: Only Secure (HTTPS) connections can be used on Obsidian Mobile. The URI must not end with a trailing slash. + #### Username Setting key: couchDB_USER -username + +The username used to authenticate with CouchDB. #### Password Setting key: couchDB_PASSWORD -password + +The password used to authenticate with CouchDB. #### Database Name Setting key: couchDB_DBNAME +The name of the database. +Note: The database name cannot contain capital letters, spaces, or special characters other than `_$()+/-`, and cannot start with an underscore (`_`). + +#### Use Request API to avoid inevitable CORS problem + +Setting key: useRequestAPI + +This option is labeled **Use Internal API** in the setup dialogue. If enabled, Obsidian's internal request API will be used to bypass CORS restrictions. This is a workaround that may not be compliant with web standards and is less secure. Note that this might break in future Obsidian versions. + +#### Custom Headers + +Setting key: couchDB_CustomHeaders + +Custom HTTP headers to include in every request sent to the CouchDB server. Specify them in the format `Header-Name: Value`, with each header on a new line. + +#### Use JWT Authentication + +Setting key: useJWT + +Enable JSON Web Token (JWT) authentication for CouchDB. This is an experimental feature and has not been thoroughly verified. + +#### JWT Algorithm + +Setting key: jwtAlgorithm + +The algorithm used to sign the JWT. Supported algorithms: `HS256`, `HS512`, `ES256`, `ES512`. + +#### JWT Expiration Duration (minutes) + +Setting key: jwtExpDuration + +Token expiration duration in minutes. Set to 0 to disable expiration. + +#### JWT Key + +Setting key: jwtKey + +The secret key (for HS256/HS512) or the PKCS#8 PEM-formatted private key (for ES256/ES512) used to sign the JWT. + +#### JWT Key ID (kid) + +Setting key: jwtKid + +The Key ID (`kid`) header parameter included in the JWT. + +#### JWT Subject (sub) + +Setting key: jwtSub + +The subject (`sub`) claim of the JWT, which should match your CouchDB username. + #### Test Database Connection Open database connection. If the remote database is not found and you have permission to create a database, the database will be created. @@ -251,16 +369,78 @@ Checks and fixes any potential issues with the database config. #### Apply Settings +### 7. Peer-to-Peer (P2P) Synchronisation + +#### Enable P2P Synchronisation + +Setting key: P2P_Enabled + +Enable direct peer-to-peer synchronisation via WebRTC. + +#### Relay URL + +Setting key: P2P_relays + +The WebSocket relay server URL(s) used for coordinating P2P connections via WebRTC. Multiple URLs can be separated by commas. + +#### Group ID + +Setting key: P2P_roomID + +The room ID or Group ID used to identify your group of synchronising devices. All devices you wish to synchronise must use the same Group ID. You can enter any custom string or generate a random Group ID. + +#### Passphrase + +Setting key: P2P_passphrase + +The password or passphrase used to authenticate and encrypt P2P communication. All devices must use the same passphrase. + +#### Device Peer ID + +Setting key: P2P_DevicePeerName + +The peer name or identifier of this device in the P2P network. This should be unique within your group of devices. + +#### Automatically start P2P connection on launch + +Setting key: P2P_AutoStart + +This option is labeled **Auto Start P2P Connection** in the setup dialogue. If enabled, the P2P connection will start automatically when the plug-in launches. + +#### Automatically broadcast changes to connected peers + +Setting key: P2P_AutoBroadcast + +This option is labeled **Auto Broadcast Changes** in the setup dialogue. If enabled, changes will be automatically broadcasted to connected peers, requesting them to fetch the changes. + +#### TURN Server URLs (comma-separated) + +Setting key: P2P_turnServers + +A comma-separated list of TURN/STUN server URLs. Used to relay P2P connections when direct WebRTC connection fails due to strict NAT or firewalls. In most cases, these can be left blank. + +#### TURN Username + +Setting key: P2P_turnUsername + +The username for authentication with the TURN server. + +#### TURN Credential + +Setting key: P2P_turnCredential + +The password or credential for authentication with the TURN server. + ## 4. Sync Settings -### 1. Synchronization Preset +### 1. Synchronisation Preset #### Presets Setting key: preset Apply preset configuration -### 2. Synchronization Method +### 2. Synchronisation Method #### Sync Mode @@ -271,6 +451,12 @@ Setting key: syncMode Setting key: periodicReplicationInterval Interval (sec) +#### Minimum interval for syncing + +Setting key: syncMinimumInterval + +The minimum interval for automatic synchronisation on event. + #### Sync on Save Setting key: syncOnSave @@ -323,7 +509,7 @@ Move remotely deleted files to the trash, instead of deleting. #### Keep empty folder Setting key: doNotDeleteFolder -Should we keep folders that don't have any files inside? +Should we keep folders that do not have any files inside? ### 5. Conflict resolution (Advanced) @@ -360,7 +546,7 @@ Setting key: notifyAllSettingSyncFile ### 7. Hidden Files (Advanced) -#### Hidden file synchronization +#### Hidden file synchronisation #### Enable Hidden files sync @@ -373,6 +559,12 @@ Setting key: syncInternalFilesBeforeReplication Setting key: syncInternalFilesInterval Seconds, 0 to disable +#### Suppress notification of hidden files change + +Setting key: suppressNotifyHiddenFilesChange + +If enabled, the notification of hidden files change will be suppressed. + ## 5. Selector (Advanced) ### 1. Normal Files @@ -406,42 +598,42 @@ Comma separated `.gitignore, .dockerignore` #### Add default patterns -## 6. Customization sync (Advanced) +## 6. Customisation sync (Advanced) -### 1. Customization Sync +### 1. Customisation Sync #### Device name Setting key: deviceAndVaultName -Unique name between all synchronized devices. To edit this setting, please disable customization sync once. +Unique name between all synchronised devices. To edit this setting, please disable customisation sync once. -#### Per-file-saved customization sync +#### Per-file-saved customisation sync Setting key: usePluginSyncV2 -If enabled per-filed efficient customization sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enabled this, we lost a compatibility with old versions. +If enabled, per-file efficient customisation sync will be used. We need a small migration when enabling this. And all devices should be updated to v0.23.18. Once we enable this, we lose compatibility with old versions. -#### Enable customization sync +#### Enable customisation sync Setting key: usePluginSync -#### Scan customization automatically +#### Scan customisation automatically Setting key: autoSweepPlugins -Scan customization before replicating. +Scan customisation before replicating. -#### Scan customization periodically +#### Scan customisation periodically Setting key: autoSweepPluginsPeriodic -Scan customization every 1 minute. +Scan customisation every 1 minute. -#### Notify customized +#### Notify customised Setting key: notifyPluginOrSettingUpdated -Notify when other device has newly customized. +Notify when another device has newly customised. #### Open -Open the dialog +Open the dialogue ## 7. Hatch @@ -486,7 +678,7 @@ Compare the content of files between on local database and storage. If not match #### Back to non-configured -#### Delete all customization sync data +#### Delete all customisation sync data ## 8. Advanced (Advanced) @@ -507,6 +699,12 @@ Setting key: hashCacheMaxAmount Setting key: customChunkSize +#### Chunk Splitter + +Setting key: chunkSplitterVersion + +Select the chunk splitter version; V3 is the most efficient. If you experience issues, please choose Default or Legacy. + #### Use splitting-limit-capped chunk splitter Setting key: enableChunkSplitterV2 @@ -532,6 +730,12 @@ Setting key: concurrencyOfReadChunksOnline Setting key: minimumIntervalOfReadChunksOnline +#### Maximum size of chunks to send in one request + +Setting key: sendChunksBulkMaxSize + +Limit the maximum size of chunks to send in a single bulk request (MB). + ## 9. Power users (Power User) ### 1. Remote Database Tweak @@ -639,7 +843,7 @@ If this enabled, All files are handled as case-Sensitive (Previous behaviour). ### 4. Compatibility (Internal API Usage) -#### Scan changes on customization sync +#### Scan changes on customisation sync Setting key: watchInternalFileChanges Do not use internal API @@ -664,7 +868,13 @@ Setting key: doNotSuspendOnFetching #### Keep empty folder Setting key: doNotDeleteFolder -Should we keep folders that don't have any files inside? +Should we keep folders that do not have any files inside? + +#### Process files even if seems to be corrupted + +Setting key: processSizeMismatchedFiles + +Enable this setting to process files with size mismatches, which can sometimes be created by certain external APIs or integrations. ### 7. Edge case addressing (Processing) @@ -684,17 +894,25 @@ If enabled, the file under 1kb will be processed in the UI thread. Setting key: disableCheckingConfigMismatch +### 9. Remediation + +#### Maximum file modification time for reflected file events + +Setting key: maxMTimeForReflectEvents + +Files with modification times greater than this value (in seconds since the Unix epoch) will not have their events reflected. Set to 0 to disable this limit. + ## 11. Maintenance ### 1. Scram! #### Lock Server -Lock the remote server to prevent synchronization with other devices. +Lock the remote server to prevent synchronisation with other devices. #### Emergency restart -Disables all synchronization and restart. +Disables all synchronisation and restart. ### 2. Syncing @@ -712,17 +930,13 @@ Initialise journal sent history. On the next sync, every item except this device ### 3. Rebuilding Operations (Local) -#### Fetch from remote +#### Reset Synchronisation on This Device Restore or reconstruct local database from remote. -#### Fetch rebuilt DB (Save local documents before) - -Restore or reconstruct local database from remote database but use local chunks. - ### 4. Total Overhaul -#### Rebuild everything +#### Overwrite Server Data with This Device's Files Rebuild local and remote database with local files. @@ -752,7 +966,7 @@ Delete all data on the remote server. #### Run database cleanup -Attempt to shrink the database by deleting unused chunks. This may not work consistently. Use the 'Rebuild everything' under Total Overhaul. +Attempt to shrink the database by deleting unused chunks. This may not work consistently. Use the 'Overwrite Server Data with This Device's Files' under Reset Synchronisation information. ### 7. Reset diff --git a/docs/settings_ja.md b/docs/settings_ja.md index d7b9cf3..d442506 100644 --- a/docs/settings_ja.md +++ b/docs/settings_ja.md @@ -3,23 +3,133 @@ # このプラグインの設定項目 ## Remote Database Configurations -同期先のデータベース設定を行います。何らかの同期が有効になっている場合は編集できないため、同期を解除してから行ってください。 +同期先のデータベース設定（Remote Server）を行います。 -### URI -CouchDBのURIを入力します。Cloudantの場合は「External Endpoint(preferred)」になります。 -**スラッシュで終わってはいけません。** -こちらにデータベース名を含めてもかまいません。 +現在のバージョンでは、複数のリモート接続設定（接続プロファイル）を登録・管理し、切り替えて使用することが可能です（「Remote Databases」リスト）。 -### Username -ユーザー名を入力します。このユーザーは管理者権限があることが望ましいです。 +- **➕ 新規接続を追加 (Add new connection)**: 新しい接続設定を作成し、各セットアップダイアログを起動します。 +- **📥 接続をインポート (Import connection)**: 接続文字列（`sls+https://...`、`sls+s3://...`、`sls+p2p://...`など）を貼り付けてインポートします。 +- **🔧 設定 (Configure)**: セットアップダイアログを開き、選択した接続プロファイルの設定を編集します。 +- **✅ 有効化 (Activate)**: 選択したプロファイルをアクティブな同期先として有効化します。 +- **🗑️ 削除 (Delete)**: 接続プロファイルを一覧から削除します。 -### Password -パスワードを入力します。 +これらの接続プロファイルを追加・編集する際、選択したデータベースの種類（CouchDB、S3互換オブジェクトストレージ、P2Pなど）に応じたセットアップダイアログが開きます。 -### Database Name -同期するデータベース名を入力します。 -⚠️存在しない場合は、テストや接続を行った際、自動的に作成されます[^1]。 -[^1]:権限がない場合は自動作成には失敗します。 +何らかの同期が有効になっている場合は編集できないため、同期を解除してから行ってください。 + +### CouchDB の設定 +CouchDBの各設定項目は、接続プロファイルを追加 (➕) または設定 (🔧) する際に開く **CouchDB セットアップダイアログ** 内で設定します。 + +#### URI +設定キー: couchDB_URI + +CouchDBの接続先URIです。ダイアログ内では **URL** と表記されます。Cloudantの場合は「External Endpoint (preferred)」になります。 +注意: Obsidian Mobileではセキュア接続 (HTTPS) のみが使用可能です。また、末尾にスラッシュ（`/`）を付けてはいけません。 + +#### Username +設定キー: couchDB_USER + +CouchDBのログインユーザー名です。ダイアログ内では **Username** と表記されます。このユーザーには管理者権限があることが望ましいです。 + +#### Password +設定キー: couchDB_PASSWORD + +CouchDBのログインパスワードです。ダイアログ内では **Password** と表記されます。 + +#### Database Name +設定キー: couchDB_DBNAME + +同期先のデータベース名です。ダイアログ内では **Database Name** と表記されます。 +注意: データベース名には大文字、スペース、および一部の特殊文字（`_$()+/-` 以外）は使用できません。また、アンダースコア（`_`）から始めることはできません。存在しない場合は、接続テスト時または設定適用時に自動作成されます（作成権限が必要です）。 + +#### CORS回避のためにRequest APIを使用する +設定キー: useRequestAPI + +この項目はセットアップダイアログ内では **Use Internal API** と表記されます。有効な場合、不可避なCORS問題を回避するためにObsidianの内部Request APIを使用します。これはWeb標準に準拠していない回避策であり、すべての環境での動作を保証するものではありません。安全性が低下する可能性がある点にご注意ください。将来のObsidianのアップデートによって動作しなくなる可能性があります。 + +#### カスタムヘッダー +設定キー: couchDB_CustomHeaders + +CouchDBサーバーに送信するすべてのリクエストに含めるカスタムHTTPヘッダーを設定します。ダイアログ内では **Custom Headers** と表記されます。`ヘッダー名: 値` の形式で、1行に1つずつ入力してください。 + +#### JWT認証の使用 (実験的機能) +設定キー: useJWT + +CouchDBでのJSON Web Token (JWT) 認証を有効にします。ダイアログ内では **Use JWT Authentication** と表記されます。十分に検証されていない実験的機能であるため、ご注意ください。 + +#### JWTアルゴリズム +設定キー: jwtAlgorithm + +JWTの署名に使用するアルゴリズムを選択します。ダイアログ内では **JWT Algorithm** と表記されます。対応アルゴリズム: `HS256`, `HS512`, `ES256`, `ES512` + +#### JWT有効期限 (分) +設定キー: jwtExpDuration + +トークンの有効期限を分単位で指定します。ダイアログ内では **JWT Expiration Duration (minutes)** と表記されます。`0` を指定すると有効期限は無効になります。 + +#### JWTキー +設定キー: jwtKey + +JWTの署名に使用する秘密鍵またはプライベートキーを指定します。ダイアログ内では **JWT Key** と表記されます。`HS256/HS512` の場合は共通鍵を、`ES256/ES512` の場合は pkcs8 PEM形式の秘密鍵を入力してください。 + +#### JWTキーID (kid) +設定キー: jwtKid + +JWTヘッダーに含めるキーIDを指定します。ダイアログ内では **JWT Key ID (kid)** と表記されます。 + +#### JWTサブジェクト (sub) +設定キー: jwtSub + +JWTのサブジェクト (CouchDBユーザー名) を指定します。ダイアログ内では **JWT Subject (sub)** と表記されます。 + +### Object Storage (Minio, S3, R2) の設定 +Object Storageの各設定項目は、接続プロファイルを追加 (➕) または設定 (🔧) する際に開く **S3/MinIO/R2 セットアップダイアログ** 内で設定します。 + +#### エンドポイントURL +設定キー: endpoint + +S3互換ストレージのエンドポイントURLです。ダイアログ内では **Endpoint URL** と表記されます。 +注意: Obsidian Mobileではセキュア接続 (HTTPS) のみが使用可能です。 + +#### アクセスキー ID +設定キー: accessKey + +認証に使用するアクセスキーIDです。ダイアログ内では **Access Key ID** と表記されます。 + +#### シークレットアクセスキー +設定キー: secretKey + +認証に使用するシークレットアクセスキーです。ダイアログ内では **Secret Access Key** と表記されます。 + +#### リージョン +設定キー: region + +ストレージのリージョンを指定します（例: `us-east-1`、Cloudflare R2の場合は `auto`）。ダイアログ内では **Region** と表記されます。 + +#### バケット名 +設定キー: bucket + +同期データを保存するバケット名です。ダイアログ内では **Bucket Name** と表記されます。 + +#### カスタムHTTPハンドラーを使用する +設定キー: useCustomRequestHandler + +この項目はセットアップダイアログ内では **Use internal API** と表記されます。オブジェクトストレージがCORSをサポートしていない場合に有効にします。Obsidianの内部APIを使用してS3サーバーと通信することでCORS制約を回避します。Web標準には準拠していないため、将来のObsidianのアップデートによって動作しなくなる可能性があります。 + +#### バケット内のファイルプレフィックス +設定キー: bucketPrefix + +この項目はセットアップダイアログ内では **Folder Prefix** と表記されます。実質的なディレクトリ指定です。末尾は `/` である必要があります（例：`vault-name/`）。バケットのルートに保存する場合は空欄のままにしてください。 + +#### forcePathStyleを有効にする +設定キー: forcePathStyle + +この項目はセットアップダイアログ内では **Use Path-Style Access** と表記されます。有効な場合、バケット操作でforcePathStyleオプションを使用します。 + +#### カスタムヘッダー +設定キー: bucketCustomHeaders + +オブジェクトストレージバケットに送信するすべてのリクエストに含めるカスタムHTTPヘッダーを設定します。ダイアログ内では **Custom Headers** と表記されます。`ヘッダー名: 値` の形式で、1行に1つずつ入力してください。 @@ -30,6 +140,18 @@ CouchDBのURIを入力します。Cloudantの場合は「External Endpoint(prefe ### Passphrase 暗号化を行う際に使用するパスフレーズです。充分に長いものを使用してください。 +### パスの難読化 +設定キー: usePathObfuscation + +ダイアログ内では **Obfuscate Properties** と表記されます。有効な場合、リモートサーバー上でのファイルパスやフォルダ名を難読化（暗号化）します。これによりプライバシーが向上しますが、パフォーマンスがわずかに低下する可能性があります。 + +### 暗号化アルゴリズム +設定キー: E2EEAlgorithm + +ダイアログ内では **Encryption Algorithm** と表記されます。エンドツーエンド暗号化に使用する暗号化アルゴリズムのバージョンを選択します。 +- `v2` (V2: AES-256-GCM With HKDF): 推奨されるデフォルトのバージョンです。 +- `forceV1` または `""` (V1: Legacy): レガシーな暗号化バージョンです。古いバージョンで暗号化された既存の保管庫（Vault）を同期する場合にのみ使用してください。 + ### Apply End to End 暗号化を行うに当たって、異なるパスフレーズで暗号化された同一の内容を入手されることは避けるべきです。また、Self-hosted LiveSyncはコンテンツのcrc32を重複回避に使用しているため、その点でも攻撃が有効になってしまいます。 @@ -53,12 +175,66 @@ End to End 暗号化を行うに当たって、異なるパスフレーズで暗 どちらのオペレーションも、実行するとすべての同期設定が無効化されます。 + + ### Test Database connection 上記の設定でデータベースに接続できるか確認します。 ### Check database configuration ここから直接CouchDBの設定を確認・変更できます。 +### Peer-to-Peer (P2P) 同期の設定 + +#### P2P同期を有効にする +設定キー: P2P_Enabled + +WebRTCを介したデバイス間での直接的なP2P同期を有効にします。ダイアログ内では **Enabled** と表記されます。 + +#### リレーサーバーのURL +設定キー: P2P_relays + +WebRTCによるP2P接続を仲介・調整するためのWebSocketリレーサーバーのURLを指定します。ダイアログ内では **Relay URL** と表記されます。複数のURLを指定する場合はカンマで区切ります。ダイアログ内のボタンをクリックすると、デフォルトのリレーサーバーを設定できます。 + +#### グループID +設定キー: P2P_roomID + +同期するデバイス群を識別するためのルームIDまたはグループIDを指定します。ダイアログ内では **Group ID** と表記されます。同期させたいすべてのデバイスで同じグループIDを指定する必要があります。任意のカスタム文字列を入力するか、ランダム生成ボタンで生成できます。 + +#### パスフレーズ +設定キー: P2P_passphrase + +P2P通信の認証および暗号化に使用するパスワード（パスフレーズ）を指定します。ダイアログ内では **Passphrase** と表記されます。同期するすべてのデバイスで同じパスフレーズを指定する必要があります。 + +#### デバイス名 +設定キー: P2P_DevicePeerName + +P2Pネットワーク上でこのデバイスを識別するための名前を指定します。ダイアログ内では **Device Peer ID** と表記されます。グループ内のデバイス間で重複しない一意の値を設定してください。 + +#### 起動時のP2P自動接続開始 +設定キー: P2P_AutoStart + +有効な場合、プラグインの起動時に自動的にP2P接続を開始します。ダイアログ内では **Auto Start P2P Connection** と表記されます。 + +#### 接続済みピアへの変更の自動ブロードキャスト +設定キー: P2P_AutoBroadcast + +有効な場合、ローカルでの変更が接続済みのピアに自動的にブロードキャストされます。ダイアログ内では **Auto Broadcast Changes** と表記されます。通知されたピアは変更の取得を開始します。 + +#### TURNサーバーのURL (カンマ区切り) +設定キー: P2P_turnServers + +ダイアログ内では **TURN Server URLs (comma-separated)** と表記されます。厳しいNATやファイアウォールがある環境で、WebRTCの直接接続が確立できない場合にP2P接続を中継するためのTURN/STUNサーバーのURLをカンマ区切りで指定します。通常は空欄のままで問題ありません。 + +#### TURNユーザー名 +設定キー: P2P_turnUsername + +TURNサーバーでの認証に使用するユーザー名を設定します。ダイアログ内では **TURN Username** と表記されます。 + +#### TURNパスワード +設定キー: P2P_turnCredential + +TURNサーバーでの認証に使用するパスワード（クレデンシャル）を設定します。ダイアログ内では **TURN Credential** と表記されます。 + ## Local Database Configurations 端末内に作成されるデータベースの設定です。 @@ -88,6 +264,11 @@ Self-hosted LiveSyncは一つのチャンクのサイズを最低minimum chunk s 改行文字と#を除き、すべて●に置換しても、アルゴリズムは有効に働きます。 デフォルトは20文字と、250文字です。 +### チャンクスプリッター +設定キー: chunkSplitterVersion + +チャンク分割アルゴリズムを選択します。V3が最も効率的です。問題が発生した場合はDefaultまたはLegacyに設定してください。 + ## General Settings 一般的な設定です。 @@ -97,6 +278,16 @@ Self-hosted LiveSyncは一つのチャンクのサイズを最低minimum chunk s ### Vervose log 詳細なログをログに出力します。 +### ファイル警告バナーの代わりにステータスアイコンを表示 +設定キー: hideFileWarningNotice + +有効な場合、ファイル警告バナーの代わりにステータス表示内に ⛔ アイコンが表示されます（詳細情報は非表示になります）。 + +### ネットワーク警告のスタイル +設定キー: networkWarningStyle + +同期サーバーに接続できない場合のネットワークエラーの表示方法。 + ## Sync setting 同期に関する設定です。 @@ -110,6 +301,11 @@ LiveSyncを行います。 ### Periodic Sync Interval 定期的に同期を行う場合の間隔です。 +### 同期の最小間隔 +設定キー: syncMinimumInterval + +イベント時の自動同期の最小間隔（ミリ秒）。 + ### Sync on Save ファイルが保存されたときに同期を行います。 **Obsidianは、ノートを編集している間、定期的に保存を行います。添付ファイルを新しく追加した場合も同様に処理されます。** @@ -146,6 +342,11 @@ Self-hosted LiveSyncは通常、フォルダ内のファイルがすべて削除 - Scan hidden files periodicaly. このオプションを有効にすると、n秒おきに隠しファイルをスキャンします。 +#### 非表示ファイルの変更通知を抑制 +設定キー: suppressNotifyHiddenFilesChange + +有効な場合、非表示ファイルの変更に関する通知を抑制します。 + 隠しファイルは能動的に検出されないため、スキャンが必要です。 スキャンでは、ファイルと共にファイルの変更時刻を保存します。もしファイルが消された場合は、その事実も保存します。このファイルを記録したエントリーがレプリケーションされた際、ストレージよりも新しい場合はストレージに反映されます。 @@ -176,6 +377,11 @@ Self-hosted LiveSyncはPouchDBを使用し、リモートと[このプロトコ ### Batch limit 一度に処理するBatchの数です。デフォルトは40です。 +### 1回のリクエストで送信するチャンクの最大サイズ +設定キー: sendChunksBulkMaxSize + +メガバイト（MB）単位で指定します。 + ## Miscellaneous その他の設定です ### Show status inside editor @@ -195,8 +401,8 @@ Self-hosted LiveSyncはPouchDBを使用し、リモートと[このプロトコ ![CorruptedData](../images/lock_pattern1.png) データベースがロックされていて、端末が「解決済み」とマークされていない場合、警告が表示されます。 他のデバイスで、End to End暗号化を有効にしたか、Drop Historyを行った等、他の端末がそのまま同期を行ってはいない状態に陥った場合表示されます。 -暗号化を有効化した場合は、パスフレーズを設定してApply and recieve、Drop Historyを行った場合は、Drop and recieveを行うと自動的に解除されます。 -手動でこのロックを解除する場合は「mark this device as resolved」をクリックしてください。 +暗号化を有効化した場合は、パスフレーズを設定して「このデバイスの同期状態をリセット」、または「このデバイスのファイルでサーバーデータを上書き」を行うと自動的に解除されます。 +手動でこのロックを解除する場合は「I've made a backup, mark this device 'resolved'」をクリックしてください。 - パターン２ ![CorruptedData](../images/lock_pattern2.png) @@ -207,10 +413,10 @@ Self-hosted LiveSyncはPouchDBを使用し、リモートと[このプロトコ ### Verify and repair all files Vault内のファイルを全て読み込み直し、もし差分があったり、データベースから正常に読み込めなかったものに関して、データベースに反映します。 -- Drop and send -デバイスとリモートのデータベースを破棄し、ロックしてからデバイスのファイルでデータベースを構築後、リモートに上書きします。 -- Drop and receive -デバイスのデータベースを破棄した後、リモートから、操作しているデバイスに関してロックを解除し、データを受信して再構築します。 +- このデバイスの同期状態をリセット (Reset Synchronisation on This Device) +ローカルのデータベースを破棄し、リモートのデータから再構築します。 +- このデバイスのファイルでサーバーデータを上書き (Overwrite Server Data with This Device's Files) +ローカルおよびリモートのデータベースをこのデバイス上のファイルで再構築（上書き）します。 ### Lock remote database リモートのデータベースをロックし、他の端末で同期を行おうとしてもエラーとともに同期がキャンセルされるように設定します。これは、データベースの再構築を行った場合、自動的に設定されるものと同じものです。 @@ -220,6 +426,18 @@ Vault内のファイルを全て読み込み直し、もし差分があったり ### Suspend file watching ファイルの更新の監視を止めます。 +### 破損している可能性があるファイルも処理する +設定キー: processSizeMismatchedFiles + +サイズ不一致のあるファイルを処理します。特定のAPIや外部連携によって作成されたファイルを同期する際に役立ちます。 + +### Remediation + +#### イベント反映時の最大ファイル更新日時 +設定キー: maxMTimeForReflectEvents + +この値（Unixエポックからの秒数）より新しい更新日時を持つファイルについては、イベントの反映を無視します。0を指定すると制限が無効になります。 + ### Corrupted data ![CorruptedData](../images/corrupted_data.png) diff --git a/docs/setup_cloudant.md b/docs/setup_cloudant.md index 83ca3ea..a979cb9 100644 --- a/docs/setup_cloudant.md +++ b/docs/setup_cloudant.md @@ -13,7 +13,7 @@ In these instructions, create IBM Cloudant Instance for trial. 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. +1. Select Multitenant (it is 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". @@ -28,20 +28,20 @@ In these instructions, create IBM Cloudant Instance for trial. 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. (\*1). We use this address later, with the database name. +1. In resource details, there is information to connect from Self-hosted LiveSync. + Copy the "External Endpoint (preferred)" address. (\*1). 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. + Yes, it is 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._ + _NOTE: of course We want to set "app://obsidian.md" but it is not acceptable on Cloudant._ ![step 2](../instruction_images/couchdb_2.png) 1. Next, Open the "Databases" tab and hit the "Create Database" button. @@ -55,10 +55,10 @@ In these instructions, create IBM Cloudant Instance for trial. ### Credentials Setup -1. Back into IBM Cloud, Open the "Service credentials". You'll get an empty list, hit the "New credential" button. +1. Back into IBM Cloud, Open the "Service credentials". You will 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. +1. The dialogue 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._ @@ -68,14 +68,14 @@ In these instructions, create IBM Cloudant Instance for trial. ![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 + follow the figure, it is "apikey-v2-2unu15184f7o8emr90xlqgkm2ncwhbltml6tgnjl9sd5"(\*3) and "c2c11651d75497fa3d3c486e4c8bdf27"(\*4) ## Self-hosted LiveSync settings ![Setting](../images/remote_db_setting.png) -The Setting should be as below: +The settings should be as follows: | Items | Value | example | | ------------- | ----- | ----------------------------------------------------------------- | diff --git a/docs/tech_info.md b/docs/tech_info.md index 97fc2cc..3aa24b1 100644 --- a/docs/tech_info.md +++ b/docs/tech_info.md @@ -1,8 +1,8 @@ # Designed architecture -## How does this plugin synchronize. +## How does this plug-in synchronise. -![Synchronization](../images/1.png) +![Synchronisation](../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. diff --git a/docs/tech_info_cn.md b/docs/tech_info_cn.md index c3dc1ea..c1d450c 100644 --- a/docs/tech_info_cn.md +++ b/docs/tech_info_cn.md @@ -2,7 +2,7 @@ ## 这个插件是怎么实现同步的. -![Synchronization](../images/1.png) +![Synchronisation](../images/1.png) 1. 当笔记创建或修改时，Obsidian会触发事件。Self-hosted LiveSync捕获这些事件，并将变更同步至本地PouchDB 2. PouchDB通过自动或手动方式将变更同步至远程CouchDB diff --git a/docs/tech_info_ja.md b/docs/tech_info_ja.md index f23c22d..faee6b6 100644 --- a/docs/tech_info_ja.md +++ b/docs/tech_info_ja.md @@ -2,7 +2,7 @@ ## 同期 -![Synchronization](../images/1.png) +![Synchronisation](../images/1.png) 1. ノートが更新された際、Obsidianがイベントを発報します。Obsidian-LiveSyncはそれをハンドリングして、ローカルのPouchDBに変更を反映します。 2. PouchDBは、リモートのCouchDBに差分をレプリケーションします。 diff --git a/docs/terms.md b/docs/terms.md index 4a833fa..c630a4e 100644 --- a/docs/terms.md +++ b/docs/terms.md @@ -46,6 +46,8 @@ - As the name of a synchronisation mode. This should be changed to `Continuous`, in contrast to `Periodic`. - livesync-serverpeer / webpeer - Pseudo-clients that assist in WebRTC peer-to-peer communication. +- JWT Authentication + - An experimental authentication option for CouchDB allowing secure token-based authentication instead of standard credentials. It requires a configured private key/secret, algorithm, expiration duration, subject, and key ID. - OneShot Sync - A single, immediate bidirectional synchronisation (pull then push) triggered on demand or on specific events, as opposed to continuous (live) replication. - Overwrite Server Data with This Device's Files @@ -54,6 +56,8 @@ - A privacy option that encrypts file paths and folder names on the remote server. - plug-in - We use the hyphenated form `plug-in` in user-facing messages and general documentation, while `plugin` may appear in codebase files, configuration settings, or technical contexts. +- Relay Server (P2P relays) + - A WebSocket-based coordination server used to establish direct WebRTC peer-to-peer connections. The default relay is provided by the plug-in author. - Remediation (maxMTimeForReflectEvents) - A recovery setting that restricts the propagation of changes from the database to local storage, ignoring any file events (such as accidental mass deletions) that occurred after a specified date and time. - Reset Synchronisation on This Device @@ -70,6 +74,8 @@ - An encrypted representation of the plug-in's settings containing server configuration, which allows users to clone their configuration across devices securely using a passphrase. - Sync Mode - The replication trigger mechanism. Users can select from `On Events` (synchronising on local file changes), `Periodic and Events` (synchronising at fixed intervals as well as on events), or `LiveSync` (continuous, real-time synchronisation). +- TURN Server (WebRTC P2P) + - A server type (Traversal Using Relays around NAT) used as a fallback to relay traffic when direct WebRTC peer-to-peer connection is blocked by strict NAT or firewalls. - Update Thinning (Batch database update) - An optimisation that groups multiple local file edits together over a short delay before committing them to the local database, reducing the number of database write operations. - WebRTC P2P (Peer-to-Peer) diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index a1f59cd..64d452e 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -224,7 +224,7 @@ There are many cases where this is really unclear. One possibility is that the c - If you know when the files were deleted, set the time a bit before that. - If not, bisecting may help us. 6. Delete `redflag.md`. -7. Perform `Reset synchronisation on This Device` on the `🎛️ Maintenance` pane. +7. Perform `Reset Synchronisation on This Device` on the `🎛️ Maintenance` pane. This mode is very fragile. Please be careful. @@ -236,16 +236,16 @@ not been stable. The new adapter has better performance and has a new feature like purging. Therefore, we should use new adapters and current default is so. However, when switching from an old adapter to a new adapter, some converting or -local database rebuilding is required, and it takes a few time. It was a long +local database rebuilding is required, and it takes some time. It was a long time ago now, but we once inconvenienced everyone in a hurry when we changed the format of our database. For these reasons, this toggle is automatically on if we have upgraded from vault which using an old adapter. -When you rebuild everything or fetch from the remote again, you will be asked to +When you overwrite server data with this device's files or reset synchronisation on this device again, you will be asked to switch this. Therefore, experienced users (especially those stable enough not to have to -rebuild the database) may have this toggle enabled in their Vault. Please +overwrite server data) may have this toggle enabled in their Vault. Please disable it when you have enough time. ### ZIP (or any extensions) files were not synchronised. Why? @@ -303,9 +303,9 @@ happened on other devices. This means that conflicts will happen in the past, after the time we have synchronised. Hence we cannot collect and delete the unused chunks even though if we are not currently referenced. -To shrink the database size, `Rebuild everything` only reliably and effectively. +To shrink the database size, `Overwrite Server Data with This Device's Files` is the only reliable and effective way. But do not worry, if we have synchronised well. We have the actual and real -files. Only it takes a bit of time and traffics. +files. Only it takes a bit of time and traffic. ### How to launch the DevTools @@ -385,14 +385,14 @@ There are some options to use `redflag.md`. | Filename | Human-Friendly Name | Description | | ------------- | ------------------- | --------------------------------------------------------------------------------------- | | `redflag.md` | - | Suspends all processes. | -| `redflag2.md` | `flag_rebuild.md` | Suspends all processes, and rebuilds both local and remote databases from local files. | -| `redflag3.md` | `flag_fetch.md` | Suspends all processes, discards the local database, and fetches from the remote again. | +| `redflag2.md` | `flag_rebuild.md` | Suspends all processes, and overwrites server data with this device's files. | +| `redflag3.md` | `flag_fetch.md` | Suspends all processes, discards the local database, and resets synchronisation on this device. | -When fetching everything remotely or performing a rebuild, restarting Obsidian +When resetting synchronisation on this device or overwriting server data, restarting Obsidian is performed once for safety reasons. At that time, Self-hosted LiveSync uses these files to determine whether the process should be carried out. (The use of normal markdown files is a trick to externally force cancellation in the event -of faults in the rebuild or fetch function itself, especially on mobile +of faults in the overwrite or reset function itself, especially on mobile devices). This mechanism is also used for set-up. And just for information, these files are also not subject to synchronisation. @@ -411,19 +411,18 @@ normally after restarting Obsidian. (As far as I can observe). ### Old tips -- Rarely, a file in the database could be corrupted. The plugin will not write +- Rarely, a file in the database could be corrupted. The plug-in will not write to local storage when a file looks corrupted. If a local version of the file is on your device, the corruption could be fixed by editing the local file and - synchronizing it. But if the file does not exist on any of your devices, then + synchronising it. But if the file does not exist on any of your devices, then it can not be rescued. In this case, you can delete these items from the - settings dialog. + settings dialogue. - To stop the boot-up sequence (eg. for fixing problems on databases), you can put a `redflag.md` file (or directory) at the root of your vault. Tip for iOS: a redflag directory can be created at the root of the vault using the File application. -- Also, with `redflag2.md` placed, we can automatically rebuild both the local - and the remote databases during the boot-up sequence. With `redflag3.md`, we - can discard only the local database and fetch from the remote again. +- Also, with `redflag2.md` placed, we can automatically overwrite server data with this device's files during the boot-up sequence. With `redflag3.md`, we + can discard only the local database and reset synchronisation on this device. - Q: The database is growing, how can I shrink it down? A: each of the docs is saved with their past 100 revisions for detecting and resolving conflicts. Picturing that one device has been offline for a while, and comes online @@ -435,7 +434,7 @@ normally after restarting Obsidian. (As far as I can observe). So, We have to make the database again like an enlarged git repo if you want to solve the root of the problem. - And more technical Information is in the [Technical Information](tech_info.md) -- If you want to synchronize files without obsidian, you can use +- If you want to synchronise files without obsidian, you can use [filesystem-livesync](https://github.com/vrtmrz/filesystem-livesync). - WebClipper is also available on Chrome Web Store:[obsidian-livesync-webclip](https://chrome.google.com/webstore/detail/obsidian-livesync-webclip/jfpaflmpckblieefkegjncjoceapakdf)