Skip to content

Commit 21dfdb7

Browse files
smellercfOxyjun
authored andcommitted
[R2] Update custom domain docs to align with new UI (#22124)
* Update custom domain docs to align with new UI * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Jun Lee <[email protected]>
1 parent 73bc1ed commit 21dfdb7

File tree

3 files changed

+47
-38
lines changed

3 files changed

+47
-38
lines changed

src/content/docs/r2/buckets/public-buckets.mdx

Lines changed: 43 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ Public Bucket is a feature that allows users to expose the contents of their R2
1212
Public buckets can be set up in either one of two ways:
1313

1414
- Expose your bucket as a custom domain under your control.
15-
- Expose your bucket as a Cloudflare-managed subdomain under `https://r2.dev`.
15+
- Expose your bucket using a Cloudflare-managed `https://r2.dev` subdomain for non-production use cases.
1616

17-
To configure WAF custom rules, caching, access controls, or bot management for your bucket, you must do so through a custom domain.
18-
Using a custom domain does not require enabling `r2.dev`.
17+
These options can be used independently. Enabling custom domains does not require enabling `r2.dev` access.
18+
19+
To use features like WAF custom rules, caching, access controls, or bot management, you must configure your bucket behind a custom domain. These capabilities are not available when using the `r2.dev` development url.
1920

2021
:::note
2122

@@ -33,7 +34,9 @@ Configure your cache to use [Smart Tiered Cache](/cache/how-to/tiered-cache/#sma
3334

3435
:::note
3536

36-
By default, only certain file types are cached. To cache all files in your bucket, you must set a Cache Everything page rule. For more information on default Cache behavior and how to customize it, refer to [Default Cache Behavior](/cache/concepts/default-cache-behavior/#default-cached-file-extensions)
37+
By default, only certain file types are cached. To cache all files in your bucket, you must set a Cache Everything page rule.
38+
39+
For more information on default Cache behavior and how to customize it, refer to [Default Cache Behavior](/cache/concepts/default-cache-behavior/#default-cached-file-extensions)
3740

3841
:::
3942

@@ -46,14 +49,23 @@ To restrict access to your custom domain's bucket, use Cloudflare's existing sec
4649

4750
:::caution
4851

49-
Disable public access to your [`r2.dev` subdomain](#disable-managed-public-access) when using products like WAF or Cloudflare Access. If you do not disable public access, your bucket will remain publicly available through your `r2.dev` subdomain.
52+
Disable public access to your [`r2.dev` subdomain](#disable-public-development-url) when using products like WAF or Cloudflare Access. If you do not disable public access, your bucket will remain publicly available through your `r2.dev` subdomain.
5053

5154
:::
5255

5356
### Minimum TLS Version
5457

5558
To specify the minimum TLS version of a custom hostname of an R2 bucket, you can issue an API call to edit [R2 custom domain settings](/api/resources/r2/subresources/buckets/subresources/domains/subresources/custom/methods/update/).
5659

60+
## Add your domain to Cloudflare
61+
62+
The domain being used must have been added as a [zone](/fundamentals/setup/accounts-and-zones/#zones) in the same account as the R2 bucket.
63+
64+
- If your domain is already managed by Cloudflare, you can proceed to [Connect a bucket to a custom domain](/r2/buckets/public-buckets/#connect-a-bucket-to-a-custom-domain).
65+
- If your domain is not managed by Cloudflare, you need to set it up using a [partial (CNAME) setup](/dns/zone-setups/partial-setup/) to add it to your account.
66+
67+
Once the domain exists in your Cloudflare account (regardless of setup type), you can link it to your bucket.
68+
5769
## Connect a bucket to a custom domain
5870

5971
<Render file="custom-domain-steps" />
@@ -62,13 +74,11 @@ To view the added DNS record, select **...** next to the connected domain and se
6274

6375
:::note
6476

65-
If the zone is on an Enterprise plan, make sure that you [release the zone hold](/fundamentals/setup/account/account-security/zone-holds/#release-zone-holds) before adding the custom domain. A zone hold would prevent the custom subdomain from activating.
66-
67-
:::
77+
If the zone is on an Enterprise plan, make sure that you [release the zone hold](/fundamentals/setup/account/account-security/zone-holds/#release-zone-holds) before adding the custom domain.
6878

69-
### Restrictions
79+
A zone hold would prevent the custom subdomain from activating.
7080

71-
There is a restriction when using custom domains to access R2 buckets. The domain being used must have been added as a [zone](/fundamentals/setup/accounts-and-zones/#zones) in the same account as the R2 bucket.
81+
:::
7282

7383
## Disable domain access
7484

@@ -78,57 +88,57 @@ The specified domain will also remain connected to R2 until you remove it or del
7888
To disable a domain:
7989

8090
1. In **R2**, select the bucket you want to modify.
81-
2. On the bucket page, Select **Settings**.
82-
3. Under **Public access** > **Custom Domains**, select **Connect Domain**.
83-
4. Next to the domain you want to disable, select **...** and **Disable domain**.
84-
5. The badge under **Access to Bucket** will update to **Not allowed**.
91+
2. On the bucket page, Select **Settings**, go to **Custom Domains**.
92+
3. Next to the domain you want to disable, select **...** and **Disable domain**.
93+
4. The badge under **Access to Bucket** will update to **Not allowed**.
8594

8695
## Remove domain
8796

88-
Removing a domain will remove custom domain configuration that you have set up on the dashboard. Your bucket will still be publicly accessible.
97+
Removing a custom domain will disconnect it from your bucket and delete its configuration from the dashboard. Your bucket will remain publicly accessible through any other enabled access method, but the domain will no longer appear in the connected domains list.
8998

9099
To remove a domain:
91100

92101
1. In **R2**, select the bucket you want to modify.
93-
2. On the bucket page, select **Settings**.
94-
3. Under **Public access** > **Custom Domains**, select **Connect Domain**.
95-
4. Next to the domain you want to disable, select **...** and **Remove domain**.
96-
5. Select ‘Remove domain’ in the confirmation window. The CNAME record pointing to the domain will also be removed as part of this step. You can always add the domain again.
102+
2. On the bucket page, Select **Settings**, go to **Custom Domains**.
103+
3. Next to the domain you want to disable, select **...** and **Remove domain**.
104+
4. Select ‘Remove domain’ in the confirmation window. This step also removes the CNAME record pointing to the domain. You can always add the domain again.
97105

98-
The domain is no longer connected to your bucket and will no longer appear in the connected domains list.
106+
## Public development URL
99107

100-
## Enable managed public access
101-
102-
When you enable managed public access for your bucket, the content of your bucket is available to the Internet through a Cloudflare-managed `r2.dev` subdomain.
108+
Expose the contents of this R2 bucket to the internet through a Cloudflare-managed r2.dev subdomain. This endpoint is intended for non-production traffic.
103109

104110
:::note
105111

106112
Public access through `r2.dev` subdomains are rate limited and should only be used for development purposes.
107113

108114
To enable access management, Cache and bot management features, you must set up a custom domain when enabling public access to your bucket.
109115

116+
Avoid creating a CNAME record pointing to the `r2.dev` subdomain. This is an **unsupported access path**, and we cannot guarantee consistent reliability or performance. For production use, [add your domain to Cloudflare](#add-your-domain-to-cloudflare) instead.
110117
:::
111118

119+
### Enable public development url
120+
121+
When you enable public development URL access for your bucket, its contents become available on the internet through a Cloudflare-managed `r2.dev` subdomain.
122+
112123
To enable access through `r2.dev` for your buckets:
113124

114125
1. In **R2**, select the bucket you want to modify.
115126
2. On the bucket page, select **Settings**.
116-
3. In **Settings**, go to **Public Access**.
117-
4. Under **R2.dev subdomain**, select **Allow Access**.
118-
5. In **Allow Public Access?**, confirm your choice by typing ‘allow’ to confirm and select **Allow**.
119-
6. You can now access the bucket and its objects using the Public Bucket URL.
127+
3. Under **Public Development URL**, select **Enable**.
128+
4. In **Allow Public Access?**, confirm your choice by typing ‘allow’ to confirm and select **Allow**.
129+
5. You can now access the bucket and its objects using the Public Bucket URL.
130+
131+
To verify that your bucket is publicly accessible, check that **Public URL Access** shows **Allowed** in you bucket settings.
120132

121-
You can review if your bucket is publicly accessible by going to your bucket and checking that **Public URL Access** states **Allowed**.
133+
### Disable public development url
122134

123-
## Disable managed public access
135+
Disabling public development URL access removes your bucket’s exposure through the `r2.dev` subdomain. The bucket and its objects will no longer be accessible via the Public Bucket URL.
124136

125-
Your bucket will not be exposed to the Internet as an `r2.dev` subdomain after you disable public access. If you have connected other domains, the bucket will remain accessible on those domains.
137+
If you have connected other domains, the bucket will remain accessible for those domains.
126138

127139
To disable public access for your bucket:
128140

129141
1. In **R2**, select the bucket you want to modify.
130142
2. On the bucket page, select **Settings**.
131-
3. Under **Bucket Details** > **R2.dev subdomain**, select **Disallow Access**.
143+
3. Under **Public Development URL**, select **Disable**.
132144
4. In **Disallow Public Access?**, type ‘disallow’ to confirm and select **Disallow**.
133-
134-
Your bucket and its objects can no longer be accessed using the Public Bucket URL.

src/content/docs/r2/data-migration/sippy.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Before getting started, you will need:
4444

4545
1. From the Cloudflare dashboard, select **R2** from the sidebar.
4646
2. Select the bucket you'd like to migrate objects to.
47-
3. Switch to the **Settings** tab, then scroll down to the **Incremental migration** card.
47+
3. Switch to the **Settings** tab, then scroll down to the **On Demand Migration** card.
4848
4. Select **Enable** and enter details for the AWS / GCS bucket you'd like to migrate objects from. The credentials you enter must have permissions to read from this bucket. Cloudflare also recommends scoping your credentials to only allow reads from this bucket.
4949
5. Select **Enable**.
5050

@@ -122,7 +122,7 @@ You can optionally select a time window to query. This defaults to the last 24 h
122122

123123
1. From the Cloudflare dashboard, select **R2** from the sidebar.
124124
2. Select the bucket you'd like to disable Sippy for.
125-
3. Switch to the **Settings** tab and scroll down to the **Incremental migration** card.
125+
3. Switch to the **Settings** tab and scroll down to the **On Demand Migration** card.
126126
4. Press **Disable**.
127127

128128
### Wrangler
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
22
{}
3-
43
---
54

65
1. Go to **R2** and select your bucket.
76
2. On the bucket page, select **Settings**.
8-
3. Under **Public access** > **Custom Domains**, select **Connect Domain**.
7+
3. Under **Custom Domains**, select **Add**.
98
4. Enter the domain name you want to connect to and select **Continue**.
109
5. Review the new record that will be added to the DNS table and select **Connect Domain**.
1110

12-
Your domain is now connected. The status takes a few minutes to change from **Initializing** to **Active**, and you may need to refresh to review the status update. If the status has not changed, select the *...* next to your bucket and select **Retry connection**.
11+
Your domain is now connected. The status takes a few minutes to change from **Initializing** to **Active**, and you may need to refresh to review the status update. If the status has not changed, select the _..._ next to your bucket and select **Retry connection**.

0 commit comments

Comments
 (0)