bump to 0.4.21

add profiler
fail statusbar
2024-05-09 00:02:07 +08:00 · 2024-05-09 00:01:30 +08:00 · 2024-05-08 22:50:18 +08:00 · 2024-05-08 22:37:34 +08:00 · 2024-05-08 22:04:21 +08:00 · 2024-05-08 00:20:15 +08:00
152 changed files with 12716 additions and 5379 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 (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 (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
@@ -29,10 +29,18 @@ jobs:
      - name: Checkout codes
        uses: actions/checkout@v2
        with:
-          lfs: true
          submodules: recursive
-      - name: Checkout LFS
-        run: git lfs checkout
+      - name: Checkout LFS file list
+        run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
+      - name: LFS Cache
+        uses: actions/cache@v3
+        with:
+          path: .git/lfs/objects
+          key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
+          restore-keys: |
+            ${{ runner.os }}-lfs-
+      - name: Git LFS Pull
+        run: git lfs pull
      - name: Use Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v2
        with:
@@ -0,0 +1,43 @@
+name: "CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]
+
+# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
+permissions:
+  actions: write
+  contents: write
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@v2.3.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # the below token should have repo scope and must be manually added by you in the repository's secret
+          # This token is required only if you have configured to store the signatures in a remote repository/organization
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        with:
+          path-to-signatures: 'signatures/version1/cla.json'
+          path-to-document: 'https://github.com/remotely-save/remotely-save/blob/master/CLA.md' # e.g. a CLA or a DCO document
+          # branch should not be protected
+          branch: 'main'
+          allowlist: bot*
+
+          # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
+          remote-organization-name: remotely-save
+          remote-repository-name: cla-signed
+          #create-file-commit-message: 'For example: Creating file for storing CLA Signatures'
+          #signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
+          custom-notsigned-prcomment: '<br/>Thank you for your submission, we really appreciate it. However, we ask that $you sign our [Contributor License Agreement](https://github.com/remotely-save/remotely-save/blob/master/CLA.md) before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.<br/>'
+          #custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
+          #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
+          #lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
+          #use-dco-flag: true - If you are using DCO instead of CLA
@@ -0,0 +1,94 @@
+# 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:
+          submodules: recursive
+      - name: Checkout LFS file list
+        run: git lfs ls-files --long | cut -d ' ' -f1 | sort > .lfs-assets-id
+      - name: LFS Cache
+        uses: actions/cache@v3
+        with:
+          path: .git/lfs/objects
+          key: ${{ runner.os }}-lfs-${{ hashFiles('.lfs-assets-id') }}
+          restore-keys: |
+            ${{ runner.os }}-lfs-
+      - name: Git LFS Pull
+        run: git lfs pull
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+      - run: npm run build
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ github.ref }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: false
+          prerelease: true
+      - name: Upload main.js
+        id: upload-main
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./main.js
+          asset_name: main.js
+          asset_content_type: text/javascript
+      - name: Upload manifest.json
+        id: upload-manifest
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json
+      - name: Upload styles.css
+        id: upload-styles
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./styles.css
+          asset_name: styles.css
+          asset_content_type: text/css
@@ -5,6 +5,7 @@
 # npm
 node_modules
 package-lock.json
+pnpm-lock.yaml

 # build
 main.js
@@ -1,3 +0,0 @@
-[submodule "src/langs"]
-	path = src/langs
-	url = https://github.com/remotely-save/langs.git
@@ -1,3 +0,0 @@
-node_modules/
-main.js
-data.json
@@ -0,0 +1,23 @@
+In order to clarify the intellectual property license granted with Contributions from any person or entity, Remotely Save dev team ("Remotely Save") must have on file a signed Contributor License Agreement ("CLA") from each Contributor, indicating agreement with the license terms below. This agreement is for your protection as a Contributor as well as the protection of Remotely Save and its users. It does not change your rights to use your own Contributions for any other purpose.
+
+You accept and agree to the following terms and conditions for Your Contributions (present and future) that you submit to Remotely Save. Except for the license granted herein to Remotely Save and recipients of software distributed by Remotely Save, You reserve all right, title, and interest in and to Your Contributions.
+
+1. Definitions.
+
+   "You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Remotely Save. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Remotely Save for inclusion in, or documentation of, any of the products owned or managed by Remotely Save (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Remotely Save or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Remotely Save for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Remotely Save and to recipients of software distributed by Remotely Save a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Remotely Save and to recipients of software distributed by Remotely Save a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Remotely Save, or that your employer has executed a separate Corporate CLA with Remotely Save.
+
+5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
+
+6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7. Should You wish to submit work that is not Your original creation, You may submit it to Remotely Save separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
+
+8. You agree to notify Remotely Save of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
@@ -0,0 +1,22 @@
+# Contributing
+
+## What
+
+Starting from April 29, 2024, all individual contributors' contributions are only possibly accepted after they sign the CLA.
+
+We do not accept corporate contributions at this moment.
+
+You can check out [CLA](./CLA.md).
+
+## Steps
+
+1. Make some changes to the code. Open a pull request.
+2. A rebot will check the status.
+   ![robot check](./assets/cla-process/cla-robot-alert.png)
+3. Read the [CLA](./CLA.md) carefully and make a decision.
+4. If you decide to sign the CLA, please make a comment "I have read the CLA Document and I hereby sign the CLA".
+5. If you decide to not sign the CLA, please close the PR.
+6. The robot should recheck and pass the check automatically.
+   ![robot recheck](./assets/cla-process/cla-sign-and-pass.png)
+7. Your pr will be reviewed.
+8. If you sign the CLA and submit some more PRs, the robot should pass the test automatically.
@@ -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

@@ -19,24 +17,28 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find
 ## Features

 - Supports:
-  - Amazon S3 or S3-compatible
+  - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
  - Dropbox
  - OneDrive for personal
  - Webdav
+  - Webdis
  - [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.
+- **[End-to-end encryption](./docs/encryption/README.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. 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

@@ -59,15 +61,23 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a

 ### S3

- 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.
- About CORS:
-  - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
-  - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1, you need to 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`, and add at least `ETag` into exposed headers. 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.
+- 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)
+  - [又拍云](./docs/remote_services/s3_upyun/README.zh-cn.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.
+- 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 do not set the prefix in the settings, the bucket should be empty and solely for syncing a vault. You can set the prefix in the settings so that the same bucket can store multiple vaults.
 - 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

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

@@ -83,17 +94,28 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 - 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

- About CORS:
-  - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part.
-  - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1:
-    - 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.
-    - 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.
+
+### Webdis
+
+- Tutorials:
+  - [Webdis](./docs/remote_services/webdis/README.md)
+- Mostly experimental.
+- You have to setup and protect your web server by yourself.

 ## Scheduled Auto Sync

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:07fd075d0f73c708d77fd97bb31d6f185f094031e8275e8fd582e3a0145f6be8
+size 415757
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4c5754df8b5d6878a7fa58992fc7e37ddcce1ecf578a0fc2ec751b6f7bab6f13
+size 284700
@@ -0,0 +1,55 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "organizeImports": {
+    "enabled": true
+  },
+  "files": {
+    "ignore": ["main.js"]
+  },
+  "formatter": {
+    "enabled": true,
+    "formatWithErrors": false,
+    "ignore": [],
+    "attributePosition": "auto",
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineEnding": "lf",
+    "lineWidth": 80
+  },
+  "javascript": {
+    "formatter": {
+      "arrowParentheses": "always",
+      "bracketSameLine": false,
+      "bracketSpacing": true,
+      "jsxQuoteStyle": "double",
+      "quoteProperties": "asNeeded",
+      "semicolons": "always",
+      "trailingComma": "es5"
+    }
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noExplicitAny": "off",
+        "noPrototypeBuiltins": "off",
+        "noControlCharactersInRegex": "off"
+      },
+      "style": {
+        "noUselessElse": "off",
+        "useNodejsImportProtocol": "off",
+        "noUnusedTemplateLiteral": "off",
+        "useTemplate": "off",
+        "noNonNullAssertion": "off"
+      },
+      "performance": {
+        "noDelete": "off"
+      },
+      "complexity": {
+        "noForEach": "off",
+        "useLiteralKeys": "off"
+      }
+    }
+  }
+}
@@ -0,0 +1,25 @@
+// Importing the http module
+const http = require("http");
+
+const requestHandler = (req, res) => {
+  const 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 issue (solved in the new Obsidian version).](./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,6 +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)

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

-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).
+2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
+
+   Example configurations:
+
+   - [Amazon S3](./s3_cors_configure.md)
+   - [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))
@@ -0,0 +1,8 @@
+# Encryption
+
+Currently (March 2024), Remotely Save supports two end to end encryption format:
+
+1. [RClone Crypt](./rclone.md) format, which is the recommend way now.
+2. [OpenSSL enc](./openssl.md) format
+
+Here is also the [comparation](./comparation.md).
@@ -0,0 +1,23 @@
+# Comparation Between Encryption Formats
+
+## Warning
+
+**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
+
+If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
+
+## The feature table
+
+|                          | RClone Crypt                                                                               | OpenSSL enc                                                    | comments                                                                                                                                                            |
+| ------------------------ | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| key generation           | scrypt with fixed salt                                                                     | PBKDF2 with dynamic salt                                       | scrypt is better than PBKDF2 from the algorithm aspect. But RClone uses fixed salt by default. Also the parameters might affect the result.                         |
+| content encryption       | XSalsa20Poly1305 on chunks                                                                 | AES-256-CBC                                                    | XSalsa20Poly1305 is way better than AES-256-CBC. And encryption by chunks should require less resources.                                                            |
+| file name encryption     | EME on each segment of the path                                                            | AES-256-CBC on the whole path                                  | RClone has the benefit as well as pitfall that the path structure is preserved. Maybe it's more of a design decision difference? No comment on EME and AES-256-CBC. |
+| viewing decrypted result | RClone has command that can mount the encrypted vault as if the encryption is transparent. | No convenient way except writing some scripts we are aware of. | RClone is way more convenient.                                                                                                                                      |
+
+## Some notes
+
+1. Anyway, security is a hard problem. The author of Remotely Save doesn't have sufficient knowledge to "judge" which one is the better format. **Use them at your own risk.**
+2. Currently the RClone Crypt format is recommended by default in Remotely Save. Just because of the taste from the Remotely Save author, who likes RClone.
+3. **Always use a long password.**
+4. Both algorithms are selected deliberately to **be compatible with some well-known third-party tools** (instead of some home-made methods) and **have many tests to ensure the correctness**.
@@ -1,10 +1,22 @@
-# Encryption
+# OpenSSL enc format

 If a password is set, the files are encrypted before being sent to the cloud.

-The encryption algorithm is delibrately designed to be aligned with openssl format.
+## Warning

-1. The encryption algorithm is implemented using web-crypto.
+**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
+
+If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
+
+## Comparation between encryption formats
+
+See the doc [Comparation](./comparation.md).
+
+## Interoperability with official OpenSSL
+
+This encryption algorithm is delibrately designed to be aligned with openssl format.
+
+1. The encryption algorithm is implemented using web-crypto. Using AES-256-CBC.
 2. The file content is encrypted using openssl format. Assuming a file named `sometext.txt`, a password `somepassword`, then the encryption is equivalent to the following command:

   ```bash
@@ -0,0 +1,46 @@
+# RClone Crypt format
+
+The encryption is compatible with RClone Crypt with **base64** name encryption format.
+
+It's developed based on another js project by the same author of Remotely Save: [`@fyears/rclone-crypt`](https://github.com/fyears/rclone-crypt), which is NOT an official library from RClone, and is NOT affiliated with RClone.
+
+Reasonable tests are also ported from official RClone code, to ensure the compatibility and correctness of the encryption.
+
+## Warning
+
+**ALWAYS BACKUP YOUR VAULT MANUALLY!!!**
+
+If you switch between RClone Crypt format and OpenSSL enc format, you have to delete the cloud vault files **manually** and **fully**, so that the plugin can re-sync (i.e. re-upload) the newly encrypted versions to the cloud.
+
+## Comparation between encryption formats
+
+See the doc [Comparation](./comparation.md).
+
+## Interoperability with official RClone
+
+Please pay attention that the plugin uses **base64** of encrypted file names, while official RClone by default uses **base32** file names. The intention is purely for potentially support longer file names.
+
+You could set up the RClone profile by calling `rclone config`. You need to create two profiles, one for your original connection and the other for RClone Crypt.
+
+Finally, a working config file should like this:
+
+```ini
+[webdav1]
+type = webdav
+url = https://example.com/sharefolder1/subfolder1 # the same as the web address in Remotely Save settings.
+vendor = other
+user = <some webdav username>
+pass = <some webdav password, obfuscated>
+
+[webdav1crypt]
+type = crypt
+remote = nas1test:vaultname # the same as your "Remote Base Directory" (usually the vault name) in Remotely Save settings
+password = <some encryption password, obfuscated>
+filename_encoding = base64 # don't forget this!!!
+```
+
+You can use the `mount` command to view and see the files in file explorer! On Windows, the command should like this (the remote vault is mounted to drive `X:`):
+
+```bash
+rclone mount webdav1crypt: X: --network-mode
+```
@@ -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>.
@@ -0,0 +1,56 @@
+# How to receive `obsidian://` in Linux
+
+## Background
+
+For example, when we are authorizing OneDrive, we have to jump back to Obsidian automatically using `obsidian://`.
+
+## Short Desc From Official Obsidian Doc
+
+Official doc has some explanation:
+
+<https://help.obsidian.md/Extending+Obsidian/Obsidian+URI#Register+Obsidian+URI>
+
+# Long Desc
+
+Assuming the username is `somebody`, and the `.AppImage` file is downloaded to `~/Desktop`.
+
+1. Download and **extract** the app image file in terminal
+
+   ```bash
+   cd /home/somebody/Desktop
+   chmod +x Obsidian-x.y.z.AppImage
+   ./Obsidian-x.y.z.AppImage --appimage-extract
+
+   # you should have the folder squashfs-root
+   # we want to rename it
+   mv squashfs-root Obsidian
+   ```
+
+2. Create a `.desktop` file
+
+   ```bash
+   # copy and paste the follow MULTI LINE command
+   # you might need to input your password because it requires root privilege
+   # remember to adjust the path
+   cat > ~/Desktop/obsidian.desktop <<EOF
+   [Desktop Entry]
+   Name=Obsidian
+   Comment=obsidian
+   Exec=/home/somebody/Desktop/Obsidian/obsidian %u
+   Keywords=obsidian
+   StartupNotify=true
+   Terminal=false
+   Type=Application
+   Icon=/home/somebody/Desktop/Obsidian/obsidian.png
+   MimeType=x-scheme-handler/obsidian;
+   EOF
+
+   # yeah we can check out the output
+   cat ~/Desktop/obsidian.desktop
+   ## [Desktop Entry]
+   ## ...
+   ```
+
+3. Right click the `obsidian.desktop` file on the Desktop, and click "Allow launching"
+
+4. Double click the `obsidian.desktop` file.
@@ -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
@@ -0,0 +1,79 @@
+# 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:ListBucket",
+                "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",
+                "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,24 @@
+# 又拍云
+
+## 链接
+
+- 官网 <https://www.upyun.com/>
+- 官网的 S3 文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>
+
+## 注意！！！！！
+
+又拍云似乎（？）文件都是默认公开的，强烈建议注意隐私问题，强烈建议设置插件加密。
+
+## 步骤
+
+1. 注册，新建对象存储。
+2. 参考官网文档 <https://help.upyun.com/knowledge-base/aws-s3%e5%85%bc%e5%ae%b9/>，创建操作员然后创建 S3 访问凭证。
+3. 在 Remotely Save 设置以下：
+   - 服务地址（Endpoint）：`s3.api.upyun.com` **一定是这个域名**
+   - 区域（Region）：`us-east-1`
+   - Acccess Key ID：您获取到的访问凭证的 AccessKey
+   - Secret Access Key：您获取到的访问凭证的 SecretAccessKey
+   - 存储桶（Bucket）的名字：您创建的“服务名”
+   - 是否生成文件夹 Object：不生成（默认） **一定要选择不生成**
+4. 可以在插件设置里，加上密码。
+5. 同步。
@@ -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
@@ -0,0 +1,35 @@
+# Webdis
+
+## Links
+
+- Webdis: <https://github.com/nicolasff/webdis>
+- Redis®: <https://redis.io/>
+
+## Explanation and Background
+
+I like the Redis® software very much, and would like to experiment using it as a "file storage". It seems to be nature by using path as the key and the content as the value (Sort of..., see below).
+
+However, Redis® works by using TCP connections, and browser js cannot establish raw TCP connections. We need a HTTP gateway, to provide the HTTP api. Wedis seems to be the most famous open source one.
+
+And of course, this method should work for Redis® alternatives: Valkey, Redict, KeyDB, Dragonfly, Garnet, ...
+
+## Disclaimer
+
+This app is NOT an official Redis® Ltd / Redis® OSS / Webdis product. Redis is a registered trademark of Redis Ltd.
+
+**Never expose your Redis® or Webdis to public without security protection!!!** You are response for protecting your server.
+
+## Usage
+
+1. Install Redis®.
+2. Install Webdis.
+3. In `webdis.json`, configure the ACL for using password and username, and / or ip filters. **Never expose your Redis® or Webdis to public without security protection!!!**.
+4. Install and configure reverse proxy, firewall, https, etc. (You have to configure HTTPS correctly if you want to use it on iOS)
+5. In Remotely Save settings, enter your server address, username, password, and adjust the "base dir". Check connection.
+6. Sync!
+7. Serveral keys and values will be generated in your Redis® database:
+
+   ```
+   rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:meta # you can HGETALL it
+   rs:fs:v1:${encodeURIComponent(vaultName+'/'+folderStructure+'/'+fileName)}:content # you can GET it
+   ```
@@ -18,15 +18,15 @@ The list is for information purposes only.
 | [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.                       |
+| NextCloud                                                                             | Yes         |       | Yes       |                                                                  | Yes?                                     | No CORS config by default.                       |
 | OwnCloud                                                                              | Yes?        |       | Yes?      |                                                                  | Yes?                                     | No CORS config by default.                       |
-| Seafile                                                                               | Yes?        |       | Yes?      |                                                                  | Yes?                                     |                                                  |
+| 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                                                                 | In the plan |       |           | ?                                                                |                                          |                                                  |
+| 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.                   |                                          |                                                  |
@@ -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,14 @@
+# 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
+- [x] encrpytion: new encryption method, see [this](../../encryption/)
@@ -1,5 +1,5 @@
-import dotenv from "dotenv/config";
 import esbuild from "esbuild";
+import inlineWorkerPlugin from "esbuild-plugin-inline-worker";
 import process from "process";
 // import builtins from 'builtin-modules'

@@ -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,16 @@ esbuild
      "obsidian",
      "electron",
      "fs",
-      "crypto",
      "tls",
      "net",
+      "http",
+      "https",
+      "vm",
      // ...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 +51,21 @@ 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
    },
+    plugins: [inlineWorkerPlugin()],
+  })
+  .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 const Buffer = require("buffer").Buffer;
+export const process = require("process/browser");
@@ -0,0 +1,11 @@
+{
+  "id": "remotely-save",
+  "name": "Remotely Save",
+  "version": "0.4.21",
+  "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.13",
+  "version": "0.4.21",
  "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"
 }
--- a/Show More
+++ b/Show More