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
[Workers] Workers Preview URLs now default to disabled (configuration.mdx, previews.mdx) (#24756)
* docs: Workers Preview URLs now default to disabled
We're making changes in Wrangler and Dashboard so that Preview URLs
default to disabled. Change the docs to reflect that.
* Update src/content/docs/workers/configuration/previews.mdx
---------
Co-authored-by: Caley Burton <[email protected]>
- Or when you make edits via the Cloudflare dashboard
47
47
48
-
These URLs are public by default and available immediately after version creation.
48
+
If Preview URLs have been enabled, they are **public by default** and available immediately after version creation.
49
49
50
50
:::note
51
51
Minimum required Wrangler version: 3.74.0. Check your version by running `wrangler --version`. To update Wrangler, refer to [Install/Update Wrangler](/workers/wrangler/install-and-update/).
@@ -90,7 +90,7 @@ The resulting alias would be associated with this version, and immediately avail
90
90
91
91
## Manage access to Preview URLs
92
92
93
-
By default, all preview URLs are enabled and available publicly. You can use [Cloudflare Access](/cloudflare-one/policies/access/) to require visitors to authenticate before accessing preview URLs. You can limit access to yourself, your teammates, your organization, or anyone else you specify in your [access policy](/cloudflare-one/policies/access).
93
+
When enabled, all preview URLs are available publicly. You can use [Cloudflare Access](/cloudflare-one/policies/access/) to require visitors to authenticate before accessing preview URLs. You can limit access to yourself, your teammates, your organization, or anyone else you specify in your [access policy](/cloudflare-one/policies/access).
94
94
95
95
To limit your preview URLs to authorized emails only:
96
96
@@ -116,46 +116,56 @@ You must press enter after you input your Application domain for it to save. You
116
116
10. Go to the next page.
117
117
11. Add application.
118
118
119
-
## Disabling Preview URLs
119
+
## Toggle Preview URLs (Enable or Disable)
120
120
121
-
Disabling Preview URLs will disable routing to both versioned and aliased preview URLs.
121
+
Note:
122
122
123
-
### Disabling Preview URLs in the dashboard
123
+
- Preview URLs are disabled by default.
124
+
- Disabling Preview URLs will disable routing to both versioned and aliased preview URLs.
124
125
125
-
To disable Preview URLs for a Worker:
126
+
### From the Dashboard
127
+
128
+
To toggle Preview URLs for a Worker:
126
129
127
130
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
128
131
2. Go to **Workers & Pages** and in **Overview**, select your Worker.
129
132
3. Go to **Settings** > **Domains & Routes**.
130
-
4.On "Preview URLs" click "Disable".
131
-
5. Confirm you want to disable.
133
+
4.For Preview URLs, click **Enable** or **Disable**.
134
+
5. Confirm your action.
132
135
133
-
### Disabling Preview URLs in the [Wrangler configuration file](/workers/wrangler/configuration/)
136
+
### From the [Wrangler configuration file](/workers/wrangler/configuration/)
134
137
135
138
:::note
136
139
Wrangler 3.91.0 or higher is required to use this feature.
137
140
:::
138
141
139
-
To disable Preview URLs for a Worker, include the following in your Worker's Wrangler file:
142
+
:::note
143
+
Older Wrangler versions will default to Preview URLs being enabled.
144
+
:::
145
+
146
+
To toggle Preview URLs for a Worker, include any of the following in your Worker's Wrangler file:
140
147
141
148
<WranglerConfig>
149
+
```toml
150
+
preview_urls = true
151
+
```
152
+
</WranglerConfig>
142
153
154
+
<WranglerConfig>
143
155
```toml
144
156
preview_urls = false
145
157
```
146
-
147
158
</WranglerConfig>
148
159
149
-
When you redeploy your Worker with this change, Preview URLs will be disabled.
160
+
If not given, `preview_urls = false` is the default.
150
161
151
162
:::caution
152
-
153
-
If you disable Preview URLs in the Cloudflare dashboard but do not update your Worker's Wrangler file with `preview_urls = false`, then Preview URLs will be re-enabled the next time you deploy your Worker with Wrangler.
163
+
If you enable or disable Preview URLs in the Cloudflare dashboard, but do not update your Worker's Wrangler file accordingly, the Preview URLs status will change the next time you deploy your Worker with Wrangler.
154
164
:::
155
165
156
166
## Limitations
157
167
158
168
- Preview URLs are not generated for Workers that implement a [Durable Object](/durable-objects/).
159
169
- Preview URLs are not currently generated for [Workers for Platforms](/cloudflare-for-platforms/workers-for-platforms/)[user Workers](/cloudflare-for-platforms/workers-for-platforms/reference/how-workers-for-platforms-works/#user-workers). This is a temporary limitation, we are working to remove it.
160
170
- You cannot currently configure Preview URLs to run on a subdomain other than [`workers.dev`](/workers/configuration/routing/workers-dev/).
161
-
- You cannot view logs for Preview URLs today, this includes Workers Logs, Wrangler tail and Logpush.
171
+
- You cannot view logs for Preview URLs today, this includes Workers Logs, Wrangler tail and Logpush.
Copy file name to clipboardExpand all lines: src/content/docs/workers/wrangler/configuration.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -118,7 +118,7 @@ The `main` key is optional for assets-only Workers.
118
118
- Enables use of `*.workers.dev` subdomain to deploy your Worker. If you have a Worker that is only for `scheduled` events, you can set this to `false`. Defaults to `true`. Refer to [types of routes](#types-of-routes).
0 commit comments