refactor s3 docs

This commit is contained in:
fyears 2024-01-05 22:37:35 +08:00
parent 8b838656ce
commit 0f8b1951a6
3 changed files with 7 additions and 8 deletions

View File

@ -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. - **[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). - **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).** - **[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).** - **Fully open source under [Apache-2.0 License](./LICENSE).**
- **[Sync Algorithm open](./docs/sync_algorithm_v2.md) for discussion.** - **[Sync Algorithm open](./docs/sync_algorithm_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) - [Cloudflare R2](./docs/remote_services/s3_cloudflare_r2/README.md)
- [MinIO](./docs/remote_services/s3_minio/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. - 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). - If you are using AWS S3, create [policy and user](./docs/remote_services/s3_general/s3_user_policy.md).
- About CORS: - Very old version of Obsidian needs [configuring CORS](./docs/remote_services/s3_general/s3_cors_configure.md).
- 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.
- Download and enable this plugin. - Download and enable this plugin.
- Enter your information 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. - 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.

View File

@ -6,9 +6,9 @@ Please read the doc carefully and adjust the optional fields accordingly. The do
## AWS Official Docs ## AWS Official Docs
* <https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-policy-language-overview.html> - <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/userguide/using-with-s3-actions.html>
* <https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html> - <https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html>
## Prerequisites ## 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. > 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 ## Step 2: Attach the Policy to Obsidian user