bump to 0.4.7

fix a mysterious bug for webdav
more debug for webdav and bump to 0.4.6
2024-03-20 03:44:34 +08:00 · 2024-03-20 03:10:57 +08:00 · 2024-03-20 02:01:51 +08:00 · 2024-03-20 01:42:33 +08:00 · 2024-03-20 01:42:02 +08:00 · 2024-03-19 01:29:10 +08:00
132 changed files with 8407 additions and 2734 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
@@ -1,5 +1,5 @@
 name: Bug Report
-description: File a bug report
+description: Fire a bug report
 title: "[Bug]: "
 labels: ["bug"]
 body:
@@ -31,13 +31,30 @@ body:
  - type: dropdown
    id: service
    attributes:
-      label: What remote cloud services are you using?
+      label: What remote cloud services are you using? (Please choose the specified one if it's in the list)
      multiple: true
      options:
        - S3
+        - S3 (Cloudflare R2)
+        - S3 (BackBlaze B2)
+        - S3 (腾讯云 COS Tencent Cloud COS)
+        - S3 (阿里云 OSS Alibaba Cloud OSS)
+        - S3 (MinIO)
+        - S3 (Wasabi)
+        - S3 (Storj)
        - OneDrive for personal
+        - OneDrive for business
        - Dropbox
-        - webdav
+        - webdav       
+        - webdav (ownCloud)
+        - webdav (InfiniCloud (formally TeraCLOUD))
+        - webdav (AList)
+        - webdav (Cloudreve)
+        - webdav (坚果云 JianGuoYun/NutStore)
+        - webdav (NextCloud)
+        - webdav (FastMail)
+        - webdav (rclone webdav)
+        - webdav (nginx)
        - others
    validations:
      required: true
@@ -55,6 +72,14 @@ body:
      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:
@@ -21,9 +21,26 @@ body:
      multiple: true
      options:
        - S3
+        - S3 (Cloudflare R2)
+        - S3 (BackBlaze B2)
+        - S3 (腾讯云 COS Tencent Cloud COS)
+        - S3 (阿里云 OSS Alibaba Cloud OSS)
+        - S3 (MinIO)
+        - S3 (Wasabi)
+        - S3 (Storj)
        - OneDrive for personal
+        - OneDrive for business
        - Dropbox
-        - webdav
+        - webdav       
+        - webdav (ownCloud)
+        - webdav (InfiniCloud (formally TeraCLOUD))
+        - webdav (AList)
+        - webdav (Cloudreve)
+        - webdav (坚果云 JianGuoYun/NutStore)
+        - webdav (NextCloud)
+        - webdav (FastMail)
+        - webdav (rclone webdav)
+        - webdav (nginx)
        - others
    validations:
      required: false
@@ -30,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
@@ -4,9 +4,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find

 [![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)

-[![total downloads auto count](https://remotely-save.github.io/auto-download-stats/totalDownloads.svg)](https://github.com/fyears/remotely-save/releases)
-
-[![downloads of latest version](https://remotely-save.github.io/auto-download-stats/latestVersionDownloads.svg)](https://github.com/fyears/remotely-save/releases)
+[![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

@@ -14,30 +12,32 @@ 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 for personal
  - Webdav
-  - A list of connectable / not-connectable / in-the-plan / never-possible services are noted down [here](./docs/services_connectable_or_not.md).
+  - [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_v2.md) for discussion.**
+- **[Sync Algorithm open](./docs/sync_algorithm/v3/intro.md) for discussion.**
+- **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** now, more to come!

 ## Limitations

- **To support deltions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
- **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.
- **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.
+- **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.
 - **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

@@ -60,40 +60,52 @@ 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)
+  - [Storj](./docs/remote_services/s3_storj_io/README.md)
+  - [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [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`. Full example is [here](./docs/s3_cors_configure.md). 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 "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.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.

 ### 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.

 ### 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
+- You might also want to checkout [faq for OneDrive](./docs/remote_services/onedrive/README.md).

 ### webdav

- **webdav support is considered experimental.**
- Currently only supports BASIC authorization method.
- 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.
-  - 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.
-  - 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.
+- Tutorials / Examples:
+  - [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
+  - [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
+  - [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
+  - [AList（中文）](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
+  - [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
+- 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.

 ## Scheduled Auto Sync

@@ -101,6 +113,12 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - 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.

+## How To Deal With Hidden Files Or Folders
+
+**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.
+
+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).
+
 ## How To Debug

 See [here](./docs/how_to_debug/README.md) for more details.
@@ -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}`);
+});
@@ -6,7 +6,7 @@ Technically, the plugin (or any plugin?) runs in the js environment provided by

 Then some limitations are applied:

-1. [The CORS policy.](./browser_env_cors.md)
+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)
@@ -4,18 +4,11 @@ The plugin is developed for the browser environment. The "fake" browser behind t

 [MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)

-To solve the issue, we have some options:
+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.

-1. The server side needs to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. Sometimes in the future, the header `Access-Control-Expose-Headers` with some values being set might be also needed.
+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`.

-   [Here is an example configuration for Amazon S3.](./s3_cors_configure.md)
+   Example configurations:

-   However, some cloud services do not allow configuring or exposing these headers. (Notably most public WebDAV services.)
-
-   It's of course possible if the users build the services by themselves.
-
-2. Obsidian implements and exposes a new api helping developers to bypass the CORS policy.
-
-   Currently (as of Feb 2022), an api `request()` indeed exists, but it only deals with text-like data, and does not support binary data or response headers reading yet.
-
-   Because this plugin allows uploading and downloading binary data, so a more feature-rich api is needed.
+   - [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,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
@@ -6,6 +6,14 @@ Ideally, users do not need to debug anything. But if something bad happened, we

 See [here](./export_sync_plans.md).

-## Advanced: Check Console Output
+## Advanced: Check Console Output Directly
+
+...of desktop and Android.

 See [here](./check_console_output.md).
+
+## Advanced: Use `Logstravaganza` to export logs
+
+This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.
+
+See [here](./use_logstravaganza.md).
@@ -1,6 +1,6 @@
 # Check Console Output

-If you are using Obsidian on desktop, you can check the Obsidian console.
+If you are using Obsidian on desktop or Android, you can check the Obsidian console.

 ## Disable Auto Sync Firstly

@@ -12,6 +12,12 @@ Go to the plugin settings, scroll down to the section "Debug" -> "alter console

 ## Check The Output

-Then, 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 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,14 @@
+# Use `Logstravaganza`
+
+On iOS, it's quite hard to directly check the console logs.
+
+Luckily, there is a third-party plugin: [`Logstravaganza`](https://obsidian.md/plugins?search=Logstravaganza#), by Carlo Zottmann, that can redirect the output to a note.
+
+You can just:
+
+1. Install it.
+2. Enable it.
+3. Do something, to trigger some console logs.
+4. Checkout `LOGGING-NOTE (device name).md` in the root of your vault.
+
+See more on its site: <https://github.com/czottmann/obsidian-logstravaganza>.
@@ -1,8 +1,10 @@
 # Minimal Intrusive Design

-Before version 0.3.0, the plugin did not upload additional meta data to the remote.
+~~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.
+~~From version 0.3.0 ~ 0.3.40, the plugin just upload minimal extra necessary meta data to the remote.~~
+
+From version 0.4.1 and above, the plugin doesn't need uploading meta data due to the sync algorithm upgrade.

 ## Benefits

@@ -12,10 +14,14 @@ For example, it's possbile for a uses to manually upload a file to s3, and next

 And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.

-## Necessarity Of Uploading Extra Metadata
+## ~~Necessarity Of Uploading Extra Metadata from 0.3.0 ~ 0.3.40~~

-The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").
+~~The main issue comes from deletions (and renamings which is actually interpreted as "deletion-then-creation").~~

-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.
+~~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.~~

-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.
+~~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.~~
+
+## No uploading extra metadata from 0.4.1
+
+Some information, including previous successful sync status of each file, is kept locally.
@@ -0,0 +1,23 @@
+# OneDrive
+
+- **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).
+- 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**.
+- If you want to sync the files across multiple devices, **your vault name should be the same** while using default settings.
+
+## FAQ
+
+### How about OneDrive for Business?
+
+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.
+
+### I cannot find `/Apps/remotely-save` folder
+
+Mystically some users report that their OneDrive generate `/Application/Graph` instead of `/Apps/remotely-save`. See [#517](https://github.com/remotely-save/remotely-save/issues/517).
+
+The solution is simple:
+
+1. Backup your vault manually.
+2. Go to onedrive website (<https://onedrive.live.com/>), and rename `/Application/Graph` to `/Application/remotely-save` (right click on the folder and you will see rename option)
+3. Come back to Obsidian and try to sync!
@@ -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
@@ -1,5 +1,7 @@
 # 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:
@@ -0,0 +1,75 @@
+# 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": "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,17 @@
+# Storj
+
+## Links
+
+<https://www.storj.io/>
+
+## Steps
+
+1. Register an account. Login.
+2. Create a bucket.
+3. Create S3 Credentials in Access Management. Allow all permissions for the bucket. Remember the access key and secret key and the end point. The end point is likely to be [`https://gateway.storjshare.io`](https://docs.storj.io/dcs/api/s3/s3-compatible-gateway).
+   ![](./storj_create_s3_cred_1.png)
+   ![](./storj_create_s3_cred_2.png)
+4. Input your credentials into remotely-save settings. Region [should be `global`](https://docs.storj.io/dcs/api/s3/s3-compatibility).
+   ![](storj_remotely_save_settings.png)
+5. Check connectivity.
+6. Sync!
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a3484f74f45fbdae6110de285edeff10c196c13160cb97f079da77843ae92e80
+size 386188
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:42593d98e1b154f4174a932088e72c25db9a976b5613f4d6ae21df1445b4559c
+size 278219
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7843c31153054eb4762dbaf3027c1042b0d7cb4dd774bf584788cd7a97ba4044
+size 571188
@@ -0,0 +1,23 @@
+# Tencent Cloud COS
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+- international <https://console.tencentcloud.com/cos>
+
+## 步骤 Steps
+
+The example shows the steps of China version. International version should be similar.
+
+1. 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. In CAM page, create api key, and note down the SecretID and SecretKey.
+   ![](./cos_create_secret.png)
+4. **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. 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,23 @@
+# 腾讯云 COS
+
+[English](./README.md) | 中文
+
+## 链接
+
+- 中国区 <https://console.cloud.tencent.com/cos>
+
+## 步骤
+
+注意这里用中国区示例，国际区配置应该类似。
+
+1. 在“存储桶列表”页，[“创建存储桶”](https://console.cloud.tencent.com/cos/bucket?action=create)。注意创建**私有读写**，建议打开服务端加密。
+2. 在桶列表页，点击刚刚存储的桶，进入概览页。可以见到桶名称（一般来说是之前指定的英文加账号数字），地域，访问域名。记录下来。
+   ![](./cos_bucket_info.png)
+3. 在[“访问管理页”](https://console.cloud.tencent.com/cam/capi) ，“API 密钥管理”，“创建密钥”，要记录 SecretID 和 SecretKey。
+   ![](./cos_create_secret.png)
+4. **把桶名称从访问域名移除，才是你即将输入的服务地址！假如你在腾讯云网站看到访问域名是 `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`，那么“服务地址”是 `https://cos.<region>.myqcloud.com`.**
+5. 在 remotely-save 设置，输入服务地址，SecretID，SecretKey，和 桶名称。
+   ![](./cos_setting.png)
+6. 检查连接。
+   ![](./cos_connection.png)
+7. 可以同步了！
@@ -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,23 @@
+# AList
+
+English | [中文](./README.zh-cn.md)
+
+## Links
+
+- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
+
+## Steps
+
+1. Install and run AList. Get the account and password. Login using the web page.
+2. 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. 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. In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
+   ![](./alist_rs_settings.en.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
@@ -0,0 +1,23 @@
+# AList
+
+[English](./README.md) | 中文
+
+## 链接
+
+- 中文官网：<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
+
+## 步骤
+
+1. 安装和使用 AList。获取账号名和密码。在网页上登录。
+2. 新建挂载，检查挂载路径。如图所示是 `/alisttest davpath`。
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. 从而构建 webdav 网址如下，**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**，其中挂载路径中假如有空格，换成 `%20`：
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. 在 remotely-save 设置，输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。
+   ![](./alist_rs_settings.en.png)
+5. 在 remotely-save 设置，检查连接。
+6. 同步文件！
@@ -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
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+<https://www.jianguoyun.com/>
+
+## Attentions!!!
+
+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. **Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
+2. Register an account.
+3. 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. 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. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
@@ -0,0 +1,22 @@
+# 坚果云
+
+[English](./README.md) | 中文
+
+## 链接
+
+<https://www.jianguoyun.com/>
+
+## 注意！！！
+
+坚果云有限制 api 数量等设定。本插件会产生若干查询，如果文件较多很容易触发 api 上限，从而工作不正常。这不是插件 bug，也没有办法解决。
+
+## 步骤
+
+1. **知悉坚果云有 api 限制，本插件可能因此工作不正常。**
+2. 注册账号，登录。
+3. 去“个人信息”->“安全”，“添加应用”，从而获取了 webDAV 账号（应该是 email）和 WebDAV 密码（一串特殊的字符，不等于网站密码）。
+   ![](./webdav_jianguoyun.cn.png)
+4. 在 remotely-save 设置，输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. 在 remotely-save 设置，检查连接。
+6. 同步文件！
@@ -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,55 @@
+# Synology Webdav Server
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+<https://kb.synology.com/en-global/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
+
+## Attention
+
+The tutorial author (the author of Remotely Save) is NOT an expert of NAS / Synology. Please read the doc carefully and change it to accommodate your needs by yourself.
+
+**It's dangerous to expose your NAS into public Internet if you don't know how to set up firewalls and other protections.**
+
+## Steps
+
+Synology DSM 7 is used in this tutorial.
+
+1. Create a new shared folder if you don't have one. For this tutorial, a new shared folder `share2` is created. You should assing a proper user to read / write the shared folder.
+   ![](./synology_create_shared_folder.png)
+
+2. Assuming you want to sync your vault into sub folder `哈哈哈/sub folder`, please create the sub folder(s) correspondingly inide the shared folder `share2`.
+
+3. Install webdav server from package center.
+   ![](./synology_install_webdav_server.png)
+
+4. Enter the webdav server settings.
+
+5. If you know how to configure https certificates correctly, you are strongly recommend to enable https.
+
+   For the demonstration purpose, this tutorial enable http server for the later steps.
+
+   Also "Enable DavDepthInfinity", which could speed up the plugin runnings greatly.
+
+   "Apply".
+
+   ![](./synology_webdav_server_settings.png)
+
+6. In Remotely Save settings, you should input your address as:
+
+   `http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
+
+   For example, in the tutorial, the proper url should be:
+
+   `http://<ip>:5000/share2/哈哈哈/sub folder`
+
+   Username and password should be the user you configured before with read / write permissions to `share2`.
+
+   Depth header should be "supports depth="infinity"".
+
+   Check connectivity!
+
+   ![](./synology_remotely_save_settings.png)
+
+7. Sync!
@@ -0,0 +1,56 @@
+# 群晖 Webdav Server
+
+[English](./README.md) | 中文
+
+## 链接
+
+<https://kb.synology.cn/zh-cn/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
+
+## 注意
+
+教程作者（Remotely Save 作者）**不是** NAS、群晖专家。请仔细阅读文档，并自行改动以适应您自身需求。
+
+**没有设置防火墙和其他保护措施的话，将 NAS 暴露到公网上非常危险。**
+
+## 步骤
+
+本教程有用到群晖 DSM 7。
+
+1. 创建共享文件夹。本教程示例创建了 `share2`。你需要允许某个账号对此的读写权限。
+
+   ![](./synology_create_shared_folder.png)
+
+2. 假设之后你想同步你的库到子文件夹，`哈哈哈/sub folder`，请先在共享文件夹 `share2` 底下创建好。
+
+3. 从套件中心安装 webdav server 。
+   ![](./synology_install_webdav_server.png)
+
+4. 进入 webdav server 设置。
+
+5. 如果你知道如何正确配置 https 证书的话，强烈建议开启 https。
+
+   本教程简化示例，开启了 http。
+
+   也设置“Enable DavDepthInfinity”，这可以加速插件连接速度。
+
+   “Apply”。
+
+   ![](./synology_webdav_server_settings.png)
+
+6. 在 Remotely Save 设置页，你的地址应如下格式输入：
+
+   `http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
+
+   比如说，本教程里，正确的地址类似于：
+
+   `http://<ip>:5000/share2/哈哈哈/sub folder`
+
+   用户名和密码是你之前配置了允许读写 `share2` 的那个账号。
+
+   Depth 设置应为“supports depth="infinity"”。
+
+   检查连接！
+
+   ![](./synology_remotely_save_settings.png)
+
+7. 同步！
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:71e61c25db793c00d4406ea0f46745941e16e268a41b7328b03a183ab0706ec8
+size 59700
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0f0725099989b5496048c0e3cb284b4f6537d66866b4618c8e73ee758cb2b642
+size 174986
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7bc6d03a9deb0e8babd2ed102e7b85ee1062797abf1146ae71f80237a852ff10
+size 522084
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba3781f24b5d65ee6915d496f7542c569116141cdced24ca505f4373d9efa9df
+size 536163
@@ -2,39 +2,41 @@

 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 | More Info                                                    |
-| ------------------------------------------------------------------------------------- | ----------- | ----- | --------- | ----------------- | ------------------------------------------------------------ |
-| Amazon S3                                                                             | Yes         | Yes   |           |                   | [CORS config needed.](./s3_cors_configure.md)                |
-| Tencent Cloud - Cloud Object Storage (COS) 腾讯云对象存储                             | Yes         | Yes   |           |                   | CORS config needed.                                          |
-| Alibaba Cloud - Object Storage Service 阿里云对象存储                                 | Yes         | Yes   |           |                   | CORS config needed.                                          |
-| Backblaze B2 Cloud Storage                                                            | No          | No    |           |                   | Its CORS rules doesn't allow no-http(s) origins.             |
-| [Wasabi](https://wasabi.com)                                                          | ?           | ?     |           |                   |                                                              |
-| [filebase](https://filebase.com/)                                                     | Yes         | Yes   |           |                   | CORS config needed.                                          |
-| QingStor 青云                                                                         | ?           | ?     |           |                   |                                                              |
-| [MinIO](https://min.io/)                                                              | ?           | ?     |           |                   |                                                              |
-| [WsgiDAV](https://github.com/mar10/wsgidav)                                           | Yes         |       | Yes       |                   | CORS rules can be set.                                       |
-| [Nginx `ngx_http_dav_module`](http://nginx.org/en/docs/http/ngx_http_dav_module.html) | ?           |       | ?         |                   | Should be possible?                                          |
-| NextCloud                                                                             | No?         |       | No?       |                   | No CORS config by default.                                   |
-| OwnCloud                                                                              | No?         |       | No?       |                   | No CORS config by default.                                   |
-| Seafile                                                                               | ?           |       | ?         |                   |                                                              |
-| `rclone serve webdav`                                                                 | No          |       | No        |                   | No CORS support.                                             |
-| [Nutstore 坚果云](https://www.jianguoyun.com/)                                        | No          |       | No        |                   | No CORS support.                                             |
-| [TeraCLOUD](https://teracloud.jp/en/)                                                 | No          |       | No        |                   | No CORS support.                                             |
-| Dropbox                                                                               | Yes         |       |           | Yes               |                                                              |
-| OneDrive for personal                                                                 | Yes         |       |           | Yes               |                                                              |
-| OneDrive for Business                                                                 | In the plan |       |           | ?                 |                                                              |
-| 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       |       |           | No                | Technically never possible to be implemented.                |
-| SFTP                                                                                  | Never       |       |           | No                | 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. |
-|                                                                                       |             |       |           |                   |                                                              |
+| 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. |                                          |                                                  |
+|                                                                                       |             |       |           |                                                                  |                                          |                                                  |
@@ -0,0 +1,7 @@
+# Sync Algorithm
+
+- [v1](./v1/README.md)
+- [v2](./v2/README.md)
+- v3
+  - [intro doc for end users](./v3/intro.md)
+  - [design doc](./v3/design.md)
@@ -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.
@@ -0,0 +1,4 @@
+# Sync Algorithm V3
+
+- [intro doc for end users](./intro.md)
+- [design doc](./design.md)
@@ -0,0 +1,71 @@
+# Sync Algorithm V3
+
+Drafted on 20240117.
+
+An absolutely better sync algorithm. Better for tracking deletions and better for subbranching.
+
+## Huge Thanks
+
+Basically a combination of algorithm v2 + [synclone](https://github.com/Jwink3101/syncrclone/blob/master/docs/algorithm.md) + [rsinc](https://github.com/ConorWilliams/rsinc) + (some of rclone [bisync](https://rclone.org/bisync/)). All of the later three are released under MIT License so no worries about the licenses.
+
+## Features
+
+Must have
+
+1. true deletion detection
+2. deletion protection (blocking) with a setting
+3. transaction from the old algorithm
+4. user warning show up, **new algorithm needs all clients to be updated!** (deliberately corrput the metadata file??)
+5. filters
+6. conflict warning
+7. partial sync
+
+Nice to have
+
+1. true time and hash
+2. conflict rename
+
+## Description
+
+We have _five_ input sources:
+
+1. local all files
+2. remote all files
+3. _local previous succeeded sync history_
+4. local deletions
+5. remote deletions.
+
+Init run, consuming remote deletions :
+
+Change history data into _local previous succeeded sync history_.
+
+Later runs, use the first, second, third sources **only**.
+
+Bidirectional table is modified based on synclone and rsinc. Incremental push / pull only tables is further modified based on the bidirectional table. The number inside the table cell is the decision branch in the code.
+
+Bidirectional:
+
+| local\remote    | remote unchanged   | remote modified           | remote deleted     | remote created            |
+| --------------- | ------------------ | ------------------------- | ------------------ | ------------------------- |
+| local unchanged | (02/21) do nothing | (09) pull                 | (07) delete local  | (??) conflict             |
+| local modified  | (10) push          | (16/17/18/19/20) conflict | (08) push          | (??) conflict             |
+| local deleted   | (04) delete remote | (05) pull                 | (01) clean history | (03) pull                 |
+| local created   | (??) conflict      | (??) conflict             | (06) push          | (11/12/13/14/15) conflict |
+
+Incremental push only:
+
+| local\remote    | remote unchanged             | remote modified              | remote deleted         | remote created               |
+| --------------- | ---------------------------- | ---------------------------- | ---------------------- | ---------------------------- |
+| local unchanged | (02/21) do nothing           | **(26) conflict push**       | **(32) conflict push** | (??) conflict                |
+| local modified  | (10) push                    | **(25) conflict push**       | (08) push              | (??) conflict                |
+| local deleted   | **(29) conflict do nothing** | **(30) conflict do nothing** | (01) clean history     | **(28) conflict do nothing** |
+| local created   | (??) conflict                | (??) conflict                | (06) push              | **(23) conflict push**       |
+
+Incremental pull only:
+
+| local\remote    | remote unchanged       | remote modified        | remote deleted               | remote created         |
+| --------------- | ---------------------- | ---------------------- | ---------------------------- | ---------------------- |
+| local unchanged | (02/21) do nothing     | (09) pull              | **(33) conflict do nothing** | (??) conflict          |
+| local modified  | **(27) conflict pull** | **(24) conflict pull** | **(34) conflict do nothing** | (??) conflict          |
+| local deleted   | **(35) conflict pull** | (05) pull              | (01) clean history           | (03) pull              |
+| local created   | (??) conflict          | (??) conflict          | **(31) conflict do nothing** | **(22) conflict pull** |
@@ -0,0 +1,13 @@
+# Introduction To Sync Algorithm V3
+
+- [x] sync conflict: keep newer
+- [x] sync conflict: keep larger
+- [ ] sync conflict: keep both and rename
+- [ ] sync conflict: show warning
+- [x] deletion: true deletion status computation
+- [x] meta data: no remote meta data any more
+- [x] migration: old data auto transfer to new db (hopefully)
+- [x] sync direction: incremental push only
+- [x] sync direction: incremental pull only
+- [x] sync protection: warning based on the threshold
+- [ ] partial sync: better sync on save
@@ -18,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,
    },
@@ -31,13 +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",
@@ -48,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.4.7",
+  "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.3.5",
+  "version": "0.3.40",
  "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,13 +1,13 @@
 {
  "name": "remotely-save",
-  "version": "0.3.5",
+  "version": "0.4.7",
  "description": "This is yet another sync plugin for Obsidian app.",
  "scripts": {
-    "dev2": "node esbuild.config.mjs",
+    "dev2": "node esbuild.config.mjs --watch",
    "build2": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
    "build": "webpack --mode production",
    "dev": "webpack --mode development --watch",
-    "format": "npx prettier --write .",
+    "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'"
  },
@@ -23,70 +23,74 @@
  "author": "",
  "license": "Apache-2.0",
  "devDependencies": {
-    "@microsoft/microsoft-graph-types": "^2.11.0",
-    "@types/chai": "^4.2.22",
-    "@types/chai-as-promised": "^7.1.4",
-    "@types/feather-icons": "^4.7.0",
-    "@types/jsdom": "^16.2.13",
-    "@types/lodash": "^4.14.178",
-    "@types/mime-types": "^2.1.1",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.14.37",
-    "@types/qrcode": "^1.4.1",
-    "builtin-modules": "^3.2.0",
-    "chai": "^4.3.4",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/jsdom": "^21.1.6",
+    "@types/lodash": "^4.14.202",
+    "@types/mime-types": "^2.1.4",
+    "@types/mocha": "^10.0.6",
+    "@types/mustache": "^4.2.5",
+    "@types/node": "^20.10.4",
+    "@types/qrcode": "^1.5.5",
+    "builtin-modules": "^3.3.0",
+    "chai": "^4.3.10",
    "chai-as-promised": "^7.1.1",
    "cross-env": "^7.0.3",
-    "dotenv": "^10.0.0",
-    "esbuild": "^0.14.3",
-    "jsdom": "^19.0.0",
-    "mocha": "^9.1.3",
-    "prettier": "^2.4.1",
-    "ts-loader": "^9.2.6",
-    "ts-node": "^10.4.0",
-    "tslib": "^2.2.0",
-    "typescript": "^4.4.4",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.19.9",
+    "jsdom": "^23.0.1",
+    "mocha": "^10.2.0",
+    "npm-check-updates": "^16.14.12",
+    "obsidian": "^1.4.11",
+    "prettier": "^3.1.1",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
    "webdav-server": "^2.6.2",
-    "webpack": "^5.64.4",
-    "webpack-cli": "^4.9.1"
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
  },
  "dependencies": {
-    "@aws-sdk/client-s3": "^3.37.0",
-    "@aws-sdk/fetch-http-handler": "^3.53.0",
-    "@aws-sdk/lib-storage": "^3.53.1",
-    "@aws-sdk/protocol-http": "^3.53.0",
-    "@aws-sdk/querystring-builder": "^3.53.0",
-    "@aws-sdk/signature-v4-crt": "^3.37.0",
-    "@aws-sdk/types": "^3.53.0",
-    "@azure/msal-node": "^1.6.0",
+    "@aws-sdk/client-s3": "^3.474.0",
+    "@aws-sdk/lib-storage": "^3.474.0",
+    "@aws-sdk/signature-v4-crt": "^3.474.0",
+    "@aws-sdk/types": "^3.468.0",
+    "@azure/msal-node": "^2.6.0",
    "@fyears/tsqueue": "^1.0.1",
-    "@microsoft/microsoft-graph-client": "^3.0.1",
-    "acorn": "^8.5.0",
-    "assert": "^2.0.0",
-    "aws-crt": "^1.10.1",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
+    "@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",
-    "feather-icons": "^4.28.0",
-    "http-status-codes": "^2.2.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",
-    "loglevel": "^1.8.0",
-    "mime-types": "^2.1.33",
-    "nanoid": "^3.1.30",
-    "obsidian": "^0.13.26",
-    "p-queue": "^7.2.0",
+    "loglevel": "^1.8.1",
+    "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",
-    "rfc4648": "^1.5.0",
-    "rimraf": "^3.0.2",
+    "qrcode": "^1.5.3",
+    "rfc4648": "^1.5.3",
+    "rimraf": "^5.0.5",
    "stream-browserify": "^3.0.0",
-    "url": "^0.11.0",
-    "util": "^0.12.4",
-    "webdav": "^4.7.0",
-    "webdav-fs": "^4.0.0",
-    "xregexp": "^5.1.0"
+    "url": "^0.11.3",
+    "util": "^0.12.5",
+    "webdav": "^5.3.1",
+    "webdav-fs": "^4.0.1",
+    "xregexp": "^5.1.1"
  }
 }
@@ -3,14 +3,34 @@
 * 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;
 }

@@ -23,16 +43,31 @@ export interface DropboxConfig {
  accountID: string;
  username: string;
  credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }

 export type WebdavAuthType = "digest" | "basic";
+export type WebdavDepthType =
+  | "auto" // deprecated on 20240116
+  | "auto_unknown" // deprecated on 20240116
+  | "auto_1" // deprecated on 20240116
+  | "auto_infinity" // deprecated on 20240116
+  | "manual_1"
+  | "manual_infinity";

 export interface WebdavConfig {
  address: string;
  username: string;
  password: string;
  authType: WebdavAuthType;
-  manualRecursive: boolean;
+
+  depth?: WebdavDepthType;
+  remoteBaseDir?: string;
+
+  /**
+   * @deprecated
+   */
+  manualRecursive: boolean; // deprecated in 0.3.6, use depth
 }

 export interface OnedriveConfig {
@@ -45,8 +80,14 @@ export interface OnedriveConfig {
  deltaLink: string;
  username: string;
  credentialsShouldBeDeletedAtTime?: number;
+  remoteBaseDir?: string;
 }

+export type SyncDirectionType =
+  | "bidirectional"
+  | "incremental_pull_only"
+  | "incremental_push_only";
+
 export interface RemotelySavePluginSettings {
  s3: S3Config;
  webdav: WebdavConfig;
@@ -55,19 +96,43 @@ export interface RemotelySavePluginSettings {
  password: string;
  serviceType: SUPPORTED_SERVICES_TYPE;
  currLogLevel?: string;
-  vaultRandomID?: string;
  autoRunEveryMilliseconds?: number;
  initRunAfterMilliseconds?: number;
-  agreeToUploadExtraMetadata?: boolean;
-  concurrency?: number;
-}
+  syncOnSaveAfterMilliseconds?: number;

-export interface RemoteItem {
-  key: string;
-  lastModified: number;
-  size: number;
-  remoteType: SUPPORTED_SERVICES_TYPE;
-  etag?: string;
+  concurrency?: number;
+  syncConfigDir?: boolean;
+  syncUnderscoreItems?: boolean;
+  lang?: LangTypeAndAuto;
+  agreeToUseSyncV3?: boolean;
+  skipSizeLargerThan?: number;
+  ignorePaths?: string[];
+  enableStatusBarInfo?: boolean;
+  deleteToWhere?: "system" | "obsidian";
+  conflictAction?: ConflictActionType;
+  howToCleanEmptyFolder?: EmptyFolderCleanType;
+
+  protectModifyPercentage?: number;
+  syncDirection?: SyncDirectionType;
+
+  obfuscateSettingFile?: boolean;
+
+  enableMobileStatusBar?: boolean;
+
+  /**
+   * @deprecated
+   */
+  agreeToUploadExtraMetadata?: boolean;
+
+  /**
+   * @deprecated
+   */
+  vaultRandomID?: string;
+
+  /**
+   * @deprecated
+   */
+  logToDB?: boolean;
 }

 export const COMMAND_URI = "remotely-save";
@@ -85,21 +150,76 @@ 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"
+export type EmptyFolderCleanType = "skip" | "clean_both";

-type DecisionTypeForFolder =
-  | "createFolder"
-  | "uploadLocalDelHistToRemoteFolder"
-  | "keepRemoteDelHistFolder"
-  | "skipFolder";
+export type ConflictActionType = "keep_newer" | "keep_larger" | "rename_both";

-export type DecisionType = DecisionTypeForFile | DecisionTypeForFolder;
+export type DecisionTypeForMixedEntity =
+  | "only_history"
+  | "equal"
+  | "local_is_modified_then_push"
+  | "remote_is_modified_then_pull"
+  | "local_is_created_then_push"
+  | "remote_is_created_then_pull"
+  | "local_is_deleted_thus_also_delete_remote"
+  | "remote_is_deleted_thus_also_delete_local"
+  | "conflict_created_then_keep_local"
+  | "conflict_created_then_keep_remote"
+  | "conflict_created_then_keep_both"
+  | "conflict_created_then_do_nothing"
+  | "conflict_modified_then_keep_local"
+  | "conflict_modified_then_keep_remote"
+  | "conflict_modified_then_keep_both"
+  | "folder_existed_both_then_do_nothing"
+  | "folder_existed_local_then_also_create_remote"
+  | "folder_existed_remote_then_also_create_local"
+  | "folder_to_be_created"
+  | "folder_to_skip"
+  | "folder_to_be_deleted";

+/**
+ * uniform representation
+ * everything should be flat and primitive, so that we can copy.
+ */
+export interface Entity {
+  key?: string;
+  keyEnc?: string;
+  keyRaw: string;
+  mtimeCli?: number;
+  mtimeCliFmt?: string;
+  mtimeSvr?: number;
+  mtimeSvrFmt?: string;
+  prevSyncTime?: number;
+  prevSyncTimeFmt?: string;
+  size?: number; // might be unknown or to be filled
+  sizeEnc?: number;
+  sizeRaw: number;
+  hash?: string;
+  etag?: string;
+}
+
+export interface UploadedType {
+  entity: Entity;
+  mtimeCli?: number;
+}
+
+/**
+ * A replacement of FileOrFolderMixedState
+ */
+export interface MixedEntity {
+  key: string;
+  local?: Entity;
+  prevSync?: Entity;
+  remote?: Entity;
+
+  decisionBranch?: number;
+  decision?: DecisionTypeForMixedEntity;
+  conflictAction?: ConflictActionType;
+}
+
+/**
+ * @deprecated
+ */
 export interface FileOrFolderMixedState {
  key: string;
  existLocal?: boolean;
@@ -109,13 +229,42 @@ export interface FileOrFolderMixedState {
  deltimeLocal?: number;
  deltimeRemote?: number;
  sizeLocal?: number;
+  sizeLocalEnc?: number;
  sizeRemote?: number;
-  changeMtimeUsingMapping?: boolean;
-  decision?: DecisionType;
+  sizeRemoteEnc?: number;
+  changeRemoteMtimeUsingMapping?: boolean;
+  changeLocalMtimeUsingMapping?: boolean;
+  decision?: string; // old DecisionType is deleted, fallback to string
  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";
+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";
@@ -3,11 +3,8 @@ import { reverseString } from "./misc";

 import type { RemotelySavePluginSettings } from "./baseTypes";

-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
-
 const DEFAULT_README: string =
-  "Do NOT modify this manually. It's generated automatically.";
+  "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;
@@ -20,10 +17,10 @@ interface MessyConfigType {
 export const messyConfigToNormal = (
  x: MessyConfigType | RemotelySavePluginSettings | null | undefined
 ): RemotelySavePluginSettings | null | undefined => {
-  log.debug("loading, original config on disk:");
-  log.debug(x);
+  // console.debug("loading, original config on disk:");
+  // console.debug(x);
  if (x === null || x === undefined) {
-    log.debug("the messy config is null or undefined, skip");
+    console.debug("the messy config is null or undefined, skip");
    return x as any;
  }
  if ("readme" in x && "d" in x) {
@@ -36,12 +33,12 @@ export const messyConfigToNormal = (
        }) as Buffer
      ).toString("utf-8")
    );
-    log.debug("loading, parsed config is:");
-    log.debug(y);
+    // console.debug("loading, parsed config is:");
+    // console.debug(y);
    return y;
  } else {
    // return as is
-    log.debug("loading, parsed config is the same");
+    // console.debug("loading, parsed config is the same");
    return x;
  }
 };
@@ -53,7 +50,7 @@ export const normalConfigToMessy = (
  x: RemotelySavePluginSettings | null | undefined
 ) => {
  if (x === null || x === undefined) {
-    log.debug("the normal config is null or undefined, skip");
+    console.debug("the normal config is null or undefined, skip");
    return x;
  }
  const y = {
@@ -64,7 +61,7 @@ export const normalConfigToMessy = (
      })
    ),
  };
-  log.debug("encoding, encoded config is:");
-  log.debug(y);
+  // console.debug("encoding, encoded config is:");
+  // console.debug(y);
  return y;
 };
@@ -4,19 +4,78 @@ import type { SyncPlanType } from "./sync";
 import { readAllSyncPlanRecordTextsByVault } from "./localdb";
 import type { InternalDBs } from "./localdb";
 import { mkdirpInVault } from "./misc";
+import {
+  DEFAULT_DEBUG_FOLDER,
+  DEFAULT_LOG_HISTORY_FILE_PREFIX,
+  DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX,
+  FileOrFolderMixedState,
+} from "./baseTypes";

-import * as origLog from "loglevel";
-const log = origLog.getLogger("rs-default");
+const turnSyncPlanToTable = (record: string) => {
+  const syncPlan: SyncPlanType = JSON.parse(record);
+  const { ts, tsFmt, remoteType, mixedStates } = syncPlan;

-const DEFAULT_DEBUG_FOLDER = "_debug_remotely_save/";
-const DEFAULT_SYNC_PLANS_HISTORY_FILE_PREFIX = "sync_plans_hist_exported_on_";
+  type allowedHeadersType = keyof FileOrFolderMixedState;
+  const headers: allowedHeadersType[] = [
+    "key",
+    "remoteEncryptedKey",
+    "existLocal",
+    "sizeLocal",
+    "sizeLocalEnc",
+    "mtimeLocal",
+    "deltimeLocal",
+    "changeLocalMtimeUsingMapping",
+    "existRemote",
+    "sizeRemote",
+    "sizeRemoteEnc",
+    "mtimeRemote",
+    "deltimeRemote",
+    "changeRemoteMtimeUsingMapping",
+    "decision",
+    "decisionBranch",
+  ];
+
+  const lines = [
+    `ts: ${ts}${tsFmt !== undefined ? " / " + tsFmt : ""}`,
+    `remoteType: ${remoteType}`,
+    `| ${headers.join(" | ")} |`,
+    `| ${headers.map((x) => "---").join(" | ")} |`,
+  ];
+  for (const [k1, v1] of Object.entries(syncPlan.mixedStates)) {
+    const k = k1 as string;
+    const v = v1 as FileOrFolderMixedState;
+    const singleLine = [];
+    for (const h of headers) {
+      const field = v[h];
+      if (field === undefined) {
+        singleLine.push("");
+        continue;
+      }
+      if (
+        h === "mtimeLocal" ||
+        h === "deltimeLocal" ||
+        h === "mtimeRemote" ||
+        h === "deltimeRemote"
+      ) {
+        const fmt = v[(h + "Fmt") as allowedHeadersType] as string;
+        const s = `${field}${fmt !== undefined ? " / " + fmt : ""}`;
+        singleLine.push(s);
+      } else {
+        singleLine.push(field);
+      }
+    }
+    lines.push(`| ${singleLine.join(" | ")} |`);
+  }
+
+  return lines.join("\n");
+};

 export const exportVaultSyncPlansToFiles = async (
  db: InternalDBs,
  vault: Vault,
  vaultRandomID: string
 ) => {
-  log.info("exporting");
+  console.info("exporting");
  await mkdirpInVault(DEFAULT_DEBUG_FOLDER, vault);
  const records = await readAllSyncPlanRecordTextsByVault(db, vaultRandomID);
  let md = "";
@@ -32,5 +91,5 @@ export const exportVaultSyncPlansToFiles = async (
  await vault.create(filePath, md, {
    mtime: ts,
  });
-  log.info("finish exporting");
+  console.info("finish exporting");
 };
--- a/Show More
+++ b/Show More