bump to 0.5.9

fix status bar
add more hints for s3
2024-06-22 23:43:15 +08:00 · 2024-06-22 23:42:36 +08:00 · 2024-06-22 23:33:27 +08:00 · 2024-06-22 21:03:43 +08:00 · 2024-06-18 23:10:18 +08:00 · 2024-06-18 23:05:30 +08:00
244 changed files with 38527 additions and 1517 deletions
@@ -23,6 +23,6 @@ indent_size = 4
 indent_style = tab
 # Indentation override for all JS under lib directory
-[*.{js,jsx,mjs,cjs,ts,tsx,json,py}]
+[*.{js,jsx,mjs,cjs,ts,tsx,json}]
 indent_style = space
 indent_size = 2
@@ -0,0 +1,15 @@
 DROPBOX_APP_KEY=
 ONEDRIVE_CLIENT_ID=
 ONEDRIVE_AUTHORITY=https://
 REMOTELYSAVE_WEBSITE=http://127.0.0.1:46683
 REMOTELYSAVE_CLIENT_ID=cli-xxx
 GOOGLEDRIVE_CLIENT_ID=xxx.apps.googleusercontent.com
 GOOGLEDRIVE_CLIENT_SECRET=GOCSPX-sss
 BOX_CLIENT_ID=
 BOX_CLIENT_SECRET=
 PCLOUD_CLIENT_ID=
 PCLOUD_CLIENT_SECRET=
 YANDEXDISK_CLIENT_ID=
 YANDEXDISK_CLIENT_SECRET=
 KOOFR_CLIENT_ID=
 KOOFR_CLIENT_SECRET=
@@ -0,0 +1,7 @@
 *.png filter=lfs diff=lfs merge=lfs -text
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.jpeg filter=lfs diff=lfs merge=lfs -text
 *.pdf filter=lfs diff=lfs merge=lfs -text
 *.enc filter=lfs diff=lfs merge=lfs -text
 *.svg filter=lfs diff=lfs merge=lfs -text
 *.excalidraw filter=lfs diff=lfs merge=lfs -text
@@ -0,0 +1,90 @@
 name: Bug Report
 description: Fire a bug report
 title: "[Bug]: "
 labels: ["bug"]
 body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: What did you expect to happen?
      placeholder: Tell us what you see!
    validations:
      required: true
  - type: dropdown
    id: os
    attributes:
      label: What OS are you using?
      multiple: true
      options:
        - Windows
        - Linux
        - macOS
        - iOS (iPhone, iPad)
        - Android
    validations:
      required: true
  - type: dropdown
    id: service
    attributes:
      label: What remote cloud services are you using? (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
  - type: input
    id: version-plugin
    attributes:
      label: Version of the plugin
      description: What version of the plugin are you running?
    validations:
      required: false
  - type: input
    id: version-obsidian
    attributes:
      label: Version of Obsidian
      description: What version of Obsidian are you running?
    validations:
      required: false
  - type: checkboxes
    id: using-password
    attributes:
      label: Using password or not
      description: Are you using password (end-to-end encryption) or not?
      options:
        - label: Yes.
          required: false
  - type: checkboxes
    id: ensure-no-sensitive-information
    attributes:
      label: Ensure no sensitive information
      description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
      options:
        - label: I ensure that no sensitive information is submitted in the issue.
          required: true
@@ -0,0 +1 @@
 blank_issues_enabled: false
@@ -0,0 +1,54 @@
 name: Feature Request
 description: Some idea about new features
 title: "[Feature Request]: "
 labels: ["enhancement"]
 body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: textarea
    id: what-are-you-expecting
    attributes:
      label: What feature are you suggesting?
      description: What feature are you suggesting?
    validations:
      required: true
  - type: dropdown
    id: service
    attributes:
      label: What remote cloud services are you using, or suggesting adding the feature to?
      multiple: true
      options:
        - S3
        - 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
  - type: checkboxes
    id: ensure-no-sensitive-information
    attributes:
      label: Ensure no sensitive information
      description: By submitting this issue, you ensure that no sensitive information is submitted in the issue.
      options:
        - label: I ensure that no sensitive information is submitted in the issue.
          required: true
@@ -5,26 +5,60 @@ name: BuildCI
 on:
  push:
-    branches: [master, enc]
+    branches: ["**"]
  pull_request:
-    branches: [master, enc]
+    branches: [master]
 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}}
      REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
      REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
      GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
      GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
      BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
      BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
      PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
      PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
      YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
      YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
      KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
      KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
    strategy:
      matrix:
        node-version: [16.x]
        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
    steps:
-      - uses: actions/checkout@v2
+      - 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
      - uses: actions/upload-artifact@v2
        with:
@@ -32,3 +66,4 @@ jobs:
          path: |
            main.js
            manifest.json
            styles.css
@@ -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,106 @@
 # 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}}
      REMOTELYSAVE_WEBSITE: ${{secrets.REMOTELYSAVE_WEBSITE}}
      REMOTELYSAVE_CLIENT_ID: ${{secrets.REMOTELYSAVE_CLIENT_ID}}
      GOOGLEDRIVE_CLIENT_ID: ${{secrets.GOOGLEDRIVE_CLIENT_ID}}
      GOOGLEDRIVE_CLIENT_SECRET: ${{secrets.GOOGLEDRIVE_CLIENT_SECRET}}
      BOX_CLIENT_ID: ${{secrets.BOX_CLIENT_ID}}
      BOX_CLIENT_SECRET: ${{secrets.BOX_CLIENT_SECRET}}
      PCLOUD_CLIENT_ID: ${{secrets.PCLOUD_CLIENT_ID}}
      PCLOUD_CLIENT_SECRET: ${{secrets.PCLOUD_CLIENT_SECRET}}
      YANDEXDISK_CLIENT_ID: ${{secrets.YANDEXDISK_CLIENT_ID}}
      YANDEXDISK_CLIENT_SECRET: ${{secrets.YANDEXDISK_CLIENT_SECRET}}
      KOOFR_CLIENT_ID: ${{secrets.KOOFR_CLIENT_ID}}
      KOOFR_CLIENT_SECRET: ${{secrets.KOOFR_CLIENT_SECRET}}
    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
@@ -13,5 +14,8 @@ main.js
 # obsidian
 data.json
 # debug
 logs.txt
 # hidden files
 .*
@@ -1,2 +0,0 @@
 node_modules/
 main.js
