diff --git a/README.md b/README.md index 39828cf..ec0f1c7 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for ## Features -- **Amazon S3 or S3-compatible services are supported.** Webdav supports on the plan. +- **Amazon S3 or S3-compatible services are supported.** Webdav supports on the half way. - **Obsidiain 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. - **[Minimal Intrusive](./docs/minimal_intrusive_design.md).** @@ -35,6 +35,8 @@ As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for ## Usage +### s3 + - Prepare your S3 (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for syncing a vault. - 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. - Download and enable this plugin. @@ -42,3 +44,9 @@ As of November 2021, the plugin is considered in BETA stage. **DO NOT USE IT for - 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.) - **Be patient while syncing.** Especially in the first-time sync. + +### webdav + +- **webdav support is buggy (as of now, 20211122) and considered experimental, so it's hidden by default.** Highly recommend to use the more stable s3. +- If you decide to give it a try, open settings, and click "Choose service" area five times, then a Notice should show up. Close and open settings again then you will be able to select webdav. +- Currently webdav server should enable CORS for requests, because of technical limitations of mobile.