bump to 0.3.38

concurrency should not influence the sync
digest ok
2024-01-21 14:40:09 +08:00 · 2024-01-21 14:31:39 +08:00 · 2024-01-21 14:19:27 +08:00 · 2024-01-20 22:23:46 +08:00 · 2024-01-20 13:13:31 +08:00 · 2024-01-20 13:03:46 +08:00
145 changed files with 11914 additions and 1754 deletions
@@ -23,6 +23,6 @@ indent_size = 4
 indent_style = tab

 # Indentation override for all JS under lib directory
-[*.{js,jsx,mjs,cjs,ts,tsx,json,py}]
+[*.{js,jsx,mjs,cjs,ts,tsx,json}]
 indent_style = space
 indent_size = 2
@@ -0,0 +1,3 @@
+DROPBOX_APP_KEY=
+ONEDRIVE_CLIENT_ID=
+ONEDRIVE_AUTHORITY=https://
@@ -3,3 +3,5 @@
 *.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,7 +5,7 @@ name: BuildCI

 on:
  push:
-    branches: [master]
+    branches: ["**"]
  pull_request:
    branches: [master]

@@ -15,6 +15,11 @@ jobs:

    environment: env-for-buildci

+    env:
+      DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
+      ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
+      ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
+
    strategy:
      matrix:
        node-version: [16.x]
@@ -25,6 +30,7 @@ jobs:
        uses: actions/checkout@v2
        with:
          lfs: true
+          submodules: recursive
      - name: Checkout LFS
        run: git lfs checkout
      - name: Use Node.js ${{ matrix.node-version }}
@@ -0,0 +1,86 @@
+# modified from https://github.com/argenos/nldates-obsidian/blob/master/.github/workflows/release.yml
+# which is released under MIT License
+
+# trigger:
+# modify manifest.json, package.json, versions.json
+# git tag <version number>
+# git push origin --tags
+
+name: Release A New Version
+
+on:
+  push:
+    tags:
+      - "*" # Push events to matching any tag format, i.e. 1.0, 20.15.10
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    environment: env-for-buildci
+
+    env:
+      DROPBOX_APP_KEY: ${{secrets.DROPBOX_APP_KEY}}
+      ONEDRIVE_CLIENT_ID: ${{secrets.ONEDRIVE_CLIENT_ID}}
+      ONEDRIVE_AUTHORITY: ${{secrets.ONEDRIVE_AUTHORITY}}
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - name: Checkout codes
+        uses: actions/checkout@v2
+        with:
+          lfs: true
+          submodules: recursive
+      - name: Checkout LFS
+        run: git lfs checkout
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm test
+      - run: npm run build
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ github.ref }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: false
+          prerelease: true
+      - name: Upload main.js
+        id: upload-main
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./main.js
+          asset_name: main.js
+          asset_content_type: text/javascript
+      - name: Upload manifest.json
+        id: upload-manifest
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./manifest.json
+          asset_name: manifest.json
+          asset_content_type: application/json
+      - name: Upload styles.css
+        id: upload-styles
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./styles.css
+          asset_name: styles.css
+          asset_content_type: text/css
@@ -5,6 +5,7 @@
 # npm
 node_modules
 package-lock.json
+pnpm-lock.yaml

 # build
 main.js
@@ -1,2 +1,3 @@
 node_modules/
 main.js
+data.json
@@ -1,6 +1,10 @@
 # Remotely Save

-This is yet another unofficial 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

@@ -8,27 +12,33 @@ This is yet another unofficial sync plugin for Obsidian.

 ## !!!Caution!!!

-As of Dec 2021, the plugin is considered in BETA stage. **DO NOT USE IT for any serious vaults.** **ALWAYS, ALWAYS, backup your vault before using this plugin.**
+**ALWAYS, ALWAYS, backup your vault before using this plugin.**

 ## Features

 - Supports:
-  - Amazon S3 or S3-compatible
+  - Amazon S3 or S3-compatible (Cloudflare R2 / BackBlaze B2 / MinIO / ...)
  - Dropbox
+  - OneDrive for personal
  - Webdav
- **Obsidiain Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
+  - [Here](./docs/services_connectable_or_not.md) shows more connectable (or not-connectable) services in details.
+- **Obsidian Mobile supported.** Vaults can be synced across mobile and desktop devices with the cloud service as the "broker".
 - **[End-to-end encryption](./docs/encryption.md) supported.** Files would be encrypted using openssl format before being sent to the cloud **if** user specify a password.
+- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon, or using the command from the command palette (or even bind the hot key combination to the command then press the hot key combination).
 - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).**
+- **Skip Large files** and **skip paths** by custom regex conditions!
 - **Fully open source under [Apache-2.0 License](./LICENSE).**
- **[Sync Algorithm open](./docs/sync_algorithm.md) for discussion.**
+- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.**

 ## Limitations

- **Users have to trigger the sync manually.** This design is intentional because the plugin is in beta, and it's better for users to be exactly aware of the running of this plugin.
- **"deletion" operation can only be triggered from local device.** It's because of the "[minimal intrusive design](./docs/minimal_intrusive_design.md)". May be changed in the future.
+- **To support deletions sync, extra metadata will also be uploaded.** See [Minimal Intrusive](./docs/minimal_intrusive_design.md).
 - **No Conflict resolution. No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins.
- **Cloud services cost you money.** Always be aware of the costs and pricing.
- **All files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+- **Cloud services cost you money.** Always be aware of the costs and pricing. Specifically, all the operations, including but not limited to downloading, uploading, listing all files, calling any api, storage sizes, may or may not cost you money.
+- **Some limitations from the browser environment.** More technical details are [in the doc](./docs/browser_env.md).
+- **You should protect your `data.json` file.** The file contains sensitive information.
+  - It's strongly advised **NOT** to share your `data.json` file to anyone.
+  - It's usually **NOT** a good idea to check the file into version control. By default, the plugin tries to create a `.gitignore` file inside the plugin directory if it doesn't exist, for ignoring `data.json` in the `git` version control. If you know exactly what it means and want to remove the setting, please modify the `.gitignore` file or set it to be empty.

 ## Questions, Suggestions, Or Bugs

@@ -42,35 +52,72 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a

 ## Download and Install

- Option #1: You can search, download, and install the plugin in official "community plugin list".
- Option #2: [![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.
- Option #3: Besides manually downloading the files, you can also use [Obsidian42 - BRAT](https://github.com/TfTHacker/obsidian42-brat) to install this plugin.
+- 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

 ### S3

+- Tutorials / Examples:
+  - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
+  - [BackBlaze B2](./docs/remote_services/s3_backblaze_b2/README.md)
+  - [腾讯云 COS](./docs/remote_services/s3_tencent_cloud_cos/README.zh-cn.md) | [Tencent Cloud COS](./docs/remote_services/s3_tencent_cloud_cos/README.md)
+  - [MinIO](./docs/remote_services/s3_minio/README.md)
 - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault.
- Configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`. It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android.
+- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
 - Download and enable this plugin.
- Enter your infomation to the settings of this plugin.
+- Enter your information to the settings of this plugin.
 - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud.
- Click the new "switch" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (No "auto sync" yet.)
+- Click the new "circle arrow" icon on the ribbon (the left sidebar), **every time** you want to sync your vault between local and remote. (Or, you could configure auto sync in the settings panel (See next chapter).) While syncing, the icon becomes "two half-circle arrows". Besides clicking the icon on the sidebar ribbon, you can also activate the corresponding command in the command palette.
 - **Be patient while syncing.** Especially in the first-time sync.

 ### Dropbox

- **This plugin's function for Dropbox is not as mature as functions for S3.**
 - **This plugin is NOT an official Dropbox product.** The plugin just uses Dropbox's public API.
 - After the authorization, the plugin can read your name and email (which cannot be unselected on Dropbox api), and read and write files in your Dropbox's `/Apps/remotely-save` folder.
- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions.
- Password-based end-to-end encryption is also supported.
+- If you decide to authorize this plugin to connect to Dropbox, please go to plugin's settings, and choose Dropbox then follow the instructions. [More with screenshot is here](./docs/dropbox_review_material/README.md).
+- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
+
+### OneDrive 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**.

 ### webdav

- **webdav support is considered experimental.**
- Currently only supports BASIC authorization method.
- Currently webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies.
-  - Popular software NextCloud and OwnCloud do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin.
-  - The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
- Password-based end-to-end encryption is also supported.
+- Tutorials / Examples:
+  - [ownCloud](./docs/remote_services/webdav_owncloud/README.md)
+  - [InfiniCloud](./docs/remote_services/webdav_infinicloud_teracloud/README.md)
+  - [Synology webdav server](./docs/remote_services/webdav_synology_webdav_server/README.md) | [群晖 webdav server](./docs/remote_services/webdav_synology_webdav_server/README.zh-cn.md)
+  - [AList（中文）](./docs/remote_services/webdav_alist/README.zh-cn.md) | [AList (English)](./docs/remote_services/webdav_alist/README.md)
+  - [坚果云](./docs/remote_services/webdav_jianguoyun/README.zh-cn.md) | [JianGuoYun/NutStore](./docs/remote_services/webdav_jianguoyun/README.md)
+- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/webdav_general/webav_cors.md).
+- Your data would be synced to a `${vaultName}` sub folder on your webdav server.
+- Password-based end-to-end encryption is also supported. But please be aware that **the vault name itself is not encrypted**.
+
+## 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.
+
+## How To Deal With Hidden Files Or Folders
+
+**By default, all files or folder starting with `.` (dot) or `_` (underscore) are treated as hidden files, and would NOT be synced.** It's useful if you have some files just staying locally. But this strategy also means that themes / other plugins / settings of this plugin would neither be synced.
+
+In the latest version, you can change the settings to allow syncing `_` files or folders, as well as `.obsidian` special config folder (but not any other `.` files or folders).
+
+## How To Debug
+
+See [here](./docs/how_to_debug/README.md) for more details.
+
+## 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,25 @@
+// Importing the http module
+const http = require("http");
+
+const requestHandler = (req, res) => {
+  let body = [];
+  req
+    .on("data", (chunk) => {
+      body.push(chunk);
+    })
+    .on("end", () => {
+      const parsed = JSON.parse(Buffer.concat(body).toString());
+      const prettyParsed = JSON.stringify(parsed, null, 2);
+      console.log(prettyParsed);
+      res.setHeader("Content-Type", "application/json");
+      res.end(prettyParsed);
+    });
+};
+
+const server = http.createServer(requestHandler);
+
+const addr = "0.0.0.0";
+const port = 3000;
+server.listen(port, addr, undefined, () => {
+  console.log(`Server is Running on ${addr}:${port}`);
+});
@@ -0,0 +1,12 @@
+# Limitations From The Browser Environment
+
+Obsidian desktop is developed by using [Electron](https://www.electronjs.org/). And Obsidian mobile is developed by using [Capacitor](https://capacitorjs.com/)
+
+Technically, the plugin (or any plugin?) runs in the js environment provided by Obsidian. And to support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
+
+Then some limitations are applied:
+
+1. [The CORS issue (solved in the new Obsidian version on some platforms).](./browser_env_cors.md)
+2. [No Node.js environment.](./browser_env_no_nodejs.md)
+3. If the cloud service uses OAuth flow, it needs to support PKCE. More details are [here](./browser_env_oauth2_pkce.md).
+4. [No background running after Obsidian is closes.](./browser_env_no_background_after_closing.md)
@@ -0,0 +1,14 @@
+# Limitations From The Browser Environment: CORS Issue
+
+The plugin is developed for the browser environment. The "fake" browser behind the scenes also follows the CORS policy.
+
+[MDN has a doc about CORS.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
+
+1. From Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, Obsidian [provides a new API `requiestUrl`](https://forum.obsidian.md/t/obsidian-release-v0-13-25-insider-build/32701), that allows the plugin to fully bypass the CORS issue. As of Mar 2022, the latest public-released Obsidian desktop has supported this API, but the Obsidian mobile still stays in insider.
+
+2. For using this plugin in Obsidian desktop < 0.13.25 or mobile < 1.1.1, we need to configure the server side to return the header `Access-Control-Allow-Origin` allowing the origins `app://obsidian.md` and `capacitor://localhost` and `http://localhost`.
+
+   Example configurations:
+
+   - [Amazon S3](./s3_cors_configure.md)
+   - [Apache](./apache_cors_configure.md) ([contributed by community](https://github.com/remotely-save/remotely-save/pull/31))
@@ -0,0 +1,3 @@
+# Limitations From The Browser Environment: No Background Running After Obsidian Is Closed
+
+The plugin treats Obsidian as a special browser, and is in fact some js codes. So if Obsidian is closed, then the browser environment stops, then the plugin will be stopped.
@@ -0,0 +1,9 @@
+# Limitations From The Browser Environment: No Node.js
+
+To support the mobile Obsidian, the plugin is limited to be developed for the browser environment, instead of the Node.js environment.
+
+Many js libraries are designed to work in both the browser and the Node.js environments. But some are not, because the browser doesn't provide the corresponding abilities.
+
+For example, there is a popular npm package [`ssh2-sftp-client`](https://www.npmjs.com/package/ssh2-sftp-client) for SFTP. But it relies on the modules (e.g. `http`) from Node.js which cannot be "translated" to the browser environment. So it's impossible to make this plugin support SFTP. The same status applies to FTP / FTPS.
+
+Likewise, [MEGA](https://mega.nz/) provides a SDK, but the SDK is [for C++ only](https://mega.nz/doc), so it's also impossible to make this plugin support MEGA.
@@ -0,0 +1,7 @@
+# Limitations From The Browser Environment: OAuth2 PKCE
+
+If the cloud service uses OAuth flow, it needs to support PKCE, because the plugin is released to the public, and no real secrets can be statically kept in the client.
+
+Luckily, Dropbox and OneDrive supports PKCE, making it possible for this plugin to connect to them easily.
+
+Dropbox has an excellent [article](https://dropbox.tech/developers/pkce--what-and-why-) explaining what is and how to use PKCE.
@@ -0,0 +1,47 @@
+## Material Source
+
+To apply for the production use of Dropbox API, some descriptions are needed to be submitted to Dropbox. Coincidently, this can also be served as a "readme" to use this plugin with Dropbox.
+
+## Some Backgrounds
+
+1. Obsidian allows users to take notes using markdown files.
+2. The "app", remotely-save. is an unofficial Obsidian plugin, helping users download and upload ("sync") their notes from and to Dropbox.
+3. Technically, remotely-save is developed using web technologies.
+
+## Api Usages
+
+1. remotely-save uses "App folder", to avoid unnecessary accessing users' other files.
+2. remotely-save uses "account_info.read", to get the displayed username, so that users know which of their accounts has been logged in after OAuth steps.
+3. remotely-save uses "files.content.read", so that it can read the "last modified time", and the content of files on Dropbox. Under some conditions, the plugin would download the files. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp on Dropbox is larger, the plugin would download the "newer" file from Dropbox to local.
+4. remotely-save uses "files.content.write", so that it can upload or overwrite the content of files on Dropbox. Under some conditions, the plugin would do that. For example, the plugin would compare the last modified timestamps of the file in the local device and that on Dropbox, and if the timestamp in the local device is larger, the plugin would upload the "newer" file from local to Dropbox, and overwrite that file on Dropbox.
+
+## Steps
+
+Here are the steps to see the functionality of remotely-save.
+
+Most steps have screenshots.
+
+1. Download the note-taking app Obsidian (Windows or Mac versions are both ok) from its official website: https://obsidian.md/ . It's free to download and use. Then install it.
+2. Open Obsidian, click the "Create" button under "Create new vault".
+3. Pick a vault name, "example-vault", and choose a location, then click "Create".
+   ![step03](./attachments/step03.png)
+4. Close any update new if prompted.
+5. Create a new note by clicking a button on the left. And write something on the note.
+   ![step05](./attachments/step05.png)
+6. Click "setting" (a gear icon) on the button left of the sidebar.
+   ![step06](./attachments/step06.png)
+7. In the settings panel, go to the "Community plugins" page, turn off the safe mode, and confirm to turn off the safe mode. Then click the "Browse" button for community plugins.
+   ![step07](./attachments/step07.png)
+8. Search "Remotely Save" and install on the result.
+   ![step08](./attachments/step08.png)
+9. After successful installing the plugin, go back to the "Community plugins" page, and enable the plugin.
+   ![step09](./attachments/step09.png)
+10. Go to newly added "Remotely Save" settings, select "Dropbox" in "Choose service", and click the "Auth" button.
+    ![step10](./attachments/step10.png)
+11. The standard auth flow address is shown, users should click the address, and finish the auth steps on the website. Finally, the Dropbox website should automatically redirect users back to the Obsidian app.
+    ![step11](./attachments/step11.png)
+12. The "Auth" button disappears. A new "Revoke Auth" appears.
+    ![step12](./attachments/step12.png)
+13. Go back to the main interface of Obsidian, a new "switch icon" should appear on the left sidebar. Click this, then the plugin would trigger the sync progress. It would compare meta info of local files and remote files (on Dropbox), and decide to download some files and/or upload some files.
+    ![step13](./attachments/step13.png)
+14. Create, edit, remove some notes, and repeat step 13, the files on Dropbox should also change to reflect the changes locally.
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:655f6f487cc24af0ab86b8592622a7701c30f3369e7847a1fbb783d0962829c3
+size 52910
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fe971af94f1f7b042b7313268e4d2d8432d926ce2392e50ca2a4abc21c8a4aab
+size 57033
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:025303053f2b2cedd2bdd61cd71e1f1c0fb12e45bfbc0e81f2c0d70747133505
+size 63458
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:061707977c8046a6f924881f86aac962e2f05618e201080768246270de792040
+size 100162
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8add61e6ef34b2470e5a5bea3e10955a86eed5ed1fc4dd398f30835485a6c455
+size 158422
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:021ae1ce29d3932f088f0954787c475be826915b794320bf212d3ba7d58656da
+size 110529
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b225d21de5778ddc032893e0f52150ab4260b0dfbe0e9141da4aa8b03131a9da
+size 147821
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fda4f6e8cf68833f239bdc85c46802fe2131d149011074f747b1829822a38939
+size 59041
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:576801d5ebd8cf7fcd3c9c0c6df325654338854f7d762a5680e9aab3c9e6508a
+size 142155
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1c93f681f0f7ce74cee0f2ed193f574ef915554f1a9ef96ba54afdede302f13a
+size 112057
@@ -15,15 +15,20 @@ The encryption algorithm is delibrately designed to be aligned with openssl form
   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 `base32` is applied.
+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
-   # pure string encryption then base32
-   echo -n 'a-folder-文件夹/a-file-文件.md' | openssl enc -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword | base32 -w 0
+   # 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 base32 then decryption
-   echo -n 'KNQWY5DFMRPV7UHRWVYFSHE2XVVVZCFN65SR7ETEKO5L6EYGXCVEPT4A2LVTW4W2ZHXWF3K22SVA562CCZ6SALARXJY6AAXXHLK5UOA=' | base32 -d -w 00 | openssl enc -d -aes-256-cbc -pbkdf2 -iter 20000 -pass pass:mylongpassword
+   # 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,19 @@
+# How To Debug
+
+Ideally, users do not need to debug anything. But if something bad happened, we have to dig into details.
+
+## Easy: Export Sync Plans
+
+See [here](./export_sync_plans.md).
+
+## Advanced: Check Console Output Directly
+
+...of desktop and Android.
+
+See [here](./check_console_output.md).
+
+## Advanced: Save Console Output Then Read Them Later
+
+This method works for desktop and mobile devices (iOS, Android).
+
+See [here](./save_console_output_and_export.md).
@@ -0,0 +1,23 @@
+# Check Console Output
+
+If you are using Obsidian on desktop or Android, you can check the Obsidian console.
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Check The Output
+
+- If you are on desktop
+
+  Press the keyboard shortcut "ctrl+shift+i" if you are on Windows or Linux, or press "cmd+shift+i" if you are on macOS. You should be able to see the console of Obsidian.
+
+- If you are using Android
+
+  You need to [enable USB debugging](https://developer.android.com/studio/debug/dev-options#enable) on your Android, then connect your Android to a computer using USB, then open the **desktop** Chrome browser and go to the special web page <chrome://inspect>. You shall be able to see the "inspect" link inside the special page, then click the link to open the console. After debugging, remember to turn off USB debugging.
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. You could understand what happened and what goes wrong more explictly by checking the output.
@@ -0,0 +1,95 @@
+# Export Sync Plans
+
+## What's this?
+
+Everytime the plugin starts a sync, it gathers all required information together, generates a "sync plan" of every operations to every files and folders, and assign the corresponding actual operations.
+
+Thus, if something goes wrong, we should check the sync plan firstly.
+
+## How To Export The Plans?
+
+Please read through the following instructions.
+
+### Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+### Manual Sync If Not Yet
+
+You should at least sync once, so that at least one sync plan is generated and saved. If you have synced the vualt before, there should be some sync plans already saved.
+
+### Export To The File
+
+Go to the plugin settings, scroll down to the section "Debug" -> "export sync plans", and click the button "Export". \*\*It would generate a new folder `_debug_remotely_save/` in your vault, and generate a file `sync_plans_hist_exported_on_{a_timestamp},md.` inside that folder.
+
+## How To Read The Plans
+
+Open the genrated `sync_plans_hist_exported_on_{a_timestamp},md.`. You should see a json, or multiple jsons. Every json represents a sync plan.
+
+A sync plan looks like this:
+
+```json
+{
+  "ts": 1646960867560,
+  "remoteType": "onedrive",
+  "mixedStates": {
+    "abc.md": {
+      "key": "abc.md",
+      "existRemote": true,
+      "mtimeRemote": 1646566632000,
+      "sizeRemote": 56797,
+      "remoteEncryptedKey": "abc.md",
+      "changeMtimeUsingMapping": true,
+      "existLocal": true,
+      "mtimeLocal": 1646566632000,
+      "sizeLocal": 56797,
+      "decision": "skipUploading",
+      "decisionBranch": 1
+    },
+    "New folder/": {
+      "key": "New folder/",
+      "deltimeRemote": 1646925354372,
+      "existLocal": false,
+      "existRemote": false,
+      "decision": "keepRemoteDelHistFolder",
+      "decisionBranch": 9
+    }
+  }
+}
+```
+
+We usually care about the `mixedStates` property. As you may guess, every item in `mixedStates` represent a file or a folder.
+
+We should find out the file/folder we are interested in (or we believe something goes wrong), then checkout the following properties:
+
+```
+decision
+  What decision is made.
+
+decisionBranch
+  It's a mark of the actual logic in the sync code. Useful to debug.
+
+existRemote
+  Does the file/folder exist on the remote service?
+
+mtimeRemote
+  The "last modeified time" on the remote service.
+
+deltimeRemote
+  The "deletion time" on the remote record.
+
+existLocal
+  Does the file/folder exist locally?
+
+mtimeLocal
+  The max of "last modeified time" and "creation time" locally.
+
+deltimeLocal
+  The "deletion time" locally.
+```
+
+The `decision` SHOULD be determined by the modified times and deletion times, by the logic described in [the doc of sync alogorithm](../sync_algorithm_v2.md). In short, we collect four timestamps (`mtimeRemote`, `deltimeRemote`, `mtimeLocal`, `deltimeLocal`), and respect the max timestamp and its corresponding operation.
+
+## Common Issues
+
+Some users report that their "last modeified time"s or "creation time"s are not set correctly by the operating system. In this case, the plugin cannot do anything because it determines the sync plan by comparing the timestamps. It's suggested to check the settings of the operating system or check whether other programs are doing something to the files.
@@ -0,0 +1,25 @@
+# Save Console Output And Read Them Later
+
+## Disable Auto Sync Firstly
+
+You should disable auto sync to avoid any unexpected running.
+
+## Set The Output Level To Debug
+
+Go to the plugin settings, scroll down to the section "Debug" -> "alter console log level", and change it from "info" to "debug".
+
+## Enable Saving The Output To DB
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "disable" to "enable". **This setting has some performance cost, so do NOT always turn this on when not necessary!**
+
+## Run The Sync
+
+Trigger the sync manually (by clicking the icon on the ribbon sidebar). Something (hopefully) helpful should show up in the console. The the console logs are also saved into DB now.
+
+## Export The Output And Read The Logs
+
+Go to the plugin settings, scroll down to the section "Debug" -> "Export Console Logs From DB", and click the button. A new file `log_hist_exported_on_....md` should be created inside the special folder `_debug_remotely_save/`. You could read it and hopefully find something useful.
+
+## Disable Saving The Output To DB
+
+After debugging, go to the plugin settings, scroll down to the section "Debug" -> "Save Console Logs Into DB", and change it from "enable" to "disable".
@@ -0,0 +1,19 @@
+## Bonus: Import And Export Not-Oauth2 Plugin Settings By QR Code
+
+It's often verbose / inconvenient to input not-oauth2 credentials on mobile. (On different desktop computers, it's trivial to copy and paste `data.json` across different devices.)
+
+So this plugin has a helper function to export those settings as a QR code, then you could use mobile device's camera to import the settings.
+
+Attention:
+
+1. Oauth2 - related information is omitted. It means that Dropbox, OneDrive login credentials are NOT included in the QR Code.
+2. Please, NEVER share the QR Code to others. It's as equivalent to the login credentials.
+
+Steps:
+
+1. Configure the plugin settings on one device, and make sure the sync functions work. (E.g, you could sync notes using S3 credentials.)
+2. Open plugin settings page. Then scroll down the page, until the section "Import and Export Settings". Click the button "Get QR Code". A new modal should show up and you should see a QR code.
+3. On a second device, make sure the vault name is the same as the first device's.
+4. On that second device, use its camera app, or any apps that support scanning QR codes, to scan the QR code from the first device. (On latest iOS, the system's built in camera app should work. On Android, at least one open source app [Binary Eye](https://github.com/markusfisch/BinaryEye) is tested to be working.)
+5. A link / url / address should be identified in the scan-QR-code app, and you could follow the instruction in the app, and then you should be redirected to open the Obsidian app.
+6. And finally, there should be a new notice in the Obsidian app saying the settings are successfully imported. Otherwise please check the error message in the notice.
@@ -1,36 +1,21 @@
 # Minimal Intrusive Design

-The plugin tries to avoid saving additional meta data remotely.
+Before version 0.3.0, the plugin did not upload additional meta data to the remote.
+
+From and after version 0.3.0, the plugin just upload minimal extra necessary meta data to the remote.

 ## Benefits

-Then the plugin doesn't make any assumptions about information on the remote endpoint.
+Then the plugin doesn't make more-than-necessary assumptions about information on the remote endpoint.

 For example, it's possbile for a uses to manually upload a file to s3, and next time the plugin can download that file to the local device.

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

-## Flaws
+## Necessarity Of Uploading Extra Metadata

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

-Consider this:
+If we don't upload any extra info to the remote, there's usually no way for the second device to know what files / folders have been deleted on the first device.

-1. The user create and sync a file to the cloud on the 1st device.
-2. Then download this file to the 2nd device.
-3. And then delete this file on the 1st device.
-4. And sync on the 1st device. The file on the cloud is also deleted.
-5. And sync on the 2nd device. **The 2nd device would upload the file again to the cloud.**
-
-In step 4, the file is marked "deleted" on the 1st device, and the 1st device send the command "delete this file on the cloud" to the cloud sevice (e.g. s3). Then the file on the cloud is also deleted. So far so good.
-
-But, in step 5, because no meta data are saved on the cloud, the 2nd device doesn't know that the file are deleted. Instead, it thinks "the file was not synced to the cloud last time, so it's uploaded this time". So an unintentional upload occurs.
-
-Currently no way to fix this if no meta data are saved remotely. The only workarounds are:
-
-1. Delete the file on the 1st device, **before** syncing it to the cloud. Then the file never show up on the cloud or on the 2nd device.
-2. Or, manually delete the file on 2nd device **before** step 5 in above situation.
-
-## Future
-
-This design may be changed in the feature, considering the flaws described above.
+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.
@@ -0,0 +1,53 @@
+# Backblaze B2
+
+## Links
+
+https://www.backblaze.com/cloud-storage
+
+## Steps
+
+1. Create a Backblaze account [on this page](https://www.backblaze.com/cloud-storage). Credit card info _is not_ required. Backblaze B2 offers 10 GB of free storage.
+
+2. Please be aware that, though B2 provides some free quota, **it may still cost you money if the usage of storage or api requests exceed a certain value!!!** Especially pay attention to the api requests!!!
+
+3. Create a **bucket**, you can leave the default settings, or you can enable the encryption (which is different from what you can set in Remotely Save):
+
+   ![](./s3_backblaze_b2-1-bucket.png)
+   ![](./s3_backblaze_b2-2-create_bucket.png)
+
+4. Copy `Endpoint`, eg. `s3.us-east-005.backblazeb2.com` — it'll be used later.
+
+5. Copy `bucketname` near the 🪣 icon (the "bucket icon") — it'll be used later.
+
+   ![](./s3_backblaze_b2-3-copy.png)
+
+6. Go to **Application Keys**:
+
+   ![](./s3_backblaze_b2-4-app_keys.png)
+
+7. **Add a new key**:
+
+   ![](./s3_backblaze_b2-5-add_new_app_keys.png)
+   ![](./s3_backblaze_b2-6-app_keys_copy.png)
+
+8. Save `keyID` and `applicationKey` — they will be used later.
+
+9. Go to Remotely Save settings in Obsidian and:
+
+   - Choose `S3 or compatibile` in **Remote Service**:
+   - Copy `Endpoint` from Backblaze (see 3. above) to `Endpoint` in Remotely Save
+   - From `endpoint` take `region` (eg. `us-east-005`) and paste it in `endpoint` in Remotely Save
+   - Copy `keyID` (see 7. above) to `Access Key ID` in Remotely Save
+   - Copy `applicationKey` (see 7. above) to `Secret Access Key` in Remotely Save
+   - Copy `bucketname` (see 4. above) to `Bucket Name` in Remotely Save
+     ![](./s3_backblaze_b2-7-copy_paste.png)
+
+10. **Enable Bypass CORS**:
+    ![](./s3_backblaze_b2-8-cors.png)
+
+11. Click **Check** in _Check Connectivity_ to see if you can connect to B2 bucket:
+    ![](./s3_backblaze_b2-9-check_connectionpng.png)
+
+12. Sync!
+
+    ![](./s3_backblaze_b2-10-sync.png)
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fae18a84bb218461aca01c7de47ddadfd2b451d865ec889c098cd6918f6e8773
+size 59679
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9389f9c4462740371edb548f7e05191ede5277a5d470e3254c60fbcc4a75e552
+size 4558
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:46f35968938ebf3bbafae64ee49a4927844fd0abf79e4190522be91776d9fed0
+size 107623
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7fb639c7b4e595516594ee9d07c864e7cd15b608a97c81386f4cf72d499d0e5f
+size 80121
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:299bfca82b77de86f60d8f481b5f74069dc977dece19fa025ee629d1e6f783d4
+size 6499
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5985e918b521c91cc185f60c58cdd334ee76695b897a02e02eaa17c1bad71609
+size 10214
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5796791bcf89c99c1e1e844c0083739fd46b1a458dc274f3c3fa3f65b87b71b3
+size 70728
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3633379fcb12f1a5e0a4d1d68c193ddc7bf0be7edd92f2f6006351817035a94f
+size 27164
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9e130be182ae7d3270e5de3fec442ac5e81efd61822e844cd61ed24c7e485d39
+size 16802
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:29a8971fea065fd86223850198640f4072ee3fda2112820829cda1348f122c59
+size 11103
@@ -0,0 +1,27 @@
+# Cloudflare R2
+
+## Links
+
+<https://www.cloudflare.com/developer-platform/r2/>
+
+## Steps
+
+1. **Be aware that it may cost you money.**
+2. Create a Cloudflare account and enable R2 feature. **Credit card info might be required by Cloudflare**, though Cloudflare provides generous free tier and zero egress fee.
+3. Create a bucket.
+   ![](./s3_cloudflare_r2_create_bucket.png)
+4. Create an Access Key with "Object Read & Write" permission, and add specify to your created bucket. During the creation, you will also get the auto-generated secret key, and the endpoint address.
+   ![](./s3_cloudflare_r2_create_api_token.png)
+5. In remotely-save setting page, input the address / bucket / access key / secret key. **Region being set to `us-east-1` is sufficient.** Enable "Bypass CORS", because usually that's what you want.
+
+   Click "check connectivity". (If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.)
+
+   ![](./s3_cloudflare_r2_rs_settings.png)
+
+6. Sync!
+
+## And Issue Related To "Check Connectivity"
+
+If you encounter an issue and sure the info are correct, please upgrade remotely-save to **version >= 0.3.29** and try again.
+
+Cloudflare doesn't allow `HeadBucket` for access keys with "Object Read & Write". So it may be possible that checking connectivity is not ok but actual syncing is ok. New version >= 0.3.29 of the plugin fix this problem by using `ListObjects` instead of `HeadBucket`.
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:49a5cd07e538205ba733dc3ccb30e4e7da1290a4a80aefe08afac19fd2db2232
+size 467448
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:61fc0812fe96871eed507d2f6b7bbad790ab70e95ff5fe764f8f8b2ab8ce82c2
+size 153015
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:02f9c0fea36679e54c8c3fac979bc41d15ae4f7992b269bc2b67255059af1d2f
+size 579889
@@ -0,0 +1,33 @@
+# How To Configure S3 CORS Rules
+
+If you are using the latest version of this plugin AND Obsidian desktop >= 0.13.25, mobile >= 1.1.1, you do not need to configure it any more. If you are using Obsidian desktop < 0.13.25, moble < 1.1.1, you are required to configure the rules as following.
+
+Thanks to [@NAL100 in the Discussion](https://github.com/fyears/remotely-save/discussions/28).
+
+Please try this config:
+
+```json
+[
+  {
+    "AllowedHeaders": ["*"],
+    "AllowedMethods": ["GET", "PUT", "POST", "DELETE", "HEAD"],
+    "AllowedOrigins": [
+      "app://obsidian.md",
+      "capacitor://localhost",
+      "http://localhost"
+    ],
+    "ExposeHeaders": [
+      "Content-Length",
+      "Content-Type",
+      "Connection",
+      "Date",
+      "ETag",
+      "Server",
+      "x-amz-delete-marker",
+      "x-amz-id-2",
+      "x-amz-request-id",
+      "x-amz-version-id"
+    ]
+  }
+]
+```
@@ -0,0 +1,83 @@
+# AWS S3 Bucket: How to configure user's policy
+
+## Attention
+
+Please read the doc carefully and adjust the optional fields accordingly. The doc is not fully tested and contributions are welcome.
+
+## AWS Official Docs
+
+- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html>
+- <https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html>
+- <https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html>
+
+## Prerequisites
+
+Using the principle of least privilege is crucial for security when allowing a third party system to access your AWS resources.
+
+**Prerequisites**: Ensure you have an AWS account and administrative access to manage IAM policies.
+
+## Step 1: Create a new IAM Policy
+
+1. Log in to your AWS Management Console.
+1. Navigate to the IAM Policies section.
+1. Create a new policy with the following configuration.
+
+**Note**: `my-bucket` is a placeholder. For example, if your bucket's name is `obsidian-data`, the resource line should read `arn:aws:s3:::obsidian-data`.
+
+```JSON
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "ObsidianBucket",
+            "Effect": "Allow",
+            "Action": [
+                "s3:HeadBucket"
+            ],
+            "Resource": "arn:aws:s3:::my-bucket"
+        },
+        {
+            "Sid": "ObsidianObjects",
+            "Effect": "Allow",
+            "Action": [
+                "s3:HeadObject",
+                "s3:PutObject",
+                "s3:CopyObject",
+                "s3:UploadPart",
+                "s3:UploadPartCopy",
+                "s3:ListMultipartUploads",
+                "s3:AbortMultipartUpload",
+                "s3:CompleteMultipartUpload",
+                "s3:ListObjects",
+                "s3:ListObjectsV2",
+                "s3:ListParts",
+                "s3:GetObject",
+                "s3:GetObjectAttributes",
+                "s3:DeleteObject",
+                "s3:DeleteObjects"
+            ],
+            "Resource": "arn:aws:s3:::my-bucket/*"
+        }
+    ]
+}
+```
+
+> The policy allows the Obsidian plugin to list, add, retrieve, and delete objects in the specified S3 bucket.
+
+## Step 2: Attach the Policy to Obsidian user
+
+1. Create a new user in the IAM console. (Never use your own root user, as it would have full access to your AWS account).
+1. When creating the user, select "Attach policy directly" and select the policy created.
+1. Edit the recent created user and go to "Security Credentials" tab to create your access key.
+1. Create an Access Key. If asked for a "use case", select "other"
+1. Use the credentials in the plugin settings. (NEVER share these credentials)
+
+> PS. The bucket doesn't need to have a policy, only the user.
+
+## Verifying the Policy
+
+After attaching the policy, test it by trying to access the S3 bucket through the Obsidian plugin. Ensure that all intended actions can be performed without errors.
+
+## Troubleshooting
+
+If you encounter permission errors, check the policy for typos in the bucket name or actions. Ensure the policy is attached to the correct user.
@@ -0,0 +1,27 @@
+# MinIO
+
+## Links
+
+<https://min.io/>
+
+## Steps
+
+1. Configure your minio instance and get an account.
+2. Create an Access Key (during the creation, you will also get the auto-generated secret key).
+   ![](./minio_access_key.png)
+3. Check or set the region.
+   ![](./minio_region.png)
+4. Create a bucket.
+   ![](./minio_create_bucket.png)
+5. In remotely-save setting page, input the address / bucket / access key / secret key. **Usually minio instances may need "S3 URL style"="Path Style".** Enable "Bypass CORS", because usually that's what you want.
+   ![](./minio_rs_settings.png)
+6. Sync!
+   ![](./minio_sync_success.png)
+
+## Ports In Address
+
+Just type in the full address with `http(s)://` and `:port` in remotely-save settings, for example `http://192.168.31.198:9000`.
+
+It's verified that everything is ok.
+
+![](./minio_custom_port.png)
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c384ec32a43fcac1e63dbc81d4fbb7fbfaffcd67d0f5a66104482a39475ad639
+size 323050
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:894a6a10b7f41754936d77a935b4a5a4ae722796fa5680c9c6d0dd53c3cdc1a2
+size 269705
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b25c1209875ad781a29d3ac1cde5bd9c2137622e3919987c4d4e5f77dc8e3ec7
+size 68997
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bfcc526281d2c6a9f1261f489603f3dd768f8b94f099a1b26649fa37c9318575
+size 315030
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:83615a6c2fbf7ff74679b480d29d222db8835bc067aee33a646e4b8d500c3aca
+size 467575
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fd1bb9a6e285a1e63b545d714ca269eb714e980a5177392b967556f1f1754afe
+size 147218
@@ -0,0 +1,23 @@
+# Tencent Cloud COS
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+- international <https://console.tencentcloud.com/cos>
+
+## 步骤 Steps
+
+The example shows the steps of China version. International version should be similar.
+
+1. Create a bucket with **private read-write permissions** and recommendly enable server-side-encryption.
+2. In bucket list page, enter the bucket overview page of the bucket you just created. You should see the bucket name (your texts with the number of your account id), region, and access address.
+   ![](./cos_bucket_info.png)
+3. In CAM page, create api key, and note down the SecretID and SecretKey.
+   ![](./cos_create_secret.png)
+4. **Remove the bucket name from your access address to obtain your endpoint address! If your access address on the website is `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`, then the endpoint address you are going to use is `https://cos.<region>.myqcloud.com`.**
+5. In remotely-save settings page, enter your endpoint adress, SecretID, SecretKey,and bucket name.
+   ![](./cos_setting.png)
+6. Check Connectivity.
+   ![](./cos_connection.png)
+7. Sync!
@@ -0,0 +1,23 @@
+# 腾讯云 COS
+
+[English](./README.md) | 中文
+
+## 链接
+
+- 中国区 <https://console.cloud.tencent.com/cos>
+
+## 步骤
+
+注意这里用中国区示例，国际区配置应该类似。
+
+1. 在“存储桶列表”页，[“创建存储桶”](https://console.cloud.tencent.com/cos/bucket?action=create)。注意创建**私有读写**，建议打开服务端加密。
+2. 在桶列表页，点击刚刚存储的桶，进入概览页。可以见到桶名称（一般来说是之前指定的英文加账号数字），地域，访问域名。记录下来。
+   ![](./cos_bucket_info.png)
+3. 在[“访问管理页”](https://console.cloud.tencent.com/cam/capi) ，“API 密钥管理”，“创建密钥”，要记录 SecretID 和 SecretKey。
+   ![](./cos_create_secret.png)
+4. **把桶名称从访问域名移除，才是你即将输入的服务地址！假如你在腾讯云网站看到访问域名是 `https://<bucket-name-with-number>.cos.<region>.myqcloud.com`，那么“服务地址”是 `https://cos.<region>.myqcloud.com`.**
+5. 在 remotely-save 设置，输入服务地址，SecretID，SecretKey，和 桶名称。
+   ![](./cos_setting.png)
+6. 检查连接。
+   ![](./cos_connection.png)
+7. 可以同步了！
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:08b47288686c8ef8c6426776f7df52411efe431966e8f7f2f9a3a8836ee4d6c6
+size 323127
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:94c0ec5db7a75c54c36224f067659682e271aea2e61b1ee50d046cd493ba72ac
+size 58410
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f51f542756def80a77404e47f9793d1cd6917df5ab6e09d5a0ee1f7191855dc6
+size 425021
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:55064233031b44066fb7b77e17ba1eb1d0ae8398235a343cc7e137b07aaf7a39
+size 668954
@@ -0,0 +1,23 @@
+# AList
+
+English | [中文](./README.zh-cn.md)
+
+## Links
+
+- English official website: <https://alist.nn.ci/> and <https://alist.nn.ci/guide/webdav.html>
+
+## Steps
+
+1. Install and run AList. Get the account and password. Login using the web page.
+2. Add new storage. Pay attention to the mount path. The screenshot shows the mount path as `/alisttest davpath`.
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. Construct the webdav address as: **http(s)://domain** + **port** + **`/dav`** + **mount path**, and the space inside the mount path should be replaced with `%20`:
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. In remotely-save setting page, select webdav type, then input the **full address with mount path**/account/password.
+   ![](./alist_rs_settings.en.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
@@ -0,0 +1,23 @@
+# AList
+
+[English](./README.md) | 中文
+
+## 链接
+
+- 中文官网：<https://alist.nn.ci/zh/> 和 <https://alist.nn.ci/zh/guide/webdav.html>
+
+## 步骤
+
+1. 安装和使用 AList。获取账号名和密码。在网页上登录。
+2. 新建挂载，检查挂载路径。如图所示是 `/alisttest davpath`。
+   ![](./alist_mount_path.zh.png)
+   ![](./alist_mount_path.en.png)
+3. 从而构建 webdav 网址如下，**http(s)://域名** + **端口** + **`/dav`** + **挂载路径**，其中挂载路径中假如有空格，换成 `%20`：
+   ```
+   http[s]://domain:port/dav/[mountpath url encoded]
+   http://127.0.0.1:5244/dav/alisttest%20davpath
+   ```
+4. 在 remotely-save 设置，输入**带域名端口`/dav`和挂载路径的网址**、账号、密码。
+   ![](./alist_rs_settings.en.png)
+5. 在 remotely-save 设置，检查连接。
+6. 同步文件！
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ea05f67782b8f84518f13cf5587df719bdaa15f9e35b79f2801f91e695de6480
+size 46798
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dcaaa5e64e894f0e9c8b0242b64bf4dd364c16d7314b09bc004f7ed0a0f1e0e5
+size 60853
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0b792320e2a4aaa16a17d82e80225ab35da05fd1f407fe067de72651beca088e
+size 426289
@@ -0,0 +1,10 @@
+If you are using Obsidian desktop >= 0.13.25 or iOS >= 1.1.1, you can skip this CORS part.
+
+If you are using Obsidian desktop < 0.13.25 or iOS < 1.1.1 or any Android version:
+
+- The webdav server has to be enabled CORS for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, **AND** all webdav HTTP methods, **AND** all webdav headers. These are required, because Obsidian mobile works like a browser and mobile plugins are limited by CORS policies unless under a upgraded Obsidian version.
+- Popular software NextCloud, OwnCloud, `rclone serve webdav` do **NOT** enable CORS by default. If you are using any of them, you should evaluate the risk, and find a way to enable CORS, before using this plugin, or use a upgraded Obsidian version.
+  - **Unofficial** workaround: NextCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can install [WebAppPassword](https://apps.nextcloud.com/apps/webapppassword) app, and add `app://obsidian.md`, `capacitor://localhost`, `http://localhost` to `Allowed origins`
+  - **Unofficial** workaround: OwnCloud users can **evaluate the risk by themselves**, and if decide to accept the risk, they can download `.tar.gz` of `WebAppPassword` above and manually install and configure it on their instances.
+- [Apache is also possible](./webdav_apache_cors.md).
+- The plugin is tested successfully under python package [`wsgidav` (version 4.0)](https://github.com/mar10/wsgidav). See [this issue](https://github.com/mar10/wsgidav/issues/239) for some details.
@@ -0,0 +1,25 @@
+# How To Configure Apache CORS Rules for Webdav
+
+This method is [contributed by community](https://github.com/remotely-save/remotely-save/pull/31).
+
+You should evaluate the risk by yourself before trying this method.
+
+**You are strongly advised to backup your original Apache configuration files before making any changes.**
+
+```apacheconf
+<IfModule mod_headers.c>
+  # Obsidian webdav
+  SetEnvIf Origin "^app://obsidian.md$" IS_OBSIDIAN
+  SetEnvIf Origin "^capacitor://localhost$" IS_OBSIDIAN
+  SetEnvIf Origin "^http://localhost$" IS_OBSIDIAN
+  Header always set Access-Control-Allow-Origin "*" env=IS_OBSIDIAN
+  Header always set Access-Control-Allow-Methods "GET, HEAD, POST, PUT, OPTIONS, MOVE, DELETE, COPY, LOCK, UNLOCK, PROPFIND" env=IS_OBSIDIAN
+  Header always set Access-Control-Allow-Headers "Authorization, Depth, DNT, User-Agent, Keep-Alive, Content-Type, accept, origin, X-Requested-With" env=IS_OBSIDIAN
+  Header always set Access-Control-Expose-Headers "etag, dav" env=IS_OBSIDIAN
+
+  # Allow OPTION request without authentication and respond with status 200
+  RewriteCond %{ENV:IS_OBSIDIAN} 1
+  RewriteCond %{REQUEST_METHOD} OPTIONS
+  RewriteRule ^(.*)$ $1 [R=200,L]
+</IfModule>
+```
@@ -0,0 +1,15 @@
+# InfiniCLOUD (formally TeraCLOUD) Webdav
+
+## Link
+
+<https://infini-cloud.net/en/>
+
+## Steps
+
+1. Register an acount.
+2. Go to <https://infini-cloud.net/en/modules/mypage/usage/>, in section "Apps Connection", enable "Turn on Apps Connection". Here you get the address and account and webdav password (different from your account password):
+   ![](./infinicloud_account.png)
+3. In remotely-save setting page, select webdav type, then input the address/account/**webdav password**(not your account password).
+   ![](./infinicloud_rs_setting.png)
+4. In remotely-save setting page, click "Check Connectivity".
+5. Sync!
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0e16bc9d86b30ab907fc176087701474f4ca2b8d887f649302f2e184f69d0cbc
+size 373845
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8d707f6997df57b9c6b74d72bcfd567995d15062269761ee404e6596a266a241
+size 91012
@@ -0,0 +1,22 @@
+# JianGuoYun/NutStore
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+<https://www.jianguoyun.com/>
+
+## Attentions!!!
+
+JianGuoYun/NutStore has api limits. The plugin may generate many queries, and it's possible to reach the api limits if there are many files, then do not work properly. It's not a bug and there's no way to fix this situation.
+
+## Steps
+
+1. **Be aware that JianGuoYun/NutStore has api limits, and the plugin may not work properly because of this.**
+2. Register an account.
+3. Go to "settings"->"Security", click "Add Application", then obtain the WebDAV account (email), and WebDAV password (a string different from web site password).
+   ![](./webdav_jianguoyun.cn.png)
+4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
@@ -0,0 +1,22 @@
+# 坚果云
+
+[English](./README.md) | 中文
+
+## 链接
+
+<https://www.jianguoyun.com/>
+
+## 注意！！！
+
+坚果云有限制 api 数量等设定。本插件会产生若干查询，如果文件较多很容易触发 api 上限，从而工作不正常。这不是插件 bug，也没有办法解决。
+
+## 步骤
+
+1. **知悉坚果云有 api 限制，本插件可能因此工作不正常。**
+2. 注册账号，登录。
+3. 去“个人信息”->“安全”，“添加应用”，从而获取了 webDAV 账号（应该是 email）和 WebDAV 密码（一串特殊的字符，不等于网站密码）。
+   ![](./webdav_jianguoyun.cn.png)
+4. 在 remotely-save 设置，输入网址、账号、密码、**“发送到服务器的 Depth Header”设置为“只支持 depth='1'”**。
+   ![](./webdav_jianguoyun_rs_settting.cn.png)
+5. 在 remotely-save 设置，检查连接。
+6. 同步文件！
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fd5aaab1e1ac0ea8996517c819bf5ac0d2a828483037419ba289b538957f4752
+size 515913
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:112778176af954e16c93c582d968e7c14e5b950d64facce8593855f5fb75fbcc
+size 431527
@@ -0,0 +1,17 @@
+# ownCloud Webdav
+
+## Link
+
+<https://owncloud.com/>
+
+# Steps
+
+1. Create an account.
+2. Login.
+3. In the Settings position, enable the "Show hidden files" and find out the WebDAV address.
+   ![](./owncloud_address.png)
+4. Input the WebDAV address, account, password, **Depth Header Sent To Servers="only supports depth='1'"** in remotely-save settings.
+   ![](./owncloud_rs_settings.png)
+5. In remotely-save setting page, click "Check Connectivity".
+6. Sync!
+   ![](./owncloud_files.png)
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e0d025b4ccf1be7fa2cc74e914e9a1a89a8d8f12a1b917bd4b26b975bf208294
+size 27796
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b3d24d416016b2676a86166fcc35fa89f8befb7a872503b8da2be4374ef360ce
+size 53503
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2e8bf9a51e5d5bed66fb45fe085f37943bd90a51b33ef752d898c5b2caa71c2d
+size 448797
@@ -0,0 +1,55 @@
+# Synology Webdav Server
+
+English | [中文](./README.zh-cn.md)
+
+## Link
+
+<https://kb.synology.com/en-global/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
+
+## Attention
+
+The tutorial author (the author of Remotely Save) is NOT an expert of NAS / Synology. Please read the doc carefully and change it to accommodate your needs by yourself.
+
+**It's dangerous to expose your NAS into public Internet if you don't know how to set up firewalls and other protections.**
+
+## Steps
+
+Synology DSM 7 is used in this tutorial.
+
+1. Create a new shared folder if you don't have one. For this tutorial, a new shared folder `share2` is created. You should assing a proper user to read / write the shared folder.
+   ![](./synology_create_shared_folder.png)
+
+2. Assuming you want to sync your vault into sub folder `哈哈哈/sub folder`, please create the sub folder(s) correspondingly inide the shared folder `share2`.
+
+3. Install webdav server from package center.
+   ![](./synology_install_webdav_server.png)
+
+4. Enter the webdav server settings.
+
+5. If you know how to configure https certificates correctly, you are strongly recommend to enable https.
+
+   For the demonstration purpose, this tutorial enable http server for the later steps.
+
+   Also "Enable DavDepthInfinity", which could speed up the plugin runnings greatly.
+
+   "Apply".
+
+   ![](./synology_webdav_server_settings.png)
+
+6. In Remotely Save settings, you should input your address as:
+
+   `http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
+
+   For example, in the tutorial, the proper url should be:
+
+   `http://<ip>:5000/share2/哈哈哈/sub folder`
+
+   Username and password should be the user you configured before with read / write permissions to `share2`.
+
+   Depth header should be "supports depth="infinity"".
+
+   Check connectivity!
+
+   ![](./synology_remotely_save_settings.png)
+
+7. Sync!
@@ -0,0 +1,56 @@
+# 群晖 Webdav Server
+
+[English](./README.md) | 中文
+
+## 链接
+
+<https://kb.synology.cn/zh-cn/DSM/tutorial/How_to_access_files_on_Synology_NAS_with_WebDAV>
+
+## 注意
+
+教程作者（Remotely Save 作者）**不是** NAS、群晖专家。请仔细阅读文档，并自行改动以适应您自身需求。
+
+**没有设置防火墙和其他保护措施的话，将 NAS 暴露到公网上非常危险。**
+
+## 步骤
+
+本教程有用到群晖 DSM 7。
+
+1. 创建共享文件夹。本教程示例创建了 `share2`。你需要允许某个账号对此的读写权限。
+
+   ![](./synology_create_shared_folder.png)
+
+2. 假设之后你想同步你的库到子文件夹，`哈哈哈/sub folder`，请先在共享文件夹 `share2` 底下创建好。
+
+3. 从套件中心安装 webdav server 。
+   ![](./synology_install_webdav_server.png)
+
+4. 进入 webdav server 设置。
+
+5. 如果你知道如何正确配置 https 证书的话，强烈建议开启 https。
+
+   本教程简化示例，开启了 http。
+
+   也设置“Enable DavDepthInfinity”，这可以加速插件连接速度。
+
+   “Apply”。
+
+   ![](./synology_webdav_server_settings.png)
+
+6. 在 Remotely Save 设置页，你的地址应如下格式输入：
+
+   `http(s)://<your synology ip or domain>:<port>/<shared folder>/<sub folders>`
+
+   比如说，本教程里，正确的地址类似于：
+
+   `http://<ip>:5000/share2/哈哈哈/sub folder`
+
+   用户名和密码是你之前配置了允许读写 `share2` 的那个账号。
+
+   Depth 设置应为“supports depth="infinity"”。
+
+   检查连接！
+
+   ![](./synology_remotely_save_settings.png)
+
+7. 同步！
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:71e61c25db793c00d4406ea0f46745941e16e268a41b7328b03a183ab0706ec8
+size 59700
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0f0725099989b5496048c0e3cb284b4f6537d66866b4618c8e73ee758cb2b642
+size 174986
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7bc6d03a9deb0e8babd2ed102e7b85ee1062797abf1146ae71f80237a852ff10
+size 522084
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba3781f24b5d65ee6915d496f7542c569116141cdced24ca505f4373d9efa9df
+size 536163
--- 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/`