@@ -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.
@@ -1,202 +1,3 @@
-                                 Apache License
+The codes or files or subfolders inside the folder `src`, `tests`, `docs`, `assets`, are released under the "Open Source" license: "Apache License, version 2.0", described at: https://www.apache.org/licenses/LICENSE-2.0 .
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/
   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
   1. Definitions.
      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.
      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.
      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. 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.
      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.
      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.
      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.
      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).
      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.
      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor 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, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."
      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.
   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You 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 the
      Work and such Derivative Works in Source or Object form.
   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You 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 such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.
   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:
      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and
      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and
      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and
      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.
      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.
   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.
   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.
   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its 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. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.
   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.
   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.
   END OF TERMS AND CONDITIONS
   APPENDIX: How to apply the Apache License to your work.
      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.
   Copyright [yyyy] [name of copyright owner]
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
       http://www.apache.org/licenses/LICENSE-2.0
   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 The codes or files or subfolders inside the folder `pro`, are released under the "Source Available" license: "PolyForm Strict License 1.0.0", described at: https://polyformproject.org/licenses/strict/1.0.0/ .
@@ -1,18 +1,190 @@
-# Save Remote
+# Remotely Save
-This is yet another sync plugin for Obsidian.
+This is yet another unofficial sync plugin for Obsidian. If you like it or find it useful, please consider give it a [star ![GitHub Repo stars](https://img.shields.io/github/stars/fyears/remotely-save?style=social)](https://github.com/fyears/remotely-save) on Github.
 [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml)
 [![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
-**This is NOT the official sync service provided by Obsidian.**
+- **This is NOT the [official sync service](https://obsidian.md/sync) provided by Obsidian.**
 ## !!!Caution!!!
-As of October 2021, the plugin is under development. **DO NOT USE IT for any serious vaults.** Prepare for data loss!
+**ALWAYS, ALWAYS, backup your vault before using this plugin.**
 ## Features
 - Supports:
  - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
  - Dropbox
  - OneDrive for personal
  - Webdav (NextCloud / InfiniCloud / Synology webdav server / ...)
  - Webdis
  - Google Drive (GDrive) (PRO feature)
  - Box (PRO feature)
  - pCloud (PRO feature)
  - Yandex Disk (PRO feature)
  - Koofr (PRO feature)
  - Azure Blob Storage (PRO feature)
  - [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/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!
 - **[Sync Algorithm](./docs/sync_algorithm/v3/intro.md) is provided for discussion.**
 - **[Basic Conflict Detection And Handling](./docs/sync_algorithm/v3/intro.md)** for free version. **[Advanced Smart Conflict Handling](./pro/README.md)** for PRO version. 
 - Source Available. See [License](./LICENSE) for details.
 ## Limitations
 - **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
 You are greatly welcome to ask questions, post any suggestions, or report any bugs! The project is mainly maintained on GitHub:
 - Questions: [GitHub repo Discussions](https://github.com/fyears/remotely-save/discussions)
 - Suggestions: also in [GitHub repo Discussions](https://github.com/fyears/remotely-save/discussions)
 - Bugs: [GitHub repo Issues](https://github.com/fyears/remotely-save/issues) (NOT Discussion)
 Additionally, the plugin author may occasionally visit Obsidian official forum and official Discord server, and pay attention to this-plugin-related information there.
 ## Download and Install
 - Option #1: Search in the official "community plugin list", or visit this: [https://obsidian.md/plugins?id=remotely-save](https://obsidian.md/plugins?id=remotely-save) (which should redirect you into Obsidian app), then install the plugin.
 - Option #2: You can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin. Input `fyears/remotely-save` in the configuration of BRAT.
 - Option #3: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/fyears/remotely-save/latest/main.js?sort=semver)](https://github.com/fyears/remotely-save/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
 - Option #4: [![BuildCI](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml/badge.svg)](https://github.com/fyears/remotely-save/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
 ## Usage
-Remote service in support list:
+### S3
- [ ] AWS S3
+- Tutorials / Examples:
- [ ] webdav
+  - [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
 - **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. [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 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
 - Tutorials / Examples:
  - [Nextcloud](./docs/remote_services/webdav_nextcloud/README.md)
  - [The Good Cloud](./docs/remote_services/webdav_thegoodcloud/README.md)
  - [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)
  - [Open Media Vault](./docs/remote_services/webdav_openmediavault/README.md)
  - [Nginx (`ngx_http_dav_module`, `nginx-dav-ext-module`, with Docker)](./docs/remote_services/webdav_nginx/README.md)
  - [Apache (with Docker)](./docs/remote_services/webdav_apache/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.
 ### Google Drive (GDrive) (PRO feature)
 PRO (paid) feature "sync with Google Drive" allows users to to sync with Google Drive. Tutorials and limitations are documented [here](./docs/remote_services/googledrive/README.md).
 ### Box (PRO feature)
 PRO (paid) feature "sync with Box" allows users to to sync with Box. Tutorials and limitations are documented [here](./docs/remote_services/box/README.md).
 ### pCloud (PRO feature)
 PRO (paid) feature "sync with pCloud" allows users to to sync with pCloud (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/pcloud/README.md).
 ### Yandex Disk (PRO feature)
 PRO (paid) feature "sync with Yandex Disk" allows users to to sync with Yandex Disk (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/yandexdisk/README.md).
 ### Koofr (PRO feature)
 PRO (paid) feature "sync with Koofr" allows users to to sync with Koofr (using its native API instead of webdav). Tutorials and limitations are documented [here](./docs/remote_services/koofr/README.md).
 ### Azure Blob Storage (PRO feature)
 PRO (paid) feature "sync with Azure Blob Storage" allows users to to sync with Azure Blob Storage. Tutorials and limitations are documented [here](./docs/remote_services/azureblobstorage/README.md).
 ## Smart Conflict (PRO feature)
 Basic (free) version can detect conflicts, but users have to choose to keep newer version or larger version of the files.
 PRO (paid) feature "Smart Conflict" gives users one more option: merge small markdown files, or duplicate large markdown files or non-markdown files.
 See documents [here](./docs/pro/README.md)
 ## Scheduled Auto Sync
 - You can configure auto syncing every N minutes in settings.
 - In auto sync mode, if any error occurs, the plugin would **fail silently**.
 - Auto sync only works when Obsidian is being opened. It's **technically impossible** to auto sync while Obsidian is in background, because the plugin just works in the browser environment provided by Obsidian.
 ## Sync On Save
 - You can configure sync on save in settings.
 - In sync on save mode, if any error occurs, the plugin would **fail silently**.
 ## 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).
 ## PRO Features
 See [PRO](./docs/pro/README.md) for more details.
 ## How To Debug
 See [here](./docs/how_to_debug/README.md) for more details.
 ## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
 See [here](./docs/import_export_some_settings.md) for more details.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:a9bf1cc2403c3a32e7a6f5d5829bb065573922dc050ae2fdb8b3d34b4c87ecf5
 size 8296
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:6990a598379c457442345e50c3f056c4598a121523bc10980835c08fc7447a54
 size 10119
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:432198e63fa9676541a41436917e025d1ea6af3772139c1dea450fcc0155cfd0
 size 13054
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fe3b5b8bf9c32e57c0af366c455b11ae68eb9fb8a32f371c9c445b3e7e89cc02
 size 1120
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:f68df7bae94eb4c4cddfa6af47d7819d01a6482d4f6afe6ef3236f72f9adf15f
 size 1523
@@ -0,0 +1 @@
 This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/
@@ -0,0 +1,75 @@
 # the logo
 Some different sizes' logos are needed.
 ## license
 <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
 ## the process of creation
 No professional designers are here. Thus the following steps involve many programer styles. :-)
 1. use excalidraw and export png and svg.
   ```bash
   # results
   logo.excalidraw
   logo.png
   logo.svg
   ```
 2. manually edit the `logo.svg` and make background transparent.
   ```bash
   # results
   logo-transparent.svg
   ```
 3. use python library [`svgutils`](https://github.com/btel/svg_utils) to make a strictly square figure. The [doc](https://svgutils.readthedocs.io/en/latest/tutorials/composing_multipanel_figures.html) is very useful.
   ```python
   from svgutils.compose import *
   def get_standard_300x300(file_name):
       fig = Figure(300, 300,
           Panel(
               SVG(file_name),
           ).move(-3, 12),
       )
       return fig
   get_standard_300x300('logo-transparent.svg').save('300x300.svg')
   # def get_other_size_from_standard(file_name, px):
   #     fig = Figure(px, px,
   #         Panel(
   #             SVG(file_name).scale(px/300.0),
   #         ).move(-3*px/300.0, 12*px/300.0),
   #     )
   #     return fig
   # get_other_size_from_standard('logo.svg',256).save('256x256.svg')
   ```
   ```bash
   # results
   300x300.svg
   ```
 4. use `inkscape` command line to get different sizes' `.png` files.
   ```bash
   inkscape 300x300.svg -o 300x300.png
   inkscape 300x300.svg -o 50x50.png -w 50 -h 50
   inkscape 300x300.svg -o 64x64.png -w 64 -h 64
   inkscape 300x300.svg -o 256x256.png -w 256 -h 256
   ```
   ```bash
   # results
   50x50.png
   64x64.png
   256x256.png
   ```
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:daedd262170200cb5e8cc288898b40892771b3962cf2bc17dc443f1c82a4aa94
 size 12886
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:6b33b2a71f2d91988416c17015b59ef205dbf6a8c704ecac1cc95ed03ccc2c8e
 size 16537
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:98358aa726dcb5565164ff260634f5c527223d1f2ec1d0410b400625c8dad704
 size 14082
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:02a5057ebe38e4c3835c8354f53aca01c4c2335d8a0435e22f509b4ca4a73ca4
 size 12889
@@ -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"
      }
    }
  }
 }
@@ -1,29 +0,0 @@
 # Algorithm
 ## Sources
 We have three record sources:
 1. Local files
 2. Remote files
 3. Local "delete-or-rename" history.
 Assuming all sources are reliable.
 ## Deal with them
 We list all combinations mutually exclusive and collectively exhaustive.
 | ID  | Remote Files | Local files | Local delete rename history | Extra                                                      | Decision                                                                                          |
 | --- | ------------ | ----------- | --------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
 | 1   | exist        | exist       | ignore                      | mtime_remote > mtime_local                                 | download remote file, create local folder if not exists, clear local history if exists            |
 | 2   | exist        | exist       | ignore                      | mtime_remote < mtime_local                                 | upload local file, create remote folder if not exists, clear local history if exists              |
 | 3   | exist        | exist       | ignore                      | mtime_remote === mtime_local && size_remote === size_local | clear local history if exists (the file was synced and no changes after last sync)                |
 | 4   | exist        | exist       | ignore                      | mtime_remote === mtime_local && size_remote !== size_local | upload local file, clear local history if exists (we always prefer local to remote)               |
 | 5   | exist        | exist       | ignore                      | If local is a folder. mtime_local === undefined            | clear local history if exists. TODO: what if a folder and a previous file share the same name?    |
 | 6   | exist        | not exist   | exist                       | mtime_remote >= delete_time_local                          | download remote file, create folder if not exists                                                 |
 | 7   | exist        | not exist   | exist                       | mtime_remote < delete_time_local                           | delete remote file, clear local history                                                           |
 | 8   | exist        | not exist   | not exist                   |                                                            | download remote file, create folder if not exists                                                 |
 | 9   | not exist    | exist       | ignore                      | If local is a single file.                                 | upload local file, create remote folder if not exists, clear local history if exists              |
 | 10  | not exist    | exist       | ignore                      | If local is a folder.                                      | upload local files recursively, create remote folder if not exists, clear local history if exists |
 | 11  | not exist    | not exist   | ignore                      |                                                            | clear local history if exists                                                                     |
@@ -0,0 +1,12 @@
 # Limitations From The Browser Environment
 Obsidian desktop is developed by using [Electron](https://www.electronjs.org/). And Obsidian mobile is developed by using [Capacitor](https://capacitorjs.com/)
 Technically, the plugin (or any plugin?) runs in the js environment provided by Obsidian. And to support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
 Then some limitations are applied:
 1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
 2. [No Node.js environment.](./browser_env_no_nodejs.md)
 3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
 4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)
@@ -0,0 +1,14 @@
 # Limitations From The Browser Environment: CORS Issue
 The plugin is developed for the browser environment. The "fake" browser behind the scenes also follows the CORS policy.
 [MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
 1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
 2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
   Example configurations:
   - [Amazon S3](./s3_cors_configure.md)
   - [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))
@@ -0,0 +1,3 @@
 # Limitations From The Browser Environment: No Background Running After Obsidian Is Closed
 The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.
@@ -0,0 +1,9 @@
 # Limitations From The Browser Environment: No Node.js
 To support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
 Many js libraries are designed to work in both the browser and the Node.js environments. But some are not, because the browser doesn't provide the corresponding abilities.
 For example, there is a popular npm package [`ssh2-sftp-client`](https://www.npmjs.com/package/ssh2-sftp-client) for SFTP. But it relies on the modules (e.g. `http`) from Node.js which cannot be "translated" to the browser environment. So it's impossible to make this plugin support SFTP. The same status applies to FTP / FTPS.
 Likewise, [MEGA](https://mega.nz/) provides a SDK, but the SDK is [for C++ only](https://mega.nz/doc), so it's also impossible to make this plugin support MEGA.
@@ -0,0 +1,7 @@
 # Limitations From The Browser Environment: OAuth2 PKCE
 If the cloud service uses OAuth flow, it needs to support PKCE, because the plugin is released to the public, and no real secrets can be statically kept in the client.
 Luckily, Dropbox and OneDrive supports PKCE, making it possible for this plugin to connect to them easily.
 Dropbox has an excellent [article](https://dropbox.tech/developers/pkce--what-and-why-) explaining what is and how to use PKCE.
@@ -0,0 +1,47 @@
 ## Material Source
 To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
 ## Some Backgrounds
 1. Obsidian allows users to take notes using markdown files.
 2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
 3. Technically, remotely-save is developed using web technologies.
 ## Api Usages
 1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
 2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
 3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
 4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
 ## Steps
 Here are the steps to see the functionality of remotely-save.
 Most steps have screenshots.
 1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
 2. Open Obsidian, click the "Create" button under "Create new vault".
 3. Pick a vault name, "example-vault", and choose a location, then click "Create".
   ![step03](./attachments/step03.png)
 4. Close any update new if prompted.
 5. Create a new note by clicking a button on the left. And write something on the note.
   ![step05](./attachments/step05.png)
 6. Click "setting" (a gear icon) on the button left of the sidebar.
   ![step06](./attachments/step06.png)
 7. In the settings panel, go to the "Community plugins" page, turn off the safe mode, and confirm to turn off the safe mode. Then click the "Browse" button for community plugins.
   ![step07](./attachments/step07.png)
 8. Search "Remotely Save" and install on the result.
   ![step08](./attachments/step08.png)
 9. After successful installing the plugin, go back to the "Community plugins" page, and enable the plugin.
   ![step09](./attachments/step09.png)
 10. Go to newly added "Remotely Save" settings, select "Dropbox" in "Choose service", and click the "Auth" button.
    ![step10](./attachments/step10.png)
 11. The standard auth flow address is shown, users should click the address, and finish the auth steps on the website. Finally, the Dropbox website should automatically redirect users back to the Obsidian app.
    ![step11](./attachments/step11.png)
 12. The "Auth" button disappears. A new "Revoke Auth" appears.
    ![step12](./attachments/step12.png)
 13. Go back to the main interface of Obsidian, a new "switch icon" should appear on the left sidebar. Click this, then the plugin would trigger the sync progress. It would compare meta info of local files and remote files (on Dropbox), and decide to download some files and/or upload some files.
    ![step13](./attachments/step13.png)
 14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:655f6f487cc24af0ab86b8592622a7701c30f3369e7847a1fbb783d0962829c3
 size 52910
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fe971af94f1f7b042b7313268e4d2d8432d926ce2392e50ca2a4abc21c8a4aab
 size 57033
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:025303053f2b2cedd2bdd61cd71e1f1c0fb12e45bfbc0e81f2c0d70747133505
 size 63458
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:061707977c8046a6f924881f86aac962e2f05618e201080768246270de792040
 size 100162
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:8add61e6ef34b2470e5a5bea3e10955a86eed5ed1fc4dd398f30835485a6c455
 size 158422
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:021ae1ce29d3932f088f0954787c475be826915b794320bf212d3ba7d58656da
 size 110529
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:b225d21de5778ddc032893e0f52150ab4260b0dfbe0e9141da4aa8b03131a9da
 size 147821
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fda4f6e8cf68833f239bdc85c46802fe2131d149011074f747b1829822a38939
 size 59041
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:576801d5ebd8cf7fcd3c9c0c6df325654338854f7d762a5680e9aab3c9e6508a
 size 142155
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:1c93f681f0f7ce74cee0f2ed193f574ef915554f1a9ef96ba54afdede302f13a
 size 112057
@@ -0,0 +1,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**.
@@ -0,0 +1,46 @@
 # OpenSSL enc format
 If a password is set, the files are encrypted before being sent to the cloud.
 ## 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 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
   # file content encryption (ignoring file path encryption)
   openssl enc -p -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:somepassword -in ./sometext.txt -out ./sometext.txt.enc
   # file content decryption (ignoring file path decryption)
   openssl enc -d -p -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:somepassword -in ./sometext.txt.enc -out ./sometext.txt
   ```
 3. The file/directory path strings, are encrypted using openssl in binary mode and then `base64url without padding` is applied.
   Assuming the file path is `a-folder-文件夹/a-file-文件.md`, then the following commands are equivilent:
   ```bash
   # prepare the functions
   # https://unix.stackexchange.com/questions/628842
   base64url::encode () { base64 -w0 | tr '+/' '-_' | tr -d '='; }
   base64url::decode () { awk '{ if (length($0) % 4 == 3) print $0"="; else if (length($0) % 4 == 2) print $0"=="; else print $0; }' | tr -- '-_' '+/' | base64 -d; }
   # pure string encryption then base32
   echo -n 'a-folder-文件夹/a-file-文件.md' | openssl enc -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword | base64url::encode
   # pure string base64url then decryption
   echo -n 'U2FsdGVkX19tNkdFL5rZeHxbe7FL-Pp5mkZJkDNFJWFT6lldZlfa57j0C_cKn0I3PZ9YDvOkyoKqfF6lbn0_yg' | base64url::decode | openssl enc -d -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword
   ```
 4. The directory is considered as special "0-byte" object on remote s3. So this meta infomation may be easily guessed if some third party can access the remote bucket.
@@ -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
 ```
@@ -0,0 +1,19 @@
 # How To Debug
 Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
 ## Easy: Export Sync Plans
 See [here](./export_sync_plans.md).
 ## Advanced: Check Console Output Directly
 ...of desktop and Android.
 See [here](./check_console_output.md).
 ## Advanced: Use `Logstravaganza` to export logs
 This method works for desktop and mobile devices (iOS, Android), especially useful for iOS.
 See [here](./use_logstravaganza.md).
@@ -0,0 +1,23 @@
 # Check Console Output
 If you are using Obsidian on desktop or Android, you can check the Obsidian console.
 ## Disable Auto Sync Firstly
 You should disable auto sync to avoid any unexpected running.
 ## Set The Output Level To Debug
 Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
 ## Check The Output
 - If you are on desktop
  Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
 - If you are using Android
  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
 Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.
@@ -0,0 +1,95 @@
 # Export Sync Plans
 ## What's this?
 Everytime the plugin starts a sync, it gathers all required information together, generates a "sync plan" of every operations to every files and folders, and assign the corresponding actual operations.
 Thus, if something goes wrong, we should check the sync plan firstly.
 ## How To Export The Plans?
 Please read through the following instructions.
 ### Disable Auto Sync Firstly
 You should disable auto sync to avoid any unexpected running.
 ### Manual Sync If Not Yet
 You should at least sync once, so that at least one sync plan is generated and saved. If you have synced the vualt before, there should be some sync plans already saved.
 ### Export To The File
 Go to the plugin settings, scroll down to the section "Debug" -> "export sync plans", and click the button "Export". \*\*It would generate a new folder `_debug_remotely_save/` in your vault, and generate a file `sync_plans_hist_exported_on_{a_timestamp},md.` inside that folder.
 ## How To Read The Plans
 Open the genrated `sync_plans_hist_exported_on_{a_timestamp},md.`. You should see a json, or multiple jsons. Every json represents a sync plan.
 A sync plan looks like this:
 ```json
 {
  "ts": 1646960867560,
  "remoteType": "onedrive",
  "mixedStates": {
    "abc.md": {
      "key": "abc.md",
      "existRemote": true,
      "mtimeRemote": 1646566632000,
      "sizeRemote": 56797,
      "remoteEncryptedKey": "abc.md",
      "changeMtimeUsingMapping": true,
      "existLocal": true,
      "mtimeLocal": 1646566632000,
      "sizeLocal": 56797,
      "decision": "skipUploading",
      "decisionBranch": 1
    },
    "New folder/": {
      "key": "New folder/",
      "deltimeRemote": 1646925354372,
      "existLocal": false,
      "existRemote": false,
      "decision": "keepRemoteDelHistFolder",
      "decisionBranch": 9
    }
  }
 }
 ```
 We usually care about the `mixedStates` property. As you may guess, every item in `mixedStates` represent a file or a folder.
 We should find out the file/folder we are interested in (or we believe something goes wrong), then checkout the following properties:
 ```
 decision
  What decision is made.
 decisionBranch
  It's a mark of the actual logic in the sync code. Useful to debug.
 existRemote
  Does the file/folder exist on the remote service?
 mtimeRemote
  The "last modeified time" on the remote service.
 deltimeRemote
  The "deletion time" on the remote record.
 existLocal
  Does the file/folder exist locally?
 mtimeLocal
  The max of "last modeified time" and "creation time" locally.
 deltimeLocal
  The "deletion time" locally.
 ```
 The `decision` SHOULD be determined by the modified times and deletion times, by the logic described in [the doc of sync alogorithm](../sync_algorithm_v2.md). In short, we collect four timestamps (`mtimeRemote`, `deltimeRemote`, `mtimeLocal`, `deltimeLocal`), and respect the max timestamp and its corresponding operation.
 ## Common Issues
 Some users report that their "last modeified time"s or "creation time"s are not set correctly by the operating system. In this case, the plugin cannot do anything because it determines the sync plan by comparing the timestamps. It's suggested to check the settings of the operating system or check whether other programs are doing something to the files.
@@ -0,0 +1,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,19 @@
 ## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
 It's often verbose / inconvenient to input not-oauth2 credentials on mobile. (On different desktop computers, it's trivial to copy and paste `data.json` across different devices.)
 So this plugin has a helper function to export those settings as a QR code, then you could use mobile device's camera to import the settings.
 Attention:
 1. Oauth2 - related information is omitted. It means that Dropbox, OneDrive login credentials are NOT included in the QR Code.
 2. Please, NEVER share the QR Code to others. It's as equivalent to the login credentials.
 Steps:
 1. Configure the plugin settings on one device, and make sure the sync functions work. (E.g, you could sync notes using S3 credentials.)
 2. Open plugin settings page. Then scroll down the page, until the section "Import and Export Settings". Click the button "Get QR Code". A new modal should show up and you should see a QR code.
 3. On a second device, make sure the vault name is the same as the first device's.
 4. On that second device, use its camera app, or any apps that support scanning QR codes, to scan the QR code from the first device. (On latest iOS, the system's built in camera app should work. On Android, at least one open source app [Binary Eye](https://github.com/markusfisch/BinaryEye) is tested to be working.)
 5. A link / url / address should be identified in the scan-QR-code app, and you could follow the instruction in the app, and then you should be redirected to open the Obsidian app.
 6. And finally, there should be a new notice in the Obsidian app saying the settings are successfully imported. Otherwise please check the error message in the notice.
@@ -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.
@@ -0,0 +1,27 @@
 # Minimal Intrusive Design
 ~~Before version 0.3.0, the plugin did not upload additional 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
 Then the plugin doesn't make more-than-necessary assumptions about information on the remote endpoint.
 For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.
 And it's also possible to combine another "sync-to-s3" solution (like, another software) on desktops, and this plugin on mobile devices, together.
 ## ~~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").~~
 ~~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.~~
 ## No uploading extra metadata from 0.4.1
 Some information, including previous successful sync status of each file, is kept locally.
@@ -0,0 +1,53 @@
 # PRO Features
 From version 0.5.x, Remotely Save introduces PRO (paid) features. Users need to subscribe to (pay) them to use them.
 **If you are using basic features only, you don't need an online account, and you don't need to pay for the plugin.**
 # Links
 * Remotely Save official website: <https://remotelysave.com>
 * Sign up / Sign in: <https://remotelysave.com/user/signupin>
 * User profile: <https://remotelysave.com/user/profile>
 # Disclaimer
 It's different from, and NOT affiliated with Obsidian account.
 # Steps
 ## Steps of signing up and signing in
 1. Go to the website, sign up and sign in. You can directly visit <https://remotelysave.com/user/signupin> or click the link in Remotely Save plugin setting page.
    ![pro setting](./pro_setting.png)
 2. Use an email and your password as usual. Don't need to be GMail account.
 ## Steps of connecting
 You need to connect your plugin to your online account. In Obsidian, in your Remotely Save plugin setting, you can click the button "Connect" to start the flow.
 1. You will see a special address on website. Click it and visit the website
 2. Click "allow" on the website.
 3. In the end of the auth flow on the website, you will be shown up a code, please copy it...
 4. And paste the code back to the plugin modal inside Obsidian, and confirm.
 ![connect flow](./connect_flow.png)
 ## Steps of subscribing to some features. 
 1. Firstly please visit your [profile page](https://remotelysave.com/user/profile) online.
 2. You can subscribe to some features. Prices vary.
    ![PRO features online](./pro_features_enabled_on_website.png)
 3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled.
    ![check again PRO features](./check_pro_features_in_settings.png)
 4. Sync and enjoy your PRO features!
 ## Why so complicated?
 Because we don't have a payment method inside the plugin, so we have to:
 * build a website, 
 * require users having online accounts
 * and connect the plugin to the online account.
 Moreover, an online account allows flexible management of subscriptions. 
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:8c73da29a621d225387640b76ec0dcfb56b3ffad151dab374d3b7cc76067a1a0
 size 94377
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:116c2a8ec1a277a3985f4056b390574fc57145ec5635d44accf2a7445666264a
 size 626668
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:4c45c08e6fc487341032aac511c332e3f9978a44e9b93377a73648b56b684b62
 size 155427
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:08d128125dba033f5dd18a6ea8d942b284ddca6c5c3b0362c47dcb4a7153a8f9
 size 395800
@@ -0,0 +1,107 @@
 # Azure Blob Storage (GDrive) (PRO)
 # Intro
 * It's a PRO feature of Remotely Save plugin.
 * **This plugin is NOT an official Microsoft / Azure product, and just uses Azure Blob Storage's public api.**
 # Disclaimer
 I (author of Remotely Save) is **NOT** an expert of Azure products. The tutorials here are for references only. Azure products are very complex.
 ***As far as the law allows, the software (Remotely Save) comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
 # Steps
 Please read through the following steps before you actually connect.
 ## Preparation In Azure Blob Storage Side
 You only need to do this **once**, before the Container SAS Url expires in the future.
 In short, you need to: configure CORS and configure a policy and cobtain a Container SAS Url.
 1. Connect to the service:
    Download Microsoft's free [Azure Storage Explorer](https://azure.microsoft.com/en-us/products/storage/storage-explorer). The following tutorial uses this app. Actually you may be able to find the same settings on Azure official website.
    Use this app to connect to your Blob Storage service or account.
 2. CORS:
    Right click on `Blob containers`, click "configure CORS". Add a rule, enter the following and save:
    ```
    Allowed Origins: *
    Allowed Methods: DELETE,GET,HEAD,MERGE,POST,PATCH,OPTIONS,PUT
    Allowed Headers: x-ms-*, content-type
    Exposed Headers: x-ms-*, content-type
    Max Age (in seconds): 5
    ```
    ![CORS screenshot](./azure_cors.png)
 3. Create the container:  
    Create the container if you don't have one. In this tutorial, we use `example-container`.
    ![container screenshot](./azure_example_container.png)
 4. Generate a policy:
    * Right click on you container, click "Manage Stored Access Policies". 
    * Choose your id, for example `example-container-0000001`.
    * Change to Expiry time to an appropriate date. **By default it is only valid for a week.** After its expiration, you need come back and adjust the expiry date again! In this tutorial, we set it to a year.
    * And allow these methods: Read, Add, Create, Write, Delete, List.
    * Save
    Read Microsoft's official [doc](https://learn.microsoft.com/en-us/rest/api/storageservices/define-stored-access-policy) for more info. The main benefit of generating an access policy is easier revocation of SAS Url if anything goes bad. 
    ![Manage Stored Access Policies screenshot](./azure_policy_1.png)
    ![Add Policy screenshot](./azure_policy_3.png)
 5. Generate a Container SAS Url:
    Then we want to create a container level SAS (shared access signature) url.
    * Right click on you container, click "Get Shared Access Signature". 
    * In access policy, choose the previous one you created: for example `example-container-0000001`.
    * Save the setting
    * You will see a url is generated, which starts with `https://` or `http://`. It should looks like `https://<account>.blob.core.windows.net/<container name>?sv=...&sig=...`
    * Save the Container SAS Url somewhere, and you will need this later.
    Read Microsoft's official [doc](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview) for more info.
    ![Container SAS Url screenshot 1](./azure_sas_1.png)
    ![Container SAS Url screenshot 2](./azure_sas_2.png)
 ### Why so complicated in Azure settings?
 Because Azure Blob Storage's api has some limitation in browser environment, so we need to configure CORS and SAS. Because we want to revoke the SAS when needed, we need to use a policy.
 ### Revocation
 If you suspect someone read the resource unexpectedly, you can revoke the SAS by changing the name or expiry date of the policy. And generate the SAS Url again.
 ## Steps of Remotely Save subscription
 1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
 2. Subscribe to "sync with Azure Blob Storage" feature online.
 3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Azure Blob Storage should be detected.
 ## Steps of Connecting to your Azure Blob Storage
 After you enabled the PRO feature in your Remotely Save plugin, **and prepared the Container SAS Url**, you can connect to your Azure Blob Storage account now.
 1. In Remotely Save settings, change your sync service to Azure Blob Storage.
 2. Input your Container SAS Url
 3. Input your container name.
 4. By default, the plugin will save your vault remotely with a prefix `<your vault name>/`. You can change the prefix. No prefix is not allowed.
 5. Check the connection. A notice will tell you that you've connected or not.
 7. Sync! The plugin will upload the fils and "folders" of your vault into your Azure Blob Storage with the preix.
 8. **Read the caveats below.**
 ![RS setting screenshot](./azure_rs_setting.png)
 # The caveats
 * As of June 2024, this feature is in alpha stage. **Back up your vault before using this feature.**
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:83caba9a42772f995035e3c879c6119eabcd6d3c27298cf0fb067b3676680571
 size 107057
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:ef2d525d3ac7ecca26f7f8b6782fb1056d54f8c558a8d77586571defb7e6b5be
 size 41282
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:cba5bf27e76eaf8ea21e51e43172501fc4867539c90c1758a02945477dc261ea
 size 132487
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:0b2add8a559eab0b7073f7ed52d4a3e4efae68b499c7b924d1ac50278758961b
 size 193894
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:582a69a7aee2cfab72dc14324e4a864acab92c145d533e799f8ceea61a8f0102
 size 478941
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:cbb8863d98d8826739b5bf9fa4c7a2de3ba49fde4bbe3c4988a877ba74f89abd
 size 143007
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:ddc30f97d75d7c3a6061cbb30cc991cbdf1f4039aad3547ef88998c3dd9be666
 size 132904
@@ -0,0 +1,34 @@
 # Box (PRO)
 # Links
 <https://www.box.com/>
 # Intro
 * It's a PRO feature of Remotely Save plugin.
 * **This plugin is NOT an official Box product, and just uses Box's public api.**
 # Steps
 ## Steps of Remotely Save subscription
 1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
 2. Subscribe to "sync with Box" feature online.
 3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Box should be detected.
 ## Steps of Connecting to your Box
 After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Box account now.
 1. In Remotely Save settings, change your sync service to Box.
 2. Click Auth, visit the link, go to Box website to start.
 3. Follow the instruction on Box, and allow Remotely Save to connect.
 4. You will be redirected back to Remotely Save plugin.
 5. A notice will tell you that you've connected or not.
 6. Sync! The plugin will create a vault folder in the root of your Box and upload notes into that folder.
 7. **Read the caveats below.**
 # The caveats
 * As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
@@ -0,0 +1,59 @@
 # Google Drive (GDrive) (PRO)
 # Intro
 * It's a PRO feature of Remotely Save plugin.
 * **This plugin is NOT an official Google product, and just uses Google Drive's public api.**
 # Steps
 ## Steps of Remotely Save subscription
 1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
 2. Subscribe to "sync with Google Drive" feature online.
 3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Google Drive should be detected.
 ## Steps of Connecting to your Google Drive
 After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Google Drive account now.
 1. In Remotely Save settings, change your sync service to Google Drive.
    ![change remote to google drive](./change_remote_to_google_drive.png)
 2. Click Auth, visit the link, go to Remotely Save website to start.
    ![visit start link](./google_drive_auth_link.png)
 3. On the website, click the link to go to Google Drive auth page.
 4. Follow the instruction on Google website, and allow (continue) Remotely Save to connect.
    ![allow Remotely Save in Google website](./google_drive_auth_allow.png)
 5. You will be redirected to Remotely Save website, and you will get a code. Copy it...
    ![redirected back and get the code](./google_drive_auth_code_show.png)
 6. ... And paste the code back to the plugin inside Obsidian. Click submit.
    ![submit the code in setting](./google_drive_code_submit.png)
 7. A notice will tell you that you've connected or not.
 8. Sync! The plugin will create a vault folder in the root of your Google Drive and upload notes into that folder.
 9. **Read the caveats below.**
 # Why so complicated?
 Because Google Drive's api doesn't fit into the special envorinment of Obsidian plugin. So we need a website.
 # The credential
 The website does **NOT** store or save the Google drive credential (the code you obtian in the end of the flow). The website is just a "bridge" to help you obtain that code, and just manage your subscription to PRO features.
 But please be aware that the code is saved locally in your Obsidian. It works like a special password. So that the plugin can upload or download or modify the files for you.
 # The caveats
 * As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
 * The plugin can **only** sees, reads or writes the files and folders created by itself! 
    It means that, you CANNOT manually create the vault folder in your Google Drive account. And if you manually upload any files using Google's official website, the plugin does **NOT** see them. All operations must go through Obsidian and uploaded by the plugin.
    You can, however, view, and download the files on Google Drive [official web page](https://drive.google.com/drive/u/0/my-drive).
    Precisely speaking, the plugin applies for the `drive.file` scope recommended by Google. See [the doc](https://developers.google.com/drive/api/guides/api-specific-auth#benefits) by Google for the scope's benefits. Basically the plugin will never (is unable to) mess up your other files or folders.
    Moreover, this scope is "not-sensitive", so that the plugin doesn't need to go through Google's complicated verification process while applying for it.
 * Google Drive, unlike other cloud storage, allows files of same name co-existing in the same folder! (hmmmmm...) It may or may not make the plugin stop working. Users might need to remove the duplicated file manually on Google's official website.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:eaa9aa8ba6b066dfefdce08a8d1da1d97089f5c2de0ba4c0c026d6df9eb9ece8
 size 99896
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:6683a63718053603ae7dde44063a3807ba0def7e935da0b40fcc8e181afd24ae
 size 342848
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:310bd4c7d5fe19521ec7184b2eee749f0eecf00397f2b8e68480c23b4fd7c943
 size 153504
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:dcebb1f73829670883071447a8eee46c972b26fe8735c7422949cb6fe927b8ab
 size 179369
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:7e5a85c28f5614e4de75eacc021c2876d36596bcb77f0744a6edcff7777b9530
 size 155004
@@ -0,0 +1,38 @@
 # Koofr (PRO)
 # Links
 <https://koofr.eu/>
 # Intro
 * It's a PRO feature of Remotely Save plugin.
 * **This plugin is NOT an official Koofr product, and just uses Koofr's public api.**
 # Steps
 ## Steps of Remotely Save subscription
 1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
 2. Subscribe to "sync with Koofr" feature online.
 3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with Koofr should be detected.
 ## Steps of Connecting to your Koofr
 After you enabled the PRO feature in your Remotely Save plugin, you can connect to your Koofr account now.
 1. In Remotely Save settings, change your sync service to Koofr.
 2. Click Auth, visit the link, go to Koofr website to start.
 3. Follow the instruction on Koofr, and allow Remotely Save to connect.
 4. You will be redirected back to Remotely Save plugin.
 5. A notice will tell you that you've connected or not.
 6. Sync! The plugin will create a vault folder in the root of your Koofr and upload notes into that folder.
 7. **Read the caveats below.**
 # The caveats
 * As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
 # Why not use webdav?
 The Remotely Save PRO feture "sync with Koofr" is developed using Koofr's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
@@ -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,40 @@
 # pCloud (PRO)
 # Links
 <https://www.pcloud.com/>
 # Intro
 * It's a PRO feature of Remotely Save plugin.
 * **This plugin is NOT an official pCloud product, and just uses pCloud's public api.**
 # Steps
 ## Steps of Remotely Save subscription
 1. Please sign up and sign in an online account, connect your plugin to your online account firstly. See [the PRO tutorial](../../pro/README.md) firstly.
 2. Subscribe to "sync with pCloud" feature online.
 3. Go back to your Remotely Save plugin inside Obsidian, click "Check again" button in PRO settings. So that the plugin knows some features are enabled. In this case, sync with pCloud should be detected.
 ## Steps of Connecting to your pCloud
 After you enabled the PRO feature in your Remotely Save plugin, you can connect to your pCloud account now.
 1. In Remotely Save settings, change your sync service to pCloud.
 2. Click Auth, visit the link, go to pCloud website to start.
 3. Follow the instruction on pCloud, and allow Remotely Save to connect.
 4. You will be redirected back to Remotely Save plugin.
 5. A notice will tell you that you've connected or not.
 6. Sync! The plugin will create a vault folder in the root of your pCloud and upload notes into that folder.
 7. **Read the caveats below.**
 # The caveats
 * As of June 2024, this feature is in beta stage. **Back up your vault before using this feature.**
 * pCloud's API seems to not allow uploading empty files. You can choose to skip them or raise errors in Remotely Save plugin's settings.
 # Why not use webdav?
 1. pCloud only provides webdav for Premium. If you are a Premium user, you can still use pCloud webdav with Remotely Save.
 2. The Remotely Save PRO feture "sync with pCloud" is developed using pCloud's native API, instead of webdav interface. It brings benefits such that the last modified time can be preserved.
@@ -0,0 +1,53 @@
 # Backblaze B2
 ## Links
 https://www.backblaze.com/cloud-storage
 ## Steps
 1. Create a Backblaze account [on this page](https://www.backblaze.com/cloud-storage). Credit card info _is not_ required. Backblaze B2 offers 10 GB of free storage.
 2. Please be aware that, though B2 provides some free quota, **it may still cost you money if the usage of storage or api requests exceed a certain value!!!** Especially pay attention to the api requests!!!
 3. Create a **bucket**, you can leave the default settings, or you can enable the encryption (which is different from what you can set in Remotely Save):
   ![](./s3_backblaze_b2-1-bucket.png)
   ![](./s3_backblaze_b2-2-create_bucket.png)
 4. Copy `Endpoint`, eg. `s3.us-east-005.backblazeb2.com` — it'll be used later.
 5. Copy `bucketname` near the 🪣 icon (the "bucket icon") — it'll be used later.
   ![](./s3_backblaze_b2-3-copy.png)
 6. Go to **Application Keys**:
   ![](./s3_backblaze_b2-4-app_keys.png)
 7. **Add a new key**:
   ![](./s3_backblaze_b2-5-add_new_app_keys.png)
   ![](./s3_backblaze_b2-6-app_keys_copy.png)
 8. Save `keyID` and `applicationKey` — they will be used later.
 9. Go to Remotely Save settings in Obsidian and:
   - Choose `S3 or compatibile` in **Remote Service**:
   - Copy `Endpoint` from Backblaze (see 3. above) to `Endpoint` in Remotely Save
   - From `endpoint` take `region` (eg. `us-east-005`) and paste it in `endpoint` in Remotely Save
   - Copy `keyID` (see 7. above) to `Access Key ID` in Remotely Save
   - Copy `applicationKey` (see 7. above) to `Secret Access Key` in Remotely Save
   - Copy `bucketname` (see 4. above) to `Bucket Name` in Remotely Save
     ![](./s3_backblaze_b2-7-copy_paste.png)
 10. **Enable Bypass CORS**:
    ![](./s3_backblaze_b2-8-cors.png)
 11. Click **Check** in _Check Connectivity_ to see if you can connect to B2 bucket:
    ![](./s3_backblaze_b2-9-check_connectionpng.png)
 12. Sync!
    ![](./s3_backblaze_b2-10-sync.png)
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:fae18a84bb218461aca01c7de47ddadfd2b451d865ec889c098cd6918f6e8773
 size 59679
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:9389f9c4462740371edb548f7e05191ede5277a5d470e3254c60fbcc4a75e552
 size 4558
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:46f35968938ebf3bbafae64ee49a4927844fd0abf79e4190522be91776d9fed0
 size 107623
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:7fb639c7b4e595516594ee9d07c864e7cd15b608a97c81386f4cf72d499d0e5f
 size 80121
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:299bfca82b77de86f60d8f481b5f74069dc977dece19fa025ee629d1e6f783d4
 size 6499
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:5985e918b521c91cc185f60c58cdd334ee76695b897a02e02eaa17c1bad71609
 size 10214
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:5796791bcf89c99c1e1e844c0083739fd46b1a458dc274f3c3fa3f65b87b71b3
 size 70728
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:3633379fcb12f1a5e0a4d1d68c193ddc7bf0be7edd92f2f6006351817035a94f
 size 27164
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:9e130be182ae7d3270e5de3fec442ac5e81efd61822e844cd61ed24c7e485d39
 size 16802
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:29a8971fea065fd86223850198640f4072ee3fda2112820829cda1348f122c59
 size 11103
@@ -0,0 +1,27 @@
 # Cloudflare R2
 ## Links
 <https://www.cloudflare.com/developer-platform/r2/>
 ## Steps
 1. **Be aware that it may cost you money.**
 2. Create a Cloudflare account and enable R2 feature. **Credit card info might be required by Cloudflare**, though Cloudflare provides generous free tier and zero egress fee.
 3. Create a bucket.
   ![](./s3_cloudflare_r2_create_bucket.png)
 4. Create an Access Key with "Object Read & Write" permission, and add specify to your created bucket. During the creation, you will also get the auto-generated secret key, and the endpoint address.
   ![](./s3_cloudflare_r2_create_api_token.png)
 5. In remotely-save setting page, input the address / bucket / access key / secret key. **Region being set to `us-east-1` is sufficient.** Enable "Bypass CORS", because usually that's what you want.
   Click "check connectivity". (If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.)
   ![](./s3_cloudflare_r2_rs_settings.png)
 6. Sync!
 ## And Issue Related To "Check Connectivity"
 If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.
 Cloudflare doesn't allow `HeadBucket` for access keys with "Object Read & Write". So it may be possible that checking connectivity is not ok but actual syncing is ok. New version >= 0.3.29 of the plugin fix this problem by using `ListObjects` instead of `HeadBucket`.
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:49a5cd07e538205ba733dc3ccb30e4e7da1290a4a80aefe08afac19fd2db2232
 size 467448
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:61fc0812fe96871eed507d2f6b7bbad790ab70e95ff5fe764f8f8b2ab8ce82c2
 size 153015
@@ -0,0 +1,3 @@
 version https://git-lfs.github.com/spec/v1
 oid sha256:02f9c0fea36679e54c8c3fac979bc41d15ae4f7992b269bc2b67255059af1d2f
 size 579889
@@ -0,0 +1,33 @@
 # How To Configure S3 CORS Rules
 If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
 Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
 Please try this config:
 ```json
 [
  {
    "AllowedHeaders": ["*"],
    "AllowedMethods": ["GET", "PUT", "POST", "DELETE", "HEAD"],
    "AllowedOrigins": [
      "app://obsidian.md",
      "capacitor://localhost",
      "http://localhost"
    ],
    "ExposeHeaders": [
      "Content-Length",
      "Content-Type",
      "Connection",
      "Date",
      "ETag",
      "Server",
      "x-amz-delete-marker",
      "x-amz-id-2",
      "x-amz-request-id",
      "x-amz-version-id"
    ]
  }
 ]
 ```
@@ -0,0 +1,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
--- a/Show More
+++ b/Show More
		`@@ -0,0 +1 @@`
							`This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/`
		`@@ -0,0 +1,3 @@`
							`# Limitations From The Browser Environment: No Background Running After Obsidian Is Closed`

							`The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.`