bump 0.3.35

tencent cloud cos
missing saving
2024-01-14 00:09:23 +08:00 · 2024-01-13 23:57:16 +08:00 · 2024-01-13 23:03:30 +08:00 · 2024-01-13 22:47:34 +08:00 · 2024-01-13 21:27:42 +08:00 · 2024-01-13 21:20:56 +08:00
135 changed files with 9959 additions and 1480 deletions
@@ -23,6 +23,6 @@ indent_size = 4
 indent_style = tab
 # Indentation override for all JS under lib directory
-[*.{js,jsx,mjs,cjs,ts,tsx,json,py}]
+[*.{js,jsx,mjs,cjs,ts,tsx,json}]
 indent_style = space
 indent_size = 2
@@ -0,0 +1,3 @@
 DROPBOX_APP_KEY=
 ONEDRIVE_CLIENT_ID=
 ONEDRIVE_AUTHORITY=https://
@@ -0,0 +1,73 @@
 name: Bug Report
 description: Fire a bug report
 title: "[Bug]: "
 labels: ["bug"]
 body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: What did you expect to happen?
      placeholder: Tell us what you see!
    validations:
      required: true
  - type: dropdown
    id: os
    attributes:
      label: What OS are you using?
      multiple: true
      options:
        - Windows
        - Linux
        - macOS
        - iOS (iPhone, iPad)
        - Android
    validations:
      required: true
  - type: dropdown
    id: service
    attributes:
      label: What remote cloud services are you using?
      multiple: true
      options:
        - S3
        - OneDrive for personal
        - Dropbox
        - webdav
        - others
    validations:
      required: true
  - type: input
    id: version-plugin
    attributes:
      label: Version of the plugin
      description: What version of the plugin are you running?
    validations:
      required: false
  - type: input
    id: version-obsidian
    attributes:
      label: Version of Obsidian
      description: What version of Obsidian are you running?
    validations:
      required: false
  - type: checkboxes
    id: using-password
    attributes:
      label: Using password or not
      description: Are you using password (end-to-end encryption) or not?
      options:
        - label: Yes.
          required: false
  - type: checkboxes
    id: ensure-no-sensitive-information
    attributes:
      label: Ensure no sensitive information
      description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
      options:
        - label: I ensure that no sensitive information is submitted in the issue.
          required: true
@@ -0,0 +1 @@
 blank_issues_enabled: false
@@ -0,0 +1,37 @@
 name: Feature Request
 description: Some idea about new features
 title: "[Feature Request]: "
 labels: ["enhancement"]
 body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: textarea
    id: what-are-you-expecting
    attributes:
      label: What feature are you suggesting?
      description: What feature are you suggesting?
    validations:
      required: true
  - type: dropdown
    id: service
    attributes:
      label: What remote cloud services are you using, or suggesting adding the feature to?
      multiple: true
      options:
        - S3
        - OneDrive for personal
        - Dropbox
        - webdav
        - others
    validations:
      required: false
  - type: checkboxes
    id: ensure-no-sensitive-information
    attributes:
      label: Ensure no sensitive information
      description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
      options:
        - label: I ensure that no sensitive information is submitted in the issue.
          required: true
@@ -5,7 +5,7 @@ name: BuildCI
 on:
  push:
-    branches: [master]
+    branches: ["**"]
  pull_request:
    branches: [master]
@@ -15,6 +15,11 @@ jobs:
    environment: env-for-buildci
    env:
      DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
      ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
      ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
    strategy:
      matrix:
        node-version: [16.x]
@@ -25,6 +30,7 @@ jobs:
        uses: actions/checkout@v2
        with:
          lfs: true
          submodules: recursive
      - name: Checkout LFS
        run: git lfs checkout
      - name: Use Node.js ${{ matrix.node-version }}
@@ -0,0 +1,86 @@
 # modified from https://github.com/argenos/nldates-obsidian/blob/master/.github/workflows/release.yml
 # which is released under MIT License
 # trigger:
 # modify manifest.json, package.json, versions.json
 # git tag <version number>
 # git push origin --tags
 name: Release A New Version
 on:
  push:
    tags:
      - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
 jobs:
  build:
    runs-on: ubuntu-latest
    environment: env-for-buildci
    env:
      DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
      ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
      ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
    strategy:
      matrix:
        node-version: [16.x]
    steps:
      - name: Checkout codes
        uses: actions/checkout@v2
        with:
          lfs: true
          submodules: recursive
      - name: Checkout LFS
        run: git lfs checkout
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v2
        with:
          node-version: ${{ matrix.node-version }}
      - run: npm install
      - run: npm test
      - run: npm run build
      - name: Create Release
        id: create_release
        uses: actions/create-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          VERSION: ${{ github.ref }}
        with:
          tag_name: ${{ github.ref }}
          release_name: ${{ github.ref }}
          draft: false
          prerelease: true
      - name: Upload main.js
        id: upload-main
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./main.js
          asset_name: main.js
          asset_content_type: text/javascript
      - name: Upload manifest.json
        id: upload-manifest
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./manifest.json
          asset_name: manifest.json
          asset_content_type: application/json
      - name: Upload styles.css
        id: upload-styles
        uses: actions/upload-release-asset@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ steps.create_release.outputs.upload_url }}
          asset_path: ./styles.css
          asset_name: styles.css
          asset_content_type: text/css
@@ -5,6 +5,7 @@
 # npm
 node_modules
 package-lock.json
 pnpm-lock.yaml
 # build
 main.js
@@ -1,2 +1,3 @@
 node_modules/
 main.js
 data.json
