From 0f8b1951a6ac0b5089d68a73a4077f6d991e7cc4 Mon Sep 17 00:00:00 2001 From: fyears <1142836+fyears@users.noreply.github.com> Date: Fri, 5 Jan 2024 22:37:35 +0800 Subject: [PATCH] refactor s3 docs --- README.md | 8 +++----- .../{ => remote_services/s3_general}/s3_cors_configure.md | 0 docs/{ => remote_services/s3_general}/s3_user_policy.md | 7 ++++--- 3 files changed, 7 insertions(+), 8 deletions(-) rename docs/{ => remote_services/s3_general}/s3_cors_configure.md (100%) rename docs/{ => remote_services/s3_general}/s3_user_policy.md (93%) diff --git a/README.md b/README.md index 5e5b9b2..d2fe308 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This is yet another unofficial sync plugin for Obsidian. If you like it or find - **[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! +- \*\*Skip Large files and skip paths by custom regex conditions! - **Fully open source under [Apache-2.0 License](./LICENSE).** - **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.** @@ -65,10 +65,8 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/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. -- If you are using AWS S3, create [policy and user](./docs/s3_user_policy.md). -- About CORS: - - If you are using Obsidian desktop >= 0.13.25 or mobile >= 1.1.1, you can skip this CORS part. - - If you are using Obsidian desktop < 0.13.25 or mobile < 1.1.1, you need to configure (enable) [CORS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html) for requests from `app://obsidian.md` and `capacitor://localhost` and `http://localhost`, and add at least `ETag` into exposed headers. Full example is [here](./docs/s3_cors_configure.md). It's unfortunately required, because the plugin sends requests from a browser-like envirement. And those addresses are tested and found on desktop and ios and android. +- If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md). +- Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md). - Download and enable this plugin. - Enter your information to the settings of this plugin. - If you want to enable end-to-end encryption, also set a password in settings. If you do not specify a password, the files and folders are synced in plain, original content to the cloud. diff --git a/docs/s3_cors_configure.md b/docs/remote_services/s3_general/s3_cors_configure.md similarity index 100% rename from docs/s3_cors_configure.md rename to docs/remote_services/s3_general/s3_cors_configure.md diff --git a/docs/s3_user_policy.md b/docs/remote_services/s3_general/s3_user_policy.md similarity index 93% rename from docs/s3_user_policy.md rename to docs/remote_services/s3_general/s3_user_policy.md index a1507e2..2347a86 100644 --- a/docs/s3_user_policy.md +++ b/docs/remote_services/s3_general/s3_user_policy.md @@ -6,9 +6,9 @@ Please read the doc carefully and adjust the optional fields accordingly. The do ## AWS Official Docs -* -* -* +- +- +- ## Prerequisites @@ -61,6 +61,7 @@ Using the principle of least privilege is crucial for security when allowing a t ] } ``` + > 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