You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[R2] Adding workflow for using Rclone to upload to R2 (#21227)
* Initiating tutorial
* Adding Rclone tutorial.
* Iterating feedback
* Offloading config into into the Rclone example.
Cutting down wording in the Uploads chapter.
* Adding back useful code comment
* Adding emphasis on uploading concurrently.
* Implementing feedback
* Catching capitalisations in titles
* Informing users that they can upload via API in
the opening sentence.
Copy file name to clipboardExpand all lines: src/content/docs/r2/examples/rclone.mdx
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,43 @@
1
1
---
2
-
title: rclone
2
+
title: Rclone
3
3
pcx_content_type: example
4
4
---
5
5
6
-
import { Render } from"~/components";
6
+
import { Render, Steps } from"~/components";
7
7
8
8
<Renderfile="keys" />
9
9
<br />
10
10
11
+
Rclone is a command-line tool which manages files on cloud storage. You can use rclone to upload objects to R2 concurrently.
12
+
13
+
## Configure rclone
14
+
11
15
With [`rclone`](https://rclone.org/install/) installed, you may run [`rclone config`](https://rclone.org/s3/) to configure a new S3 storage provider. You will be prompted with a series of questions for the new provider details.
12
16
13
17
:::note[Recommendation]
14
-
15
18
It is recommended that you choose a unique provider name and then rely on all default answers to the prompts.
16
19
17
20
This will create a `rclone` configuration file, which you can then modify with the preset configuration given below.
18
21
:::
19
22
20
-
:::note
23
+
<Steps>
24
+
1. Create new remote by selecting `n`.
25
+
2. Select a name for the new remote. For example, use `r2`.
26
+
3. Select the `Amazon S3 Compliant Storage Providers` storage type.
27
+
4. Select `Cloudflare R2 storage` for the provider.
28
+
5. Select whether you would like to enter AWS credentials manually, or get it from the runtime environment.
29
+
6. Enter the AWS Access Key ID.
30
+
7. Enter AWS Secret Access Key (password).
31
+
8. Select the region to connect to (optional).
32
+
9. Select the S3 API endpoint.
33
+
</Steps>
21
34
35
+
:::note
22
36
Ensure you are running `rclone` v1.59 or greater ([rclone downloads](https://beta.rclone.org/)). Versions prior to v1.59 may return `HTTP 401: Unauthorized` errors, as earlier versions of `rclone` do not strictly align to the S3 specification in all cases.
23
37
:::
24
38
39
+
### Edit an existing rclone configuration
40
+
25
41
If you have already configured `rclone` in the past, you may run `rclone config file` to print the location of your `rclone` configuration file:
You can upload objects to your bucket from using API (both [Workers Binding API](/r2/api/workers/workers-api-reference/) or [compatible S3 API](/r2/api/s3/api/)), rclone, Cloudflare dashboard, or Wrangler.
11
+
12
+
## Upload objects via Rclone
13
+
14
+
Rclone is a command-line tool which manages files on cloud storage. You can use rclone to upload objects to R2. Rclone is useful if you wish to upload multiple objects concurrently.
15
+
16
+
To use rclone, install it onto your machine using their official documentation - [Install rclone](https://rclone.org/install/).
17
+
18
+
Upload your files to R2 using the `rclone copy` command.
0 commit comments