@@ -2,7 +2,9 @@
 This is yet another unofficial sync plugin for Obsidian. If you like it or find it useful, please consider give it a [star ![GitHub Repo stars](https://img.shields.io/github/stars/fyears/remotely-save?style=social)](https://github.com/fyears/remotely-save) on Github.
-[![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) [![Latest release: 0.2.6)](https://img.shields.io/github/downloads/fyears/remotely-save/0.2.6/main.js)](https://github.com/fyears/remotely-save/releases) [![Previous release: 0.2.5)](https://img.shields.io/github/downloads/fyears/remotely-save/0.2.5/main.js)](https://github.com/fyears/remotely-save/releases)
+[![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
 [![downloads of latest version](https://img.shields.io/github/downloads-pre/remotely-save/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases)
 ## Disclaimer
@@ -10,28 +12,33 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 ## !!!Caution!!!
-As of Jan 2022, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **ALWAYS, ALWAYS, backup your vault before using this plugin.**
+**ALWAYS, ALWAYS, backup your vault before using this plugin.**
 ## Features
 - Supports:
-  - Amazon S3 or S3-compatible
+  - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
  - Dropbox
-  - OneDrive
+  - OneDrive for personal
  - Webdav
- **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
+  - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
 - **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
 - **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
 - **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
 - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
 - \*\*Skip Large files and skip paths by custom regex conditions!
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
- **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
+- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**
 ## Limitations
- **Users have to trigger the sync manually.** This design is intentional because the plugin is in beta, and it's better for users to be exactly aware of the running of this plugin.
+- **To support deletions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
 - **"deletion" operation can only be triggered from local device.** It's because of the "[minimal intrusive design](./docs/minimal_intrusive_design.md)". May be changed in the future.
 - **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
- **Cloud services cost you money.** Always be aware of the costs and pricing.
+- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
- **All files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
 - **You should protect your `data.json` file.** The file contains sensitive information.
  - It's strongly advised **NOT** to share your `data.json` file to anyone.
  - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.
 ## Questions, Suggestions, Or Bugs
@@ -45,7 +52,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ## Download and Install
- Option #1: You can search, download, and install the plugin in official "community plugin list".
+- Option #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), then install the plugin.
 - Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
 - Option #3: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/fyears/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
 - Option #4: [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
@@ -54,56 +61,61 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ### S3
 - Tutorials / Examples:
  - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
  - [BackBlaze B2](./docs/remote_services/s3_backblaze_b2/README.md)
  - [腾讯云 COS Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
  - [MinIO](./docs/remote_services/s3_minio/README.md)
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
 - Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
 - Download and enable this plugin.
 - Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
- Click the new "switch" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (No "auto sync" yet.)
+- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
 - **Be patient while syncing.** Especially in the first-time sync.
 ### Dropbox
 - **This plugin's function for Dropbox is not as mature as functions for S3.**
 - **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
 - After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
+- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
-### OneDrive
+### OneDrive for personal
 - **This plugin's function for OneDrive is not as mature as functions for S3.**
 - **This plugin is NOT an official Microsoft / OneDrive product.** The plugin just uses Microsoft's [OneDrive's public API](https://docs.microsoft.com/en-us/onedrive/developer/rest-api).
 - This plugin only works for "OneDrive for personal", and not works for "OneDrive for Business" (yet). See [#11](https://github.com/fyears/remotely-save/issues/11) to further details.
 - After the authorization, the plugin can read your name and email, and read and write files in your OneDrive's `/Apps/remotely-save` folder.
 - If you decide to authorize this plugin to connect to OneDrive, please go to plugin's settings, and choose OneDrive then follow the instructions.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
 ### webdav
- **webdav support is considered experimental.**
+- Tutorials / Examples:
- Currently only supports BASIC authorization method.
+  - [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies.
+  - [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
-  - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin.
+  - [坚果云 JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
-  - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
 - Your data would be synced to a `${vaultName}` sub folder on your webdav server.
 - Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
-## Import And Export Not-Oauth2 Plugin Settings By QR Code
+## Scheduled Auto Sync
-It's often verbose / inconvenient to input not-oauth2 credentials on mobile. (On different desktop computers, it's trivial to copy and paste `data.json` across different devices.)
+- You can configure auto syncing every N minutes in settings.
 - In auto sync mode, if any error occurs, the plugin would **fail silently**.
 - Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
-So this plugin has a helper function to export those settings as a QR code, then you could use mobile device's camera to import the settings.
+## How To Deal With Hidden Files Or Folders
-Attention:
+**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
-1. Oauth2 - related information is omitted. It means that Dropbox, OneDrive login credentials are NOT included in the QR Code.
+In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
 2. Please, NEVER share the QR Code to others. It's as equivalent to the login credentials.
-Steps:
+## How To Debug
-1. Configure the plugin settings on one device, and make sure the sync functions work. (E.g, you could sync notes using S3 credentials.)
+See [here](./docs/how_to_debug/README.md) for more details.
-2. Open plugin settings page. Then scroll down the page, until the section "Import and Export Settings". Click the button "Get QR Code". A new modal should show up and you should see a QR code.
+
-3. On a second device, make sure the vault name is the same as the first device's.
+## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
-4. On that second device, use its camera app, or any apps that support scanning QR codes, to scan the QR code from the first device. (On latest iOS, the system's built in camera app should work. On Android, at least one open source app [Binary Eye](https://github.com/markusfisch/BinaryEye) is tested to be working.)
+
-5. A link / url / address should be identified in the scan-QR-code app, and you could follow the instruction in the app, and then you should be redirected to open the Obsidian app.
+See [here](./docs/import_export_some_settings.md) for more details.
 6. And finally, there should be a new notice in the Obsidian app saying the settings are successfully imported. Otherwise please check the error message in the notice.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:a9bf1cc2403c3a32e7a6f5d5829bb065573922dc050ae2fdb8b3d34b4c87ecf5
 size 8296
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:6990a598379c457442345e50c3f056c4598a121523bc10980835c08fc7447a54
 size 10119
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:432198e63fa9676541a41436917e025d1ea6af3772139c1dea450fcc0155cfd0
 size 13054
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fe3b5b8bf9c32e57c0af366c455b11ae68eb9fb8a32f371c9c445b3e7e89cc02
 size 1120
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:f68df7bae94eb4c4cddfa6af47d7819d01a6482d4f6afe6ef3236f72f9adf15f
 size 1523
@@ -0,0 +1 @@
 This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/
@@ -0,0 +1,75 @@
 # the logo
 Some different sizes' logos are needed.
 ## license
 <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
 ## the process of creation
 No professional designers are here. Thus the following steps involve many programer styles. :-)
 1. use excalidraw and export png and svg.
   ```bash
   # results
   logo.excalidraw
   logo.png
   logo.svg
   ```
 2. manually edit the `logo.svg` and make background transparent.
   ```bash
   # results
   logo-transparent.svg
   ```
 3. use python library [`svgutils`](https://github.com/btel/svg_utils) to make a strictly square figure. The [doc](https://svgutils.readthedocs.io/en/latest/tutorials/composing_multipanel_figures.html) is very useful.
   ```python
   from svgutils.compose import *
   def get_standard_300x300(file_name):
       fig = Figure(300, 300,
           Panel(
               SVG(file_name),
           ).move(-3, 12),
       )
       return fig
   get_standard_300x300('logo-transparent.svg').save('300x300.svg')
   # def get_other_size_from_standard(file_name, px):
   #     fig = Figure(px, px,
   #         Panel(
   #             SVG(file_name).scale(px/300.0),
   #         ).move(-3*px/300.0, 12*px/300.0),
   #     )
   #     return fig
   # get_other_size_from_standard('logo.svg',256).save('256x256.svg')
   ```
   ```bash
   # results
   300x300.svg
   ```
 4. use `inkscape` command line to get different sizes' `.png` files.
   ```bash
   inkscape 300x300.svg -o 300x300.png
   inkscape 300x300.svg -o 50x50.png -w 50 -h 50
   inkscape 300x300.svg -o 64x64.png -w 64 -h 64
   inkscape 300x300.svg -o 256x256.png -w 256 -h 256
   ```
   ```bash
   # results
   50x50.png
   64x64.png
   256x256.png
   ```
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:daedd262170200cb5e8cc288898b40892771b3962cf2bc17dc443f1c82a4aa94
 size 12886
@@ -0,0 +1,25 @@
 // Importing the http module
 const http = require("http");
 const requestHandler = (req, res) => {
  let body = [];
  req
    .on("data", (chunk) => {
      body.push(chunk);
    })
    .on("end", () => {
      const parsed = JSON.parse(Buffer.concat(body).toString());
      const prettyParsed = JSON.stringify(parsed, null, 2);
      console.log(prettyParsed);
      res.setHeader("Content-Type", "application/json");
      res.end(prettyParsed);
    });
 };
 const server = http.createServer(requestHandler);
 const addr = "0.0.0.0";
 const port = 3000;
 server.listen(port, addr, undefined, () => {
  console.log(`Server is Running on ${addr}:${port}`);
 });
@@ -0,0 +1,12 @@
 # Limitations From The Browser Environment
 Obsidian desktop is developed by using [Electron](https://www.electronjs.org/). And Obsidian mobile is developed by using [Capacitor](https://capacitorjs.com/)
 Technically, the plugin (or any plugin?) runs in the js environment provided by Obsidian. And to support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
 Then some limitations are applied:
 1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
 2. [No Node.js environment.](./browser_env_no_nodejs.md)
 3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
 4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)
@@ -0,0 +1,14 @@
 # Limitations From The Browser Environment: CORS Issue
 The plugin is developed for the browser environment. The "fake" browser behind the scenes also follows the CORS policy.
 [MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
 1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
 2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
   Example configurations:
   - [Amazon S3](./s3_cors_configure.md)
   - [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))
@@ -0,0 +1,3 @@
 # Limitations From The Browser Environment: No Background Running After Obsidian Is Closed
 The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.
@@ -0,0 +1,9 @@
 # Limitations From The Browser Environment: No Node.js
 To support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
 Many js libraries are designed to work in both the browser and the Node.js environments. But some are not, because the browser doesn't provide the corresponding abilities.
 For example, there is a popular npm package [`ssh2-sftp-client`](https://www.npmjs.com/package/ssh2-sftp-client) for SFTP. But it relies on the modules (e.g. `http`) from Node.js which cannot be "translated" to the browser environment. So it's impossible to make this plugin support SFTP. The same status applies to FTP / FTPS.
 Likewise, [MEGA](https://mega.nz/) provides a SDK, but the SDK is [for C++ only](https://mega.nz/doc), so it's also impossible to make this plugin support MEGA.
@@ -0,0 +1,7 @@
 # Limitations From The Browser Environment: OAuth2 PKCE
 If the cloud service uses OAuth flow, it needs to support PKCE, because the plugin is released to the public, and no real secrets can be statically kept in the client.
 Luckily, Dropbox and OneDrive supports PKCE, making it possible for this plugin to connect to them easily.
 Dropbox has an excellent [article](https://dropbox.tech/developers/pkce--what-and-why-) explaining what is and how to use PKCE.
@@ -0,0 +1,47 @@
 ## Material Source
 To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
 ## Some Backgrounds
 1. Obsidian allows users to take notes using markdown files.
 2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
 3. Technically, remotely-save is developed using web technologies.
 ## Api Usages
 1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
 2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
 3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
 4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
 ## Steps
 Here are the steps to see the functionality of remotely-save.
 Most steps have screenshots.
 1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
 2. Open Obsidian, click the "Create" button under "Create new vault".
 3. Pick a vault name, "example-vault", and choose a location, then click "Create".
   ![step03](./attachments/step03.png)
 4. Close any update new if prompted.
 5. Create a new note by clicking a button on the left. And write something on the note.
   ![step05](./attachments/step05.png)
 6. Click "setting" (a gear icon) on the button left of the sidebar.
   ![step06](./attachments/step06.png)
 7. In the settings panel, go to the "Community plugins" page, turn off the safe mode, and confirm to turn off the safe mode. Then click the "Browse" button for community plugins.
   ![step07](./attachments/step07.png)
 8. Search "Remotely Save" and install on the result.
   ![step08](./attachments/step08.png)
 9. After successful installing the plugin, go back to the "Community plugins" page, and enable the plugin.
   ![step09](./attachments/step09.png)
 10. Go to newly added "Remotely Save" settings, select "Dropbox" in "Choose service", and click the "Auth" button.
    ![step10](./attachments/step10.png)
 11. The standard auth flow address is shown, users should click the address, and finish the auth steps on the website. Finally, the Dropbox website should automatically redirect users back to the Obsidian app.
    ![step11](./attachments/step11.png)
 12. The "Auth" button disappears. A new "Revoke Auth" appears.
    ![step12](./attachments/step12.png)
 13. Go back to the main interface of Obsidian, a new "switch icon" should appear on the left sidebar. Click this, then the plugin would trigger the sync progress. It would compare meta info of local files and remote files (on Dropbox), and decide to download some files and/or upload some files.
    ![step13](./attachments/step13.png)
 14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:655f6f487cc24af0ab86b8592622a7701c30f3369e7847a1fbb783d0962829c3
 size 52910
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fe971af94f1f7b042b7313268e4d2d8432d926ce2392e50ca2a4abc21c8a4aab
 size 57033
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:025303053f2b2cedd2bdd61cd71e1f1c0fb12e45bfbc0e81f2c0d70747133505
 size 63458
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:061707977c8046a6f924881f86aac962e2f05618e201080768246270de792040
 size 100162
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:8add61e6ef34b2470e5a5bea3e10955a86eed5ed1fc4dd398f30835485a6c455
 size 158422
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:021ae1ce29d3932f088f0954787c475be826915b794320bf212d3ba7d58656da
 size 110529
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:b225d21de5778ddc032893e0f52150ab4260b0dfbe0e9141da4aa8b03131a9da
 size 147821
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fda4f6e8cf68833f239bdc85c46802fe2131d149011074f747b1829822a38939
 size 59041
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:576801d5ebd8cf7fcd3c9c0c6df325654338854f7d762a5680e9aab3c9e6508a
 size 142155
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:1c93f681f0f7ce74cee0f2ed193f574ef915554f1a9ef96ba54afdede302f13a
 size 112057
@@ -0,0 +1,19 @@
 # How To Debug
 Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
 ## Easy: Export Sync Plans
 See [here](./export_sync_plans.md).
 ## Advanced: Check Console Output Directly
 ...of desktop and Android.
 See [here](./check_console_output.md).
 ## Advanced: Save Console Output Then Read Them Later
 This method works for desktop and mobile devices (iOS, Android).
 See [here](./save_console_output_and_export.md).
@@ -0,0 +1,23 @@
 # Check Console Output
 If you are using Obsidian on desktop or Android, you can check the Obsidian console.
 ## Disable Auto Sync Firstly
 You should disable auto sync to avoid any unexpected running.
 ## Set The Output Level To Debug
 Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
 ## Check The Output
 - If you are on desktop
  Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
 - If you are using Android
  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
 Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.
@@ -0,0 +1,95 @@
 # Export Sync Plans
 ## What's this?
 Everytime the plugin starts a sync, it gathers all required information together, generates a "sync plan" of every operations to every files and folders, and assign the corresponding actual operations.
 Thus, if something goes wrong, we should check the sync plan firstly.
 ## How To Export The Plans?
 Please read through the following instructions.
 ### Disable Auto Sync Firstly
 You should disable auto sync to avoid any unexpected running.
 ### Manual Sync If Not Yet
 You should at least sync once, so that at least one sync plan is generated and saved. If you have synced the vualt before, there should be some sync plans already saved.
 ### Export To The File
 Go to the plugin settings, scroll down to the section "Debug" -> "export sync plans", and click the button "Export". \*\*It would generate a new folder `_debug_remotely_save/` in your vault, and generate a file `sync_plans_hist_exported_on_{a_timestamp},md.` inside that folder.
 ## How To Read The Plans
 Open the genrated `sync_plans_hist_exported_on_{a_timestamp},md.`. You should see a json, or multiple jsons. Every json represents a sync plan.
 A sync plan looks like this:
 ```json
 {
  "ts": 1646960867560,
  "remoteType": "onedrive",
  "mixedStates": {
    "abc.md": {
      "key": "abc.md",
      "existRemote": true,
      "mtimeRemote": 1646566632000,
      "sizeRemote": 56797,
      "remoteEncryptedKey": "abc.md",
      "changeMtimeUsingMapping": true,
      "existLocal": true,
      "mtimeLocal": 1646566632000,
      "sizeLocal": 56797,
      "decision": "skipUploading",
      "decisionBranch": 1
    },
    "New folder/": {
      "key": "New folder/",
      "deltimeRemote": 1646925354372,
      "existLocal": false,
      "existRemote": false,
      "decision": "keepRemoteDelHistFolder",
      "decisionBranch": 9
    }
  }
 }
 ```
 We usually care about the `mixedStates` property. As you may guess, every item in `mixedStates` represent a file or a folder.
 We should find out the file/folder we are interested in (or we believe something goes wrong), then checkout the following properties:
 ```
 decision
  What decision is made.
 decisionBranch
  It's a mark of the actual logic in the sync code. Useful to debug.
 existRemote
  Does the file/folder exist on the remote service?
 mtimeRemote
  The "last modeified time" on the remote service.
 deltimeRemote
  The "deletion time" on the remote record.
 existLocal
  Does the file/folder exist locally?
 mtimeLocal
  The max of "last modeified time" and "creation time" locally.
 deltimeLocal
  The "deletion time" locally.
 ```
 The `decision` SHOULD be determined by the modified times and deletion times, by the logic described in [the doc of sync alogorithm](../sync_algorithm_v2.md). In short, we collect four timestamps (`mtimeRemote`, `deltimeRemote`, `mtimeLocal`, `deltimeLocal`), and respect the max timestamp and its corresponding operation.
 ## Common Issues
 Some users report that their "last modeified time"s or "creation time"s are not set correctly by the operating system. In this case, the plugin cannot do anything because it determines the sync plan by comparing the timestamps. It's suggested to check the settings of the operating system or check whether other programs are doing something to the files.
@@ -0,0 +1,25 @@
 # Save Console Output And Read Them Later
 ## Disable Auto Sync Firstly
 You should disable auto sync to avoid any unexpected running.
 ## Set The Output Level To Debug
 Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
 ## Enable Saving The Output To DB
 Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
 ## Run The Sync
 Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
 ## Export The Output And Read The Logs
 Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
 ## Disable Saving The Output To DB
 After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".
@@ -0,0 +1,19 @@
 ## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
 It's often verbose / inconvenient to input not-oauth2 credentials on mobile. (On different desktop computers, it's trivial to copy and paste `data.json` across different devices.)
 So this plugin has a helper function to export those settings as a QR code, then you could use mobile device's camera to import the settings.
 Attention:
 1. Oauth2 - related information is omitted. It means that Dropbox, OneDrive login credentials are NOT included in the QR Code.
 2. Please, NEVER share the QR Code to others. It's as equivalent to the login credentials.
 Steps:
 1. Configure the plugin settings on one device, and make sure the sync functions work. (E.g, you could sync notes using S3 credentials.)
 2. Open plugin settings page. Then scroll down the page, until the section "Import and Export Settings". Click the button "Get QR Code". A new modal should show up and you should see a QR code.
 3. On a second device, make sure the vault name is the same as the first device's.
 4. On that second device, use its camera app, or any apps that support scanning QR codes, to scan the QR code from the first device. (On latest iOS, the system's built in camera app should work. On Android, at least one open source app [Binary Eye](https://github.com/markusfisch/BinaryEye) is tested to be working.)
 5. A link / url / address should be identified in the scan-QR-code app, and you could follow the instruction in the app, and then you should be redirected to open the Obsidian app.
 6. And finally, there should be a new notice in the Obsidian app saying the settings are successfully imported. Otherwise please check the error message in the notice.
@@ -1,36 +1,21 @@
 # Minimal Intrusive Design
-The plugin tries to avoid saving additional meta data remotely.
+Before version 0.3.0, the plugin did not upload additional meta data to the remote.
 From and after version 0.3.0, the plugin just upload minimal extra necessary meta data to the remote.
 ## Benefits
-Then the plugin doesn't make any assumptions about information on the remote endpoint.
+Then the plugin doesn't make more-than-necessary assumptions about information on the remote endpoint.
 For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.
 And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
-## Flaws
+## Necessarity Of Uploading Extra Metadata
 The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
-Consider this:
+If we don't upload any extra info to the remote, there's usually no way for the second device to know what files / folders have been deleted on the first device.
-1. The user create and sync a file to the cloud on the 1st device.
+To overcome this issue, from and after version 0.3.0, the plugin uploads extra metadata files `_remotely-save-metadata-on-remote.{json,bin}` to users' configured cloud services. Those files contain some info about what has been deleted on the first device, so that the second device can read the list to apply the deletions to itself. Some other necessary meta info would also be written into the extra files.
 2. Then download this file to the 2nd device.
 3. And then delete this file on the 1st device.
 4. And sync on the 1st device. The file on the cloud is also deleted.
 5. And sync on the 2nd device. **The 2nd device would upload the file again to the cloud.**
 In step 4, the file is marked "deleted" on the 1st device, and the 1st device send the command "delete this file on the cloud" to the cloud sevice (e.g. s3). Then the file on the cloud is also deleted. So far so good.
 But, in step 5, because no meta data are saved on the cloud, the 2nd device doesn't know that the file are deleted. Instead, it thinks "the file was not synced to the cloud last time, so it's uploaded this time". So an unintentional upload occurs.
 Currently no way to fix this if no meta data are saved remotely. The only workarounds are:
 1. Delete the file on the 1st device, **before** syncing it to the cloud. Then the file never show up on the cloud or on the 2nd device.
 2. Or, manually delete the file on 2nd device **before** step 5 in above situation.
 ## Future
 This design may be changed in the feature, considering the flaws described above.
@@ -0,0 +1,53 @@
 # Backblaze B2
 ## Links
 https://www.backblaze.com/cloud-storage
 ## Steps
 1. Create a Backblaze account [on this page](https://www.backblaze.com/cloud-storage). Credit card info _is not_ required. Backblaze B2 offers 10 GB of free storage.
 2. Please be aware that, though B2 provides some free quota, **it may still cost you money if the usage of storage or api requests exceed a certain value!!!** Especially pay attention to the api requests!!!
 3. Create a **bucket**, you can leave the default settings, or you can enable the encryption (which is different from what you can set in Remotely Save):
   ![](./s3_backblaze_b2-1-bucket.png)
   ![](./s3_backblaze_b2-2-create_bucket.png)
 4. Copy `Endpoint`, eg. `s3.us-east-005.backblazeb2.com` — it'll be used later.
 5. Copy `bucketname` near the 🪣 icon (the "bucket icon") — it'll be used later.
   ![](./s3_backblaze_b2-3-copy.png)
 6. Go to **Application Keys**:
   ![](./s3_backblaze_b2-4-app_keys.png)
 7. **Add a new key**:
   ![](./s3_backblaze_b2-5-add_new_app_keys.png)
   ![](./s3_backblaze_b2-6-app_keys_copy.png)
 8. Save `keyID` and `applicationKey` — they will be used later.
 9. Go to Remotely Save settings in Obsidian and:
   - Choose `S3 or compatibile` in **Remote Service**:
   - Copy `Endpoint` from Backblaze (see 3. above) to `Endpoint` in Remotely Save
   - From `endpoint` take `region` (eg. `us-east-005`) and paste it in `endpoint` in Remotely Save
   - Copy `keyID` (see 7. above) to `Access Key ID` in Remotely Save
   - Copy `applicationKey` (see 7. above) to `Secret Access Key` in Remotely Save
   - Copy `bucketname` (see 4. above) to `Bucket Name` in Remotely Save
     ![](./s3_backblaze_b2-7-copy_paste.png)
 10. **Enable Bypass CORS**:
    ![](./s3_backblaze_b2-8-cors.png)
 11. Click **Check** in _Check Connectivity_ to see if you can connect to B2 bucket:
    ![](./s3_backblaze_b2-9-check_connectionpng.png)
 12. Sync!
    ![](./s3_backblaze_b2-10-sync.png)
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fae18a84bb218461aca01c7de47ddadfd2b451d865ec889c098cd6918f6e8773
 size 59679
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:9389f9c4462740371edb548f7e05191ede5277a5d470e3254c60fbcc4a75e552
 size 4558
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:46f35968938ebf3bbafae64ee49a4927844fd0abf79e4190522be91776d9fed0
 size 107623
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:7fb639c7b4e595516594ee9d07c864e7cd15b608a97c81386f4cf72d499d0e5f
 size 80121
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:299bfca82b77de86f60d8f481b5f74069dc977dece19fa025ee629d1e6f783d4
 size 6499
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:5985e918b521c91cc185f60c58cdd334ee76695b897a02e02eaa17c1bad71609
 size 10214
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:5796791bcf89c99c1e1e844c0083739fd46b1a458dc274f3c3fa3f65b87b71b3
 size 70728
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:3633379fcb12f1a5e0a4d1d68c193ddc7bf0be7edd92f2f6006351817035a94f
 size 27164
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:9e130be182ae7d3270e5de3fec442ac5e81efd61822e844cd61ed24c7e485d39
 size 16802
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:29a8971fea065fd86223850198640f4072ee3fda2112820829cda1348f122c59
 size 11103
@@ -0,0 +1,27 @@
 # Cloudflare R2
 ## Links
 <https://www.cloudflare.com/developer-platform/r2/>
 ## Steps
 1. **Be aware that it may cost you money.**
 2. Create a Cloudflare account and enable R2 feature. **Credit card info might be required by Cloudflare**, though Cloudflare provides generous free tier and zero egress fee.
 3. Create a bucket.
   ![](./s3_cloudflare_r2_create_bucket.png)
 4. Create an Access Key with "Object Read & Write" permission, and add specify to your created bucket. During the creation, you will also get the auto-generated secret key, and the endpoint address.
   ![](./s3_cloudflare_r2_create_api_token.png)
 5. In remotely-save setting page, input the address / bucket / access key / secret key. **Region being set to `us-east-1` is sufficient.** Enable "Bypass CORS", because usually that's what you want.
   Click "check connectivity". (If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.)
   ![](./s3_cloudflare_r2_rs_settings.png)
 6. Sync!
 ## And Issue Related To "Check Connectivity"
 If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.
 Cloudflare doesn't allow `HeadBucket` for access keys with "Object Read & Write". So it may be possible that checking connectivity is not ok but actual syncing is ok. New version >= 0.3.29 of the plugin fix this problem by using `ListObjects` instead of `HeadBucket`.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:49a5cd07e538205ba733dc3ccb30e4e7da1290a4a80aefe08afac19fd2db2232
 size 467448
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:61fc0812fe96871eed507d2f6b7bbad790ab70e95ff5fe764f8f8b2ab8ce82c2
 size 153015
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:02f9c0fea36679e54c8c3fac979bc41d15ae4f7992b269bc2b67255059af1d2f
 size 579889
@@ -0,0 +1,33 @@
 # How To Configure S3 CORS Rules
 If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
 Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
 Please try this config:
 ```json
 [
  {
    "AllowedHeaders": ["*"],
    "AllowedMethods": ["GET", "PUT", "POST", "DELETE", "HEAD"],
    "AllowedOrigins": [
      "app://obsidian.md",
      "capacitor://localhost",
      "http://localhost"
    ],
    "ExposeHeaders": [
      "Content-Length",
      "Content-Type",
      "Connection",
      "Date",
      "ETag",
      "Server",
      "x-amz-delete-marker",
      "x-amz-id-2",
      "x-amz-request-id",
      "x-amz-version-id"
    ]
  }
 ]
 ```
@@ -0,0 +1,83 @@
 # AWS S3 Bucket: How to configure user's policy
 ## Attention
 Please read the doc carefully and adjust the optional fields accordingly. The doc is not fully tested and contributions are welcome.
 ## AWS Official Docs
 - <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html>
 - <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html>
 - <https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html>
 ## Prerequisites
 Using the principle of least privilege is crucial for security when allowing a third party system to access your AWS resources.
 **Prerequisites**: Ensure you have an AWS account and administrative access to manage IAM policies.
 ## Step 1: Create a new IAM Policy
 1. Log in to your AWS Management Console.
 1. Navigate to the IAM Policies section.
 1. Create a new policy with the following configuration.
 **Note**: `my-bucket` is a placeholder. For example, if your bucket's name is `obsidian-data`, the resource line should read `arn:aws:s3:::obsidian-data`.
 ```JSON
 {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ObsidianBucket",
            "Effect": "Allow",
            "Action": [
                "s3:HeadBucket"
            ],
            "Resource": "arn:aws:s3:::my-bucket"
        },
        {
            "Sid": "ObsidianObjects",
            "Effect": "Allow",
            "Action": [
                "s3:HeadObject",
                "s3:PutObject",
                "s3:CopyObject",
                "s3:UploadPart",
                "s3:UploadPartCopy",
                "s3:ListMultipartUploads",
                "s3:AbortMultipartUpload",
                "s3:CompleteMultipartUpload",
                "s3:ListObjects",
                "s3:ListObjectsV2",
                "s3:ListParts",
                "s3:GetObject",
                "s3:GetObjectAttributes",
                "s3:DeleteObject",
                "s3:DeleteObjects"
            ],
            "Resource": "arn:aws:s3:::my-bucket/*"
        }
    ]
 }
 ```
 > The policy allows the Obsidian plugin to list, add, retrieve, and delete objects in the specified S3 bucket.
 ## Step 2: Attach the Policy to Obsidian user
 1. Create a new user in the IAM console. (Never use your own root user, as it would have full access to your AWS account).
 1. When creating the user, select "Attach policy directly" and select the policy created.
 1. Edit the recent created user and go to "Security Credentials" tab to create your access key.
 1. Create an Access Key. If asked for a "use case", select "other"
 1. Use the credentials in the plugin settings. (NEVER share these credentials)
 > PS. The bucket doesn't need to have a policy, only the user.
 ## Verifying the Policy
 After attaching the policy, test it by trying to access the S3 bucket through the Obsidian plugin. Ensure that all intended actions can be performed without errors.
 ## Troubleshooting
 If you encounter permission errors, check the policy for typos in the bucket name or actions. Ensure the policy is attached to the correct user.
@@ -0,0 +1,27 @@
 # MinIO
 ## Links
 <https://min.io/>
 ## Steps
 1. Configure your minio instance and get an account.
 2. Create an Access Key (during the creation, you will also get the auto-generated secret key).
   ![](./minio_access_key.png)
 3. Check or set the region.
   ![](./minio_region.png)
 4. Create a bucket.
   ![](./minio_create_bucket.png)
 5. In remotely-save setting page, input the address / bucket / access key / secret key. **Usually minio instances may need "S3 URL style"="Path Style".** Enable "Bypass CORS", because usually that's what you want.
   ![](./minio_rs_settings.png)
 6. Sync!
   ![](./minio_sync_success.png)
 ## Ports In Address
 Just type in the full address with `http(s)://` and `:port` in remotely-save settings, for example `http://192.168.31.198:9000`.
 It's verified that everything is ok.
 ![](./minio_custom_port.png)
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:c384ec32a43fcac1e63dbc81d4fbb7fbfaffcd67d0f5a66104482a39475ad639
 size 323050
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:894a6a10b7f41754936d77a935b4a5a4ae722796fa5680c9c6d0dd53c3cdc1a2
 size 269705
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:b25c1209875ad781a29d3ac1cde5bd9c2137622e3919987c4d4e5f77dc8e3ec7
 size 68997
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:bfcc526281d2c6a9f1261f489603f3dd768f8b94f099a1b26649fa37c9318575
 size 315030
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:83615a6c2fbf7ff74679b480d29d222db8835bc067aee33a646e4b8d500c3aca
 size 467575
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fd1bb9a6e285a1e63b545d714ca269eb714e980a5177392b967556f1f1754afe
 size 147218
@@ -0,0 +1,22 @@
 # 腾讯云 COS Tencent Cloud COS
 ## 链接 Link
 - 中国区 <https://console.cloud.tencent.com/cos>
 - international <https://console.tencentcloud.com/cos>
 ## 步骤 Steps
 注意这里用中国区示例，国际区配置应该类似。The example shows the steps of China version. International version should be similar.
 1. 在“存储桶列表”页，[“创建存储桶”](https://console.cloud.tencent.com/cos/bucket?action=create)。注意创建**私有读写**，建议打开服务端加密。Create a bucket with **private read-write permissions** and recommendly enable server-side-encryption.
 2. 在桶列表页，点击刚刚存储的桶，进入概览页。可以见到桶名称（一般来说是之前指定的英文加账号数字），地域，访问域名。记录下来。In bucket list page, enter the bucket overview page of the bucket you just created. You should see the bucket name (your texts with the number of your account id), region, and access address.
   ![](./cos_bucket_info.png)
 3. 在[“访问管理页”](https://console.cloud.tencent.com/cam/capi) ，“API 密钥管理”，“创建密钥”，要记录 SecretID 和 SecretKey。In CAM page, create api key, and note down the SecretID and SecretKey.
   ![](./cos_create_secret.png)
 4. **把桶名称从访问域名移除，才是你即将输入的服务地址！假如你在腾讯云网站看到访问域名是 `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`，那么“服务地址”是 `https://cos.<region>.myqcloud.com`. Remove the bucket name from your access address to obtain your endpoint address! If your access address on the website is `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`, then the endpoint address you are going to use is `https://cos.<region>.myqcloud.com`.**
 5. 在 remotely-save 设置，输入服务地址，SecretID，SecretKey，和 桶名称。In remotely-save settings page, enter your endpoint adress, SecretID, SecretKey,and bucket name.
   ![](./cos_setting.png)
 6. 检查连接。Check Connectivity.
   ![](./cos_connection.png)
 7. 可以同步了！Sync!
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:08b47288686c8ef8c6426776f7df52411efe431966e8f7f2f9a3a8836ee4d6c6
 size 323127
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:94c0ec5db7a75c54c36224f067659682e271aea2e61b1ee50d046cd493ba72ac
 size 58410
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:f51f542756def80a77404e47f9793d1cd6917df5ab6e09d5a0ee1f7191855dc6
 size 425021
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:55064233031b44066fb7b77e17ba1eb1d0ae8398235a343cc7e137b07aaf7a39
 size 668954
@@ -0,0 +1,22 @@
 # AList
 ## 链接 Links
 - English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
 - 中文官网：<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
 ## 步骤 Steps
 1. 安装和使用 AList。获取账号名和密码。在网页上登录。Install and run AList. Get the account and password. Login using the web page.
 2. 新建挂载，检查挂载路径。如图所示是 `/alisttest davpath`。Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
   ![](./alist_mount_path.zh.png)
   ![](./alist_mount_path.en.png)
 3. 从而构建 webdav 网址如下，**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**，其中挂载路径中假如有空格，换成 `%20`：Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
   ```
   http[s]://domain:port/dav/[mountpath url encoded]
   http://127.0.0.1:5244/dav/alisttest%20davpath
   ```
 4. 在 remotely-save 设置，输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
   ![](./alist_rs_settings.en.png)
 5. 在 remotely-save 设置，检查连接。In remotely-save setting page, click "Check Connectivity".
 6. 同步文件！Sync!
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:ea05f67782b8f84518f13cf5587df719bdaa15f9e35b79f2801f91e695de6480
 size 46798
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:dcaaa5e64e894f0e9c8b0242b64bf4dd364c16d7314b09bc004f7ed0a0f1e0e5
 size 60853
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:0b792320e2a4aaa16a17d82e80225ab35da05fd1f407fe067de72651beca088e
 size 426289
@@ -0,0 +1,10 @@
 If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
 If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
 - The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
 - Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
  - **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
  - **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
 - [Apache is also possible](./webdav_apache_cors.md).
 - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
@@ -0,0 +1,25 @@
 # How To Configure Apache CORS Rules for Webdav
 This method is [contributed by community](https://github.com/remotely-save/remotely-save/pull/31).
 You should evaluate the risk by yourself before trying this method.
 **You are strongly advised to backup your original Apache configuration files before making any changes.**
 ```apacheconf
 <IfModule mod_headers.c>
  # Obsidian webdav
  SetEnvIf Origin "^app://obsidian.md$" IS_OBSIDIAN
  SetEnvIf Origin "^capacitor://localhost$" IS_OBSIDIAN
  SetEnvIf Origin "^http://localhost$" IS_OBSIDIAN
  Header always set Access-Control-Allow-Origin "*" env=IS_OBSIDIAN
  Header always set Access-Control-Allow-Methods "GET, HEAD, POST, PUT, OPTIONS, MOVE, DELETE, COPY, LOCK, UNLOCK, PROPFIND" env=IS_OBSIDIAN
  Header always set Access-Control-Allow-Headers "Authorization, Depth, DNT, User-Agent, Keep-Alive, Content-Type, accept, origin, X-Requested-With" env=IS_OBSIDIAN
  Header always set Access-Control-Expose-Headers "etag, dav" env=IS_OBSIDIAN
  # Allow OPTION request without authentication and respond with status 200
  RewriteCond %{ENV:IS_OBSIDIAN} 1
  RewriteCond %{REQUEST_METHOD} OPTIONS
  RewriteRule ^(.*)$ $1 [R=200,L]
 </IfModule>
 ```
@@ -0,0 +1,15 @@
 # InfiniCLOUD (formally TeraCLOUD) Webdav
 ## Link
 <https://infini-cloud.net/en/>
 ## Steps
 1. Register an acount.
 2. Go to <https://infini-cloud.net/en/modules/mypage/usage/>, in section "Apps Connection", enable "Turn on Apps Connection". Here you get the address and account and webdav password (different from your account password):
   ![](./infinicloud_account.png)
 3. In remotely-save setting page, select webdav type, then input the address/account/**webdav password**(not your account password).
   ![](./infinicloud_rs_setting.png)
 4. In remotely-save setting page, click "Check Connectivity".
 5. Sync!
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:0e16bc9d86b30ab907fc176087701474f4ca2b8d887f649302f2e184f69d0cbc
 size 373845
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:8d707f6997df57b9c6b74d72bcfd567995d15062269761ee404e6596a266a241
 size 91012
@@ -0,0 +1,22 @@
 # 坚果云 JianGuoYun/NutStore
 ## 链接 Link
 <https://www.jianguoyun.com/>
 ## 注意！！！Attentions!!!
 坚果云有限制 api 数量等设定。本插件会产生若干查询，如果文件较多很容易触发 api 上限，从而工作不正常。这不是插件 bug，也没有办法解决。
 JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
 ## 步骤 Steps
 1. **知悉坚果云有 api 限制，本插件可能因此工作不正常。Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
 2. 注册账号，登录。Register an account.
 3. 去“个人信息”->“安全”，“添加应用”，从而获取了 webDAV 账号（应该是 email）和 WebDAV 密码（一串特殊的字符，不等于网站密码）。Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
   ![](./webdav_jianguoyun.cn.png)
 4. 在 remotely-save 设置，输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
   ![](./webdav_jianguoyun_rs_settting.cn.png)
 5. 在 remotely-save 设置，检查连接。In remotely-save setting page, click "Check Connectivity".
 6. 同步文件！Sync!
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fd5aaab1e1ac0ea8996517c819bf5ac0d2a828483037419ba289b538957f4752
 size 515913
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:112778176af954e16c93c582d968e7c14e5b950d64facce8593855f5fb75fbcc
 size 431527
@@ -0,0 +1,17 @@
 # ownCloud Webdav
 ## Link
 <https://owncloud.com/>
 # Steps
 1. Create an account.
 2. Login.
 3. In the Settings position, enable the "Show hidden files" and find out the WebDAV address.
   ![](./owncloud_address.png)
 4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
   ![](./owncloud_rs_settings.png)
 5. In remotely-save setting page, click "Check Connectivity".
 6. Sync!
   ![](./owncloud_files.png)
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:e0d025b4ccf1be7fa2cc74e914e9a1a89a8d8f12a1b917bd4b26b975bf208294
 size 27796
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:b3d24d416016b2676a86166fcc35fa89f8befb7a872503b8da2be4374ef360ce
 size 53503
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:2e8bf9a51e5d5bed66fb45fe085f37943bd90a51b33ef752d898c5b2caa71c2d
 size 448797
@@ -0,0 +1,42 @@
 # services connectability
 Here is an overview of the connectability ("connectable" or "not connectable" or "in the plan" or "never") to some services by this plugin.
 The plugin works under the browser environment in Obsidian, so CORS is an issue. Obsidian starts to provide a rich API `requestUrl` for desktop version >= 0.13.25, mobile >= 1.1.1 to bypass the CORS issue. But if the users are still using an older version of Obsidian, they need to configure CORS on server.
 The list is for information purposes only.
 | Service                                                                               | Connectable | by S3 | by WebDAV | by other protocol                                                | can bypass CORS issue in latest Obsidian | need CORS config in old Obsidian                 |
 | ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ---------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------ |
 | Amazon S3                                                                             | Yes         | Yes   |           |                                                                  | Yes                                      | [CORS config needed.](./s3_cors_configure.md)    |
 | Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
 | Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
 | Backblaze B2 Cloud Storage                                                            | Yes         | Yes   |           |                                                                  | Yes                                      | Its CORS rules doesn't allow no-http(s) origins. |
 | [Wasabi](https://wasabi.com)                                                          | ?           | ?     |           |                                                                  |                                          |                                                  |
 | [filebase](https://filebase.com/)                                                     | Yes         | Yes   |           |                                                                  | Yes                                      | CORS config needed.                              |
 | QingStor 青云                                                                         | ?           | ?     |           |                                                                  |                                          |                                                  |
 | [MinIO](https://min.io/)                                                              | ?           | ?     |           |                                                                  |                                          |                                                  |
 | [WsgiDAV](https://github.com/mar10/wsgidav)                                           | Yes         |       | Yes       |                                                                  | Yes                                      | CORS rules can be set.                           |
 | [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | Yes?        |       | Yes?      |                                                                  | Yes?                                     | ?                                                |
 | NextCloud                                                                             | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
 | OwnCloud                                                                              | Yes?        |       | Yes?      |                                                                  | Yes?                                     | No CORS config by default.                       |
 | Seafile                                                                               | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
 | `rclone serve webdav`                                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
 | [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
 | [TeraCLOUD](https://teracloud.jp/en/)                                                 | Yes         |       | Yes       |                                                                  | Yes                                      | No CORS support.                                 |
 | Dropbox                                                                               | Yes         |       |           | Yes                                                              |                                          |                                                  |
 | OneDrive for personal                                                                 | Yes         |       |           | Yes                                                              |                                          |                                                  |
 | OneDrive for Business                                                                 | Yes         |       |           | ?                                                                |                                          |                                                  |
 | Google Drive                                                                          | In the plan |       |           | ?                                                                |                                          |                                                  |
 | [Box](https://www.box.com/)                                                           | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
 | Google Cloud Storage                                                                  | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
 | Microsoft Azure Blob Storage                                                          | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
 | [OpenStack Storage (Swift)](https://github.com/openstack/swift)                       | ?           |       |           | May be possible but needs further development.                   |                                          |                                                  |
 | https://put.io/                                                                       | ?           |       |           | ?                                                                |                                          |                                                  |
 | Yandex Disk                                                                           | ?           |       |           | ?                                                                |                                          |                                                  |
 | FTP / FTPS                                                                            | Never       |       |           | Technically never possible to be implemented.                    |                                          |                                                  |
 | SFTP                                                                                  | Never       |       |           | Technically never possible to be implemented.                    |                                          |                                                  |
 | Jottacloud                                                                            | No          |       |           | No. It seems that no open api is available.                      |                                          |                                                  |
 | Mega                                                                                  | Never       |       |           | No. No js api is available.                                      |                                          |                                                  |
 | Git                                                                                   | Never       |       |           | No. Technically very hard, if not impossible, to be implemented. |                                          |                                                  |
 |                                                                                       |             |       |           |                                                                  |                                          |                                                  |
@@ -4,9 +4,9 @@
 We have three record sources:
-1. Local files
+1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
-2. Remote files
+2. Remote files. By scanning all files on the remote service. Some services provide an api directly returning this, and some other services require the plugin scanning the folders recursively.
-3. Local "delete-or-rename" history.
+3. Local "delete-or-rename" history. It's recorded by using Obsidian's tracking api. So if users delete or rename files/folders outside Obsidian, we could do nothing.
 Assuming all sources are reliable.
@@ -0,0 +1,63 @@
 # Sync Algorithm V2
 ## Sources
 We have 4 record sources:
 1. Local files. By scanning all files in the vault locally. Actually Obsidian provides an api directly returning this.
 2. Remote files. By scanning all files on the remote service. Some services provide an api directly returning this, and some other services require the plugin scanning the folders recursively.
 3. Local "delete-or-rename" history. It's recorded by using Obsidian's tracking api. So if users delete or rename files/folders outside Obsidian, we could do nothing.
 4. Remote "delete" history. It's uploaded by the plugin in each sync.
 Assuming all sources are reliable.
 ## Deal with them
 We list all combinations mutually exclusive and collectively exhaustive.
 ### Files
 In short, we collect four timestamps, and respect the max timestamp and its corresponding operation.
 | t1             | t2             | t3             | t4             | local file to do | remote file to do | local del history to do | remote del history to do | equal to sync v2 branch |
 | -------------- | -------------- | -------------- | -------------- | ---------------- | ----------------- | ----------------------- | ------------------------ | ----------------------- |
 | mtime_remote   | mtime_local    | deltime_remote | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
 | mtime_local    | mtime_remote   | deltime_remote | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
 | mtime_remote   | deltime_remote | mtime_local    | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
 | deltime_remote | mtime_remote   | mtime_local    | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
 | mtime_local    | deltime_remote | mtime_remote   | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history |                         |
 | deltime_remote | mtime_local    | mtime_remote   | deltime_local  | del_if_exists    | del_if_exists     | clean                   | upload_local_del_history | 8                       |
 | mtime_remote   | mtime_local    | deltime_local  | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
 | mtime_local    | mtime_remote   | deltime_local  | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
 | mtime_remote   | deltime_local  | mtime_local    | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
 | deltime_local  | mtime_remote   | mtime_local    | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
 | mtime_local    | deltime_local  | mtime_remote   | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
 | deltime_local  | mtime_local    | mtime_remote   | deltime_remote | del_if_exists    | del_if_exists     | clean                   | keep                     |                         |
 | mtime_remote   | deltime_remote | deltime_local  | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
 | deltime_remote | mtime_remote   | deltime_local  | mtime_local    | skip             | upload_local      | clean                   | clean                    | 10                      |
 | mtime_remote   | deltime_local  | deltime_remote | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
 | deltime_local  | mtime_remote   | deltime_remote | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
 | deltime_remote | deltime_local  | mtime_remote   | mtime_local    | skip             | upload_local      | clean                   | clean                    | 2;3;4;5;6               |
 | deltime_local  | deltime_remote | mtime_remote   | mtime_local    | skip             | upload_local      | clean                   | clean                    |                         |
 | mtime_local    | deltime_remote | deltime_local  | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
 | deltime_remote | mtime_local    | deltime_local  | mtime_remote   | download_remote  | skip              | clean                   | clean                    | 7;9                     |
 | mtime_local    | deltime_local  | deltime_remote | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
 | deltime_local  | mtime_local    | deltime_remote | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
 | deltime_remote | deltime_local  | mtime_local    | mtime_remote   | download_remote  | skip              | clean                   | clean                    | 1;9                     |
 | deltime_local  | deltime_remote | mtime_local    | mtime_remote   | download_remote  | skip              | clean                   | clean                    |                         |
 ### Folders
 We actually do not use any folders' metadata. Thus the only relevent info is their names, while the mtime is actually ignorable.
 1. Firstly generate all the files' plan. If any files exist, then it's parent folders all should exist. If the should-exist folder doesn't exist locally, the local should create it recursively. If the should-exist folder doesn't exist remotely, the remote should create it recursively.
 2. Then, a folder is deletable, if and only if all the following conditions meet:
   - it shows up in the remote deletion history
   - it's empty, or all its sub-folders are deletable
   Some examples:
   - A user deletes the folder in device 1, then syncs from the device 1, then creates the same-name folder in device 2, then syncs from the device 2. The folder is deleted (again), on device 2.
   - A user deletes the folder in device 1, then syncs from the device 1, then creates the same-name folder in device 2, **then create a new file inside it,** then syncs from the device 2. The folder is **kept** instead of deleted because of the new file, on device 2.
   - A user deletes the folder in device 1, then syncs from the device 1, then do not touch the same-name folder in device 2, then syncs from the device 2. The folder and its untouched sub-files should be deleted on device 2.
@@ -0,0 +1,17 @@
 # Sync Ignoring Large Files
 Initially, the plugin does not ignore large files.
 From the new version in May 2022, it can ignore all files with some sizes. But we need some rules to make the function compatible with existing conditions.
 1. If users are using E2E password mode, then the file sizes are compared on the **encrypted sizes**, rather than the original unencripted file sizes. The reasons are: the encrypted ones are in transferations, and the encrypted sizes can be computed from unencrypted sizes but not the reverse.
 2. Assuming the file A, is already synced between local device and remote service before.
   - If the local size and remote size are both below the threshold, then the file can be synced normally.
   - If the local size and remote size are both above the threshold, then the file will be ignored normally.
   - If the local size is below the threshold, and the remote size is above the threshold, then the plugin **rejects** the sync, and throws the error to the user.
   - If the local size is above the threshold, and the remote size is below the threshold, then the plugin **rejects** the sync, and throws the error to the user.
   - When it somes to deletions, the same rules apply.
   The main point is that, if the file sizes "cross the line", the plugin does not introduce any further trouble and just reject to work for this file.
@@ -9,6 +9,8 @@ if you want to view the source, please visit the github repository of this plugi
 */
 `;
 console.log(`esbuild version = ${esbuild.version}`);
 const prod = process.argv[2] === "production";
 const DEFAULT_DROPBOX_APP_KEY = process.env.DROPBOX_APP_KEY || "";
@@ -16,7 +18,7 @@ const DEFAULT_ONEDRIVE_CLIENT_ID = process.env.ONEDRIVE_CLIENT_ID || "";
 const DEFAULT_ONEDRIVE_AUTHORITY = process.env.ONEDRIVE_AUTHORITY || "";
 esbuild
-  .build({
+  .context({
    banner: {
      js: banner,
    },
@@ -29,11 +31,15 @@ esbuild
      "obsidian",
      "electron",
      "fs",
-      "crypto",
+      "tls",
      "net",
      "http",
      "https",
      // ...builtins
    ],
    inject: ["./esbuild.injecthelper.mjs"],
    format: "cjs",
-    watch: !prod,
+    // watch: !prod, // no longer valid in esbuild 0.17
    target: "es2016",
    logLevel: "info",
    sourcemap: prod ? false : "inline",
@@ -44,6 +50,20 @@ esbuild
      "process.env.DEFAULT_DROPBOX_APP_KEY": `"${DEFAULT_DROPBOX_APP_KEY}"`,
      "process.env.DEFAULT_ONEDRIVE_CLIENT_ID": `"${DEFAULT_ONEDRIVE_CLIENT_ID}"`,
      "process.env.DEFAULT_ONEDRIVE_AUTHORITY": `"${DEFAULT_ONEDRIVE_AUTHORITY}"`,
      global: "window",
      "process.env.NODE_DEBUG": `undefined`, // ugly fix
      "process.env.DEBUG": `undefined`, // ugly fix
    },
  })
  .then((context) => {
    if (process.argv.includes("--watch")) {
      // Enable watch mode
      context.watch();
    } else {
      // Build once and exit if not in watch mode
      context.rebuild().then((result) => {
        context.dispose();
      });
    }
  })
  .catch(() => process.exit(1));
@@ -0,0 +1,2 @@
 export let Buffer = require("buffer").Buffer;
 export let process = require("process/browser");
@@ -0,0 +1,11 @@
 {
  "id": "remotely-save",
  "name": "Remotely Save",
  "version": "0.3.35",
  "minAppVersion": "0.13.21",
  "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
  "author": "fyears",
  "authorUrl": "https://github.com/fyears",
  "isDesktopOnly": false,
  "fundingUrl": "https://github.com/remotely-save/donation"
 }
@@ -1,10 +1,11 @@
 {
  "id": "remotely-save",
  "name": "Remotely Save",
-  "version": "0.2.6",
+  "version": "0.3.35",
-  "minAppVersion": "0.12.15",
+  "minAppVersion": "0.13.21",
  "description": "Yet another unofficial plugin allowing users to synchronize notes between local device and the cloud service.",
  "author": "fyears",
  "authorUrl": "https://github.com/fyears",
-  "isDesktopOnly": false
+  "isDesktopOnly": false,
  "fundingUrl": "https://github.com/remotely-save/donation"
 }
@@ -1,12 +1,13 @@
 {
  "name": "remotely-save",
-  "version": "0.2.6",
+  "version": "0.3.25",
  "description": "This is yet another sync plugin for Obsidian app.",
  "scripts": {
-    "dev": "node esbuild.config.mjs",
+    "dev2": "node esbuild.config.mjs --watch",
    "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
    "build": "webpack --mode production",
-    "format": "npx prettier --write .",
+    "dev": "webpack --mode development --watch",
    "format": "npx prettier --trailing-comma es5 --write .",
    "clean": "npx rimraf main.js",
    "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\"} mocha -r ts-node/register 'tests/**/*.ts'"
  },
@@ -14,65 +15,82 @@
    "path": "path-browserify",
    "process": "process/browser",
    "stream": "stream-browserify",
-    "crypto": "crypto-browserify"
+    "crypto": "crypto-browserify",
    "url": "url/"
  },
  "source": "main.ts",
  "keywords": [],
  "author": "",
  "license": "Apache-2.0",
  "devDependencies": {
-    "@microsoft/microsoft-graph-types": "^2.11.0",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
-    "@types/chai": "^4.2.22",
+    "@types/chai": "^4.3.11",
-    "@types/chai-as-promised": "^7.1.4",
+    "@types/chai-as-promised": "^7.1.8",
-    "@types/jsdom": "^16.2.13",
+    "@types/jsdom": "^21.1.6",
-    "@types/lodash": "^4.14.178",
+    "@types/lodash": "^4.14.202",
-    "@types/mime-types": "^2.1.1",
+    "@types/mime-types": "^2.1.4",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.6",
-    "@types/node": "^14.14.37",
+    "@types/mustache": "^4.2.5",
-    "@types/qrcode": "^1.4.1",
+    "@types/node": "^20.10.4",
-    "builtin-modules": "^3.2.0",
+    "@types/qrcode": "^1.5.5",
-    "chai": "^4.3.4",
+    "builtin-modules": "^3.3.0",
    "chai": "^4.3.10",
    "chai-as-promised": "^7.1.1",
    "cross-env": "^7.0.3",
-    "dotenv": "^10.0.0",
+    "dotenv": "^16.3.1",
-    "esbuild": "^0.14.0",
+    "esbuild": "^0.19.9",
-    "jsdom": "^19.0.0",
+    "jsdom": "^23.0.1",
-    "mocha": "^9.1.3",
+    "mocha": "^10.2.0",
-    "prettier": "^2.4.1",
+    "npm-check-updates": "^16.14.12",
-    "ts-loader": "^9.2.6",
+    "obsidian": "^1.4.11",
-    "ts-node": "^10.4.0",
+    "prettier": "^3.1.1",
-    "tslib": "^2.2.0",
+    "ts-loader": "^9.5.1",
-    "typescript": "^4.4.4",
+    "ts-node": "^10.9.2",
    "tslib": "^2.6.2",
    "typescript": "^5.3.3",
    "webdav-server": "^2.6.2",
-    "webpack": "^5.64.4",
+    "webpack": "^5.89.0",
-    "webpack-cli": "^4.9.1"
+    "webpack-cli": "^5.1.4"
  },
  "dependencies": {
-    "@aws-sdk/client-s3": "^3.37.0",
+    "@aws-sdk/client-s3": "^3.474.0",
-    "@aws-sdk/lib-storage": "^3.40.1",
+    "@aws-sdk/lib-storage": "^3.474.0",
-    "@aws-sdk/signature-v4-crt": "^3.37.0",
+    "@aws-sdk/signature-v4-crt": "^3.474.0",
-    "@azure/msal-node": "^1.4.0",
+    "@aws-sdk/types": "^3.468.0",
-    "@microsoft/microsoft-graph-client": "^3.0.1",
+    "@azure/msal-node": "^2.6.0",
-    "acorn": "^8.5.0",
+    "@fyears/tsqueue": "^1.0.1",
-    "assert": "^2.0.0",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
-    "aws-crt": "^1.10.1",
+    "@smithy/fetch-http-handler": "^2.3.1",
    "@smithy/protocol-http": "^3.0.11",
    "@smithy/querystring-builder": "^2.0.15",
    "acorn": "^8.11.2",
    "aggregate-error": "^5.0.0",
    "assert": "^2.1.0",
    "aws-crt": "^1.20.0",
    "buffer": "^6.0.3",
    "codemirror": "^5.63.1",
    "crypto-browserify": "^3.12.0",
-    "dropbox": "^10.22.0",
+    "delay": "^6.0.0",
    "dropbox": "^10.34.0",
    "emoji-regex": "^10.3.0",
    "http-status-codes": "^2.3.0",
    "localforage": "^1.10.0",
    "lodash": "^4.17.21",
-    "mime-types": "^2.1.33",
+    "loglevel": "^1.8.1",
-    "obsidian": "^0.12.0",
+    "lucide": "^0.298.0",
    "mime-types": "^2.1.35",
    "mustache": "^4.2.0",
    "nanoid": "^5.0.4",
    "p-queue": "^8.0.1",
    "path-browserify": "^1.0.1",
    "process": "^0.11.10",
-    "qrcode": "^1.5.0",
+    "qrcode": "^1.5.3",
-    "rfc4648": "^1.5.0",
+    "rfc4648": "^1.5.3",
-    "rimraf": "^3.0.2",
+    "rimraf": "^5.0.5",
    "stream-browserify": "^3.0.0",
-    "util": "^0.12.4",
+    "url": "^0.11.3",
-    "webdav": "^4.7.0",
+    "util": "^0.12.5",
-    "webdav-fs": "^4.0.0",
+    "webdav": "^5.3.1",
-    "xregexp": "^5.1.0"
+    "webdav-fs": "^4.0.1",
    "xregexp": "^5.1.1"
  }
 }
@@ -3,14 +3,35 @@
 * To avoid circular dependency.
 */
 import { Platform, requireApiVersion } from "obsidian";
 import type { LangType, LangTypeAndAuto } from "./i18n";
 export const DEFAULT_CONTENT_TYPE = "application/octet-stream";
 export type SUPPORTED_SERVICES_TYPE = "s3" | "webdav" | "dropbox" | "onedrive";
 export type SUPPORTED_SERVICES_TYPE_WITH_REMOTE_BASE_DIR =
  | "webdav"
  | "dropbox"
  | "onedrive";
 export interface S3Config {
  s3Endpoint: string;
  s3Region: string;
  s3AccessKeyID: string;
  s3SecretAccessKey: string;
  s3BucketName: string;
  partsConcurrency?: number;
  forcePathStyle?: boolean;
  remotePrefix?: string;
  useAccurateMTime?: boolean;
  /**
   * @deprecated
   */
  bypassCorsLocally?: boolean;
 }
 export interface DropboxConfig {
@@ -22,15 +43,25 @@ export interface DropboxConfig {
  accountID: string;
  username: string;
  credentialsShouldBeDeletedAtTime?: number;
  remoteBaseDir?: string;
 }
 export type WebdavAuthType = "digest" | "basic";
 export type WebdavDepthType =
  | "auto_unknown"
  | "auto_1"
  | "auto_infinity"
  | "manual_1"
  | "manual_infinity";
 export interface WebdavConfig {
  address: string;
  username: string;
  password: string;
  authType: WebdavAuthType;
  manualRecursive: boolean; // deprecated in 0.3.6, use depth
  depth?: WebdavDepthType;
  remoteBaseDir?: string;
 }
 export interface OnedriveConfig {
@@ -43,6 +74,7 @@ export interface OnedriveConfig {
  deltaLink: string;
  username: string;
  credentialsShouldBeDeletedAtTime?: number;
  remoteBaseDir?: string;
 }
 export interface RemotelySavePluginSettings {
@@ -52,6 +84,30 @@ export interface RemotelySavePluginSettings {
  onedrive: OnedriveConfig;
  password: string;
  serviceType: SUPPORTED_SERVICES_TYPE;
  currLogLevel?: string;
  autoRunEveryMilliseconds?: number;
  initRunAfterMilliseconds?: number;
  syncOnSaveAfterMilliseconds?: number;
  agreeToUploadExtraMetadata?: boolean;
  concurrency?: number;
  syncConfigDir?: boolean;
  syncUnderscoreItems?: boolean;
  lang?: LangTypeAndAuto;
  skipSizeLargerThan?: number;
  ignorePaths?: string[];
  enableStatusBarInfo?: boolean;
  deleteToWhere?: "system" | "obsidian";
  /**
   * @deprecated
   */
  vaultRandomID?: string;
  /**
   * @deprecated
   */
  logToDB?: boolean;
 }
 export interface RemoteItem {
@@ -76,3 +132,78 @@ export interface UriParams {
 // 80 days
 export const OAUTH2_FORCE_EXPIRE_MILLISECONDS = 1000 * 60 * 60 * 24 * 80;
 type DecisionTypeForFile =
  | "skipUploading" // special, mtimeLocal === mtimeRemote
  | "uploadLocalDelHistToRemote" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && uploadLocalDelHistToRemote"
  | "keepRemoteDelHist" // "delLocalIfExists && delRemoteIfExists && cleanLocalDelHist && keepRemoteDelHist"
  | "uploadLocalToRemote" // "skipLocal && uploadLocalToRemote && cleanLocalDelHist && cleanRemoteDelHist"
  | "downloadRemoteToLocal"; // "downloadRemoteToLocal && skipRemote && cleanLocalDelHist && cleanRemoteDelHist"
 type DecisionTypeForFileSize =
  | "skipUploadingTooLarge"
  | "skipDownloadingTooLarge"
  | "skipUsingLocalDelTooLarge"
  | "skipUsingRemoteDelTooLarge"
  | "errorLocalTooLargeConflictRemote"
  | "errorRemoteTooLargeConflictLocal";
 type DecisionTypeForFolder =
  | "createFolder"
  | "uploadLocalDelHistToRemoteFolder"
  | "keepRemoteDelHistFolder"
  | "skipFolder";
 export type DecisionType =
  | DecisionTypeForFile
  | DecisionTypeForFileSize
  | DecisionTypeForFolder;
 export interface FileOrFolderMixedState {
  key: string;
  existLocal?: boolean;
  existRemote?: boolean;
  mtimeLocal?: number;
  mtimeRemote?: number;
  deltimeLocal?: number;
  deltimeRemote?: number;
  sizeLocal?: number;
  sizeLocalEnc?: number;
  sizeRemote?: number;
  sizeRemoteEnc?: number;
  changeRemoteMtimeUsingMapping?: boolean;
  changeLocalMtimeUsingMapping?: boolean;
  decision?: DecisionType;
  decisionBranch?: number;
  syncDone?: "done";
  remoteEncryptedKey?: string;
  mtimeLocalFmt?: string;
  mtimeRemoteFmt?: string;
  deltimeLocalFmt?: string;
  deltimeRemoteFmt?: string;
 }
 export const API_VER_STAT_FOLDER = "0.13.27";
 export const API_VER_REQURL = "0.13.26"; // desktop ver 0.13.26, iOS ver 1.1.1
 export const API_VER_REQURL_ANDROID = "0.14.6"; // Android ver 1.2.1
 export const API_VER_ENSURE_REQURL_OK = "1.0.0"; // always bypass CORS here
 export const VALID_REQURL =
  (!Platform.isAndroidApp && requireApiVersion(API_VER_REQURL)) ||
  (Platform.isAndroidApp && requireApiVersion(API_VER_REQURL_ANDROID));
 export const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
 export const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX =
  "sync_plans_hist_exported_on_";
 export const DEFAULT_LOG_HISTORY_FILE_PREFIX = "log_hist_exported_on_";
 export type SyncTriggerSourceType =
  | "manual"
  | "auto"
  | "dry"
  | "autoOnceInit"
  | "auto_sync_on_save";
 export const REMOTELY_SAVE_VERSION_2022 = "0.3.25";
 export const REMOTELY_SAVE_VERSION_2024PREPARE = "0.3.32";
@@ -0,0 +1,69 @@
 import { base64, base64url } from "rfc4648";
 import { reverseString } from "./misc";
 import type { RemotelySavePluginSettings } from "./baseTypes";
 import { log } from "./moreOnLog";
 const DEFAULT_README: string =
  "The file contains sensitive info, so DO NOT take screenshot of, copy, or share it to anyone! It's also generated automatically, so do not edit it manually.";
 interface MessyConfigType {
  readme: string;
  d: string;
 }
 /**
 * this should accept the result after loadData();
 */
 export const messyConfigToNormal = (
  x: MessyConfigType | RemotelySavePluginSettings | null | undefined
 ): RemotelySavePluginSettings | null | undefined => {
  // log.debug("loading, original config on disk:");
  // log.debug(x);
  if (x === null || x === undefined) {
    log.debug("the messy config is null or undefined, skip");
    return x as any;
  }
  if ("readme" in x && "d" in x) {
    // we should decode
    const y = JSON.parse(
      (
        base64url.parse(reverseString(x["d"]), {
          out: Buffer.allocUnsafe as any,
          loose: true,
        }) as Buffer
      ).toString("utf-8")
    );
    // log.debug("loading, parsed config is:");
    // log.debug(y);
    return y;
  } else {
    // return as is
    // log.debug("loading, parsed config is the same");
    return x;
  }
 };
 /**
 * this should accept the result of original config
 */
 export const normalConfigToMessy = (
  x: RemotelySavePluginSettings | null | undefined
 ) => {
  if (x === null || x === undefined) {
    log.debug("the normal config is null or undefined, skip");
    return x;
  }
  const y = {
    readme: DEFAULT_README,
    d: reverseString(
      base64url.stringify(Buffer.from(JSON.stringify(x), "utf-8"), {
        pad: false,
      })
    ),
  };
  // log.debug("encoding, encoded config is:");
  // log.debug(y);
  return y;
 };
--- a/Show More
+++ b/Show More
		`@@ -0,0 +1 @@`
							`This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/`
		`@@ -0,0 +1,3 @@`
							`# Limitations From The Browser Environment: No Background Running After Obsidian Is Closed`

							`The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.`
		`@@ -0,0 +1,2 @@`
							`export let Buffer = require("buffer").Buffer;`
							`export let process = require("process/browser");`