Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[R2] Adding workflow for using Rclone to upload to R2 #21227

Open
wants to merge 2 commits into
base: production
Choose a base branch
from
Open

[R2] Adding workflow for using Rclone to upload to R2 #21227

wants to merge 2 commits into from

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Mar 28, 2025

Summary

  1. Adding new workflow for using Rclone to upload multiple objects to R2.
  2. Recommending using Rclone upload method over dashboard by making it appear first in the page.
  3. Adding a note to explain dashboard only allows single object upload at a time, and that Rclone is better suited for multiple object upload.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@hyperlint-ai Hyperlint AI
Copy link
Contributor

hyperlint-ai bot commented Mar 28, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Added a new workflow for using Rclone to upload multiple objects to R2, emphasizing its advantages over the Cloudflare dashboard.

  • Introduced a new section for uploading objects via Rclone.
  • Recommended Rclone as the preferred method for multiple object uploads.
  • Added a note explaining the limitations of the Cloudflare dashboard for uploads.

Modified Files

  • src/content/docs/r2/objects/upload-objects.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@Oxyjun Oxyjun self-assigned this Mar 28, 2025
@Oxyjun
Copy link
Contributor Author

Oxyjun commented Mar 28, 2025

CC: @harshil1712 could you check if the steps for configuring / uploading via Rclone is accurate? I tried it myself, but want to double check.

@github-actions GitHub Actions
Copy link
Contributor

Preview URL: https://b005b732.preview.developers.cloudflare.com
Preview Branch URL: https://jun-r2-upload-rclone.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/r2/objects/upload-objects/ https://jun-r2-upload-rclone.preview.developers.cloudflare.com/r2/objects/upload-objects/

@github-actions github-actions bot added product:r2 R2 object storage: https://developers.cloudflare.com/r2 size/s labels Mar 28, 2025
harshil1712
harshil1712 reviewed Mar 31, 2025
View reviewed changes
src/content/docs/r2/objects/upload-objects.mdx
:::note
Use Rclone if you wish to upload multiple objects to R2.

Cloudflare dashboard only allows you to upload one object at a time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct. I was able to upload multiple objects with drag & drop and even going through the File select option.

src/content/docs/r2/objects/upload-objects.mdx
You can upload objects to your bucket from the Cloudflare dashboard or using the Wrangler.

## Upload objects via Rclone

Rclone is a command-line tool which manages files on cloud storage. You can use Rclone to upload objects to R2. To use Rclone, install it onto your machine:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should link to the docs and let the user decide the method based on the OS. Since there are multiple methods for a single OS: https://rclone.org/install/

src/content/docs/r2/objects/upload-objects.mdx
You can upload objects to your bucket from the Cloudflare dashboard or using the Wrangler.

## Upload objects via Rclone
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have example for rclone. Should we reference it instead?
https://developers.cloudflare.com/r2/examples/rclone/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harshil1712 harshil1712 harshil1712 left review comments

@marciocloudflare marciocloudflare marciocloudflare approved these changes

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@jonesphillip jonesphillip Awaiting requested review from jonesphillip jonesphillip is a code owner

Assignees

@elithrar elithrar

@jonesphillip jonesphillip

@harshil1712 harshil1712

@Oxyjun Oxyjun

Labels
product:r2 R2 object storage: https://developers.cloudflare.com/r2 size/s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@Oxyjun @harshil1712 @marciocloudflare @elithrar @jonesphillip