diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 901d3fd..6a6bc86 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -20,6 +20,7 @@ - [On the mobile device, cannot synchronise on the local network!](#on-the-mobile-device-cannot-synchronise-on-the-local-network) - [I think that something bad happening on the vault...](#i-think-that-something-bad-happening-on-the-vault) - [Tips](#tips) + - [How to resolve `Tweaks Mismatched of Changed`](#how-to-resolve-tweaks-mismatched-of-changed) - [Old tips](#old-tips) @@ -111,8 +112,28 @@ Place `redflag.md` on top of the vault, and restart Obsidian. The most simple wa If there is `redflag.md`, Self-hosted LiveSync suspends all database and storage processes. ## Tips + +### How to resolve `Tweaks Mismatched of Changed` + +(Since v0.23.17) + +If you have changed some configurations or tweaks which should be unified between the devices, you will be asked how to reflect (or not) other devices at the next synchronisation. It also occurs on the device itself, where changes are made, to prevent unexpected configuration changes from unwanted propagation. +(We may thank this behaviour if we have synchronised or backed up and restored Self-hosted LiveSync. At least, for me so). + +Following dialogue will be shown: +![Dialogue](tweak_mismatch_dialogue.png) + +- If we want to propagate the setting of the device, we should choose `Update with mine`. +- On other devices, we should choose `Use configured` to accept and use the configured configuration. +- `Dismiss` can postpone a decision. However, we cannot synchronise until we have decided. + +Rest assured that in most cases we can choose `Use configured`. (Unless you are certain that you have not changed the configuration). + +If we see it for the first time, it reflects the settings of the device that has been synchronised with the remote for the first time since the upgrade. Probably, we can accept that. + + ### Old tips - Rarely, a file in the database could be corrupted. The plugin 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 it can not be rescued. In this case, you can delete these items from the settings dialog. - 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. diff --git a/docs/tweak_mismatch_dialogue.png b/docs/tweak_mismatch_dialogue.png new file mode 100644 index 0000000..073a999 Binary files /dev/null and b/docs/tweak_mismatch_dialogue.png differ diff --git a/manifest.json b/manifest.json index fa8f2ac..0b053b6 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { "id": "obsidian-livesync", "name": "Self-hosted LiveSync", - "version": "0.23.16", + "version": "0.23.17", "minAppVersion": "0.9.12", "description": "Community implementation of self-hosted livesync. Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.", "author": "vorotamoroz", diff --git a/package-lock.json b/package-lock.json index 251aff4..c416c1e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "obsidian-livesync", - "version": "0.23.16", + "version": "0.23.17", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "obsidian-livesync", - "version": "0.23.16", + "version": "0.23.17", "license": "MIT", "dependencies": { "@aws-sdk/client-s3": "^3.614.0", diff --git a/package.json b/package.json index 71c774a..8f16312 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "obsidian-livesync", - "version": "0.23.16", + "version": "0.23.17", "description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.", "main": "main.js", "type": "module", diff --git a/updates.md b/updates.md index 578801f..bd2b803 100644 --- a/updates.md +++ b/updates.md @@ -18,6 +18,18 @@ I have a lot of respect for that plugin, even though it is sometimes treated as Hooray for open source, and generous licences, and the sharing of knowledge by experts. #### Version history +- 0.23.17: + - Improved: + - Overall performance has been improved by using PouchDB 9.0.0. + - Configuration mismatch detection is refined. We can resolve mismatches more smoothly and naturally. + More detail is on `troubleshooting.md` on the repository. + - Fixed: + - Customisation Sync will be disabled when a corrupted configuration is detected. + Therefore, the Device Name can be changed even in the event of a configuration mismatch. + - New feature: + - We can get a notification about the storage usage of the remote database. + - Default: We will be asked. + - If the remote storage usage approaches the configured value, we will be asked whether we want to Rebuild or increase the limit. - 0.23.16: - Maintenance Update: - Library refining (Phase 1 - step 2). There are no significant changes on the user side. @@ -37,20 +49,6 @@ Hooray for open source, and generous licences, and the sharing of knowledge by e - Default: 5 seconds, the same as the previous hard-coded value. (Note: also, the previous behaviour was not correct). - Also, we can configure the limit of delaying batch-saving. - The performance of showing status indicators has been improved. -- 0.23.13: - - Fixed: - - No longer files have been trimmed even delimiters have been continuous. - - Fixed the toggle title to `Do not split chunks in the background` from `Do not split chunks in the foreground`. - - Non-configured item mismatches are no longer detected. -- 0.23.12: - - Improved: - - Now notes will be split into chunks in the background thread to improve smoothness. - - Default enabled, to disable, toggle `Do not split chunks in the foreground` on `Hatch` -> `Compatibility`. - - If you want to process very small notes in the foreground, please enable `Process small files in the foreground` on `Hatch` -> `Compatibility`. - - We can use a `splitting-limit-capped chunk splitter`; which performs more simple and make less amount of chunks. - - Default disabled, to enable, toggle `Use splitting-limit-capped chunk splitter` on `Sync settings` -> `Performance tweaks` - - Tidied - - Some files have been separated into multiple files to make them more explicit in what they are responsible for. Older notes is in [updates_old.md](https://github.com/vrtmrz/obsidian-livesync/blob/main/updates_old.md). \ No newline at end of file diff --git a/updates_old.md b/updates_old.md index 092db28..69d063d 100644 --- a/updates_old.md +++ b/updates_old.md @@ -18,6 +18,20 @@ I have a lot of respect for that plugin, even though it is sometimes treated as Hooray for open source, and generous licences, and the sharing of knowledge by experts. #### Version history +- 0.23.13: + - Fixed: + - No longer files have been trimmed even delimiters have been continuous. + - Fixed the toggle title to `Do not split chunks in the background` from `Do not split chunks in the foreground`. + - Non-configured item mismatches are no longer detected. +- 0.23.12: + - Improved: + - Now notes will be split into chunks in the background thread to improve smoothness. + - Default enabled, to disable, toggle `Do not split chunks in the foreground` on `Hatch` -> `Compatibility`. + - If you want to process very small notes in the foreground, please enable `Process small files in the foreground` on `Hatch` -> `Compatibility`. + - We can use a `splitting-limit-capped chunk splitter`; which performs more simple and make less amount of chunks. + - Default disabled, to enable, toggle `Use splitting-limit-capped chunk splitter` on `Sync settings` -> `Performance tweaks` + - Tidied + - Some files have been separated into multiple files to make them more explicit in what they are responsible for. - 0.23.11: - Fixed: - Now we *surely* can set the device name and enable customised synchronisation.