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.

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

docs: added Cloudflare R2 guide for Object Storage #10497

Merged
merged 18 commits into from
Jan 8, 2025
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
c96632e
Add Cloudflare R2 guide for Object Storage
ehtisham-afzal Dec 8, 2024
467ad2a
Merge branch 'develop' into sham
ehtisham-afzal Dec 28, 2024
eef9cf8
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
f15bb01
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
4bca599
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
83838c6
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
33e3898
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
f3def28
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
57e7bef
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
34e76b3
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
089ee4e
Merge branch 'develop' into sham
ehtisham-afzal Dec 31, 2024
cbad88f
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
3350e2f
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
6b83e72
Update www/apps/resources/app/architectural-modules/file/s3/page.mdx
ehtisham-afzal Dec 31, 2024
c6f3c01
Merge branch 'develop' into sham
ehtisham-afzal Jan 3, 2025
26e2fe3
Merge branch 'develop' into sham
ehtisham-afzal Jan 7, 2025
4014931
suggestions applied on pull req #10497
ehtisham-afzal Jan 7, 2025
3bd2865
Update page.mdx
shahednasser Jan 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions www/apps/resources/app/architectural-modules/file/s3/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,30 @@ The S3 File Module Provider integrates Amazon S3 and services following a compat
4. Click ALL for "Allowed Operations", click the "Review" button, then the "Save policy" button.

</TabsContent>
<TabsContent value="Cloudflare R2">
1. Create a [Cloudflare account](https://dash.cloudflare.com/sign-up).
2. Set up your R2 bucket:
- Navigate to R2 Object Storage in your dashboard. You may need to provide your credit-card information.
- Click "Create bucket"
- Enter a unique bucket name
- Select "Automatic" for location
- Choose "Standard" for storage class
- Confirm by clicking "Create bucket"
3. Configure public access:
- On your bucket's dashboard, click on the Settings tab.
- Scroll down to the Public Access section, and click on "Allow Access" in the "R2.dev subdomain" card.
- Type 'allow' to confirm
- Copy the Public R2.dev Bucket URL for your `S3_FILE_URL`
4. Retrieve credentials:
- [Go to API tokens page](https://dash.cloudflare.com/?to=/:account/r2/api-tokens):
- Select "Create API token"
- Edit the "R2 Token" name
- Under Permissions, select Object Read & Write permission types
- You can optionally specify the buckets that this API token has access to under the "Specify bucket(s)" section.
- Once done, click the "Create API Token" button.
- You'll receive an access key ID and a secret access key. Save them to use them later for the `S3_ACCESS_KEY_ID` and `S3_SECRET_ACCESS_KEY` environment variables.

</TabsContent>
</TabsContentWrapper>
</Tabs>

Expand Down Expand Up @@ -170,6 +194,7 @@ module.exports = {
- For MinIO, it's the URL to the MinIO server with the bucket's name. For example, `https://{server-domain}/{bucket}`.
- For DigitalOcean Spaces, it's either the Origin Endpoint or the CDN endpoint of your Spaces Object Storage bucket.
- for Supabase, it's `https://{uniqueID}.supabase.co/storage/v1/object/public/{bucket}`. You can retrieve the `uniqueID` from [Storage Settings](https://supabase.com/docs/guides/storage/s3/authentication?queryGroups=language&language=javascript#s3-access-keys) page in the Endpoint URL.
- For Cloudflare R2, it's `Public R2.dev Bucket URL`.

</Table.Cell>
<Table.Cell>
Expand Down Expand Up @@ -223,6 +248,8 @@ module.exports = {
The bucket's region code.

For MinIO, use `us-east-1`.

For Cloudflare, use `auto`.

</Table.Cell>
<Table.Cell>
Expand Down Expand Up @@ -262,6 +289,7 @@ module.exports = {
- For MinIO, it's the URL to the MinIO server.
- For DigitalOcean Spaces, it's the Spaces Origin Endpoint of the format `https://{region}.digitaloceanspaces.com`.
- For Supabase, it's the Endpoint URL in the [Storage Settings](https://supabase.com/docs/guides/storage/s3/authentication?queryGroups=language&language=javascript#s3-access-keys).
- For Cloudflare, it's `https://{your-account-id}.r2.cloudflarestorage.com`.

</Table.Cell>
<Table.Cell>
Expand Down
Loading