From af71758ef79206c77880794718a6c0382be0c02d Mon Sep 17 00:00:00 2001
From: fyears <1142836+fyears@users.noreply.github.com>
Date: Wed, 3 Jan 2024 00:08:51 +0800
Subject: [PATCH] add cloudflare r2

---
 README.md                                     |  1 +
 .../s3_cloudflare_r2/README.md                | 27 +++++++++++++++++++
 .../s3_cloudflare_r2_create_api_token.png     |  3 +++
 .../s3_cloudflare_r2_create_bucket.png        |  3 +++
 .../s3_cloudflare_r2_rs_settings.png          |  3 +++
 5 files changed, 37 insertions(+)
 create mode 100644 docs/remote_services/s3_cloudflare_r2/README.md
 create mode 100644 docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png
 create mode 100644 docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png
 create mode 100644 docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png

diff --git a/README.md b/README.md
index d06e2f6..1f16074 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,7 @@ Additionally, the plugin author may occasionally visit Obsidian official forum a
 ### S3
 
 - Tutorials / Examples:
+  - [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.
 - About CORS:
diff --git a/docs/remote_services/s3_cloudflare_r2/README.md b/docs/remote_services/s3_cloudflare_r2/README.md
new file mode 100644
index 0000000..77343da
--- /dev/null
+++ b/docs/remote_services/s3_cloudflare_r2/README.md
@@ -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`.
diff --git a/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png b/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png
new file mode 100644
index 0000000..1ebfa77
--- /dev/null
+++ b/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_api_token.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:49a5cd07e538205ba733dc3ccb30e4e7da1290a4a80aefe08afac19fd2db2232
+size 467448
diff --git a/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png b/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png
new file mode 100644
index 0000000..6507403
--- /dev/null
+++ b/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_create_bucket.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:61fc0812fe96871eed507d2f6b7bbad790ab70e95ff5fe764f8f8b2ab8ce82c2
+size 153015
diff --git a/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png b/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png
new file mode 100644
index 0000000..2452ad9
--- /dev/null
+++ b/docs/remote_services/s3_cloudflare_r2/s3_cloudflare_r2_rs_settings.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:02f9c0fea36679e54c8c3fac979bc41d15ae4f7992b269bc2b67255059af1d2f
+size 579889