Skip to content

Commit 0aade3d

Browse files
angelampcostaOxyjun
authored and
daisyfaithauma
committed
[WR] Updates to WR docs (#22009)
* Updates to WR docs * Update src/content/docs/waiting-room/reference/queueing-methods.mdx Co-authored-by: Jun Lee <[email protected]> * Update src/content/docs/waiting-room/how-to/customize-waiting-room.mdx --------- Co-authored-by: Jun Lee <[email protected]>
1 parent 6565a22 commit 0aade3d

File tree

4 files changed

+44
-11
lines changed

4 files changed

+44
-11
lines changed

‎src/content/docs/waiting-room/how-to/customize-waiting-room.mdx‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,35 @@ The following script within the `<body>` section after `<main>` fetches the wait
9696
</script>
9797
```
9898

99+
#### Turnstile variable
100+
101+
If you are using Turnstile for your customized waiting room, you will need to ensure the `turnstile` variable is added. The default queuing page template and any newly created custom templates already include this variable. If you have an existing custom HTML template and wish to enable the Turnstile integration, you will need to add `{{{turnstile}}}` somewhere in the template to let Waiting Room know where the widget should be placed. Waiting Room uses Mustache templates, so including raw HTML within your template without escaping requires three curly braces instead of two.
102+
103+
```html
104+
<!DOCTYPE html>
105+
<html>
106+
<head>
107+
<title>Waiting Room</title>
108+
</head>
109+
<body>
110+
<h1>You are currently in the queue.</h1>
111+
{{#waitTimeKnown}}
112+
<h2>Your estimated wait time is {{waitTimeFormatted}}.</h2>
113+
{{/waitTimeKnown}}
114+
{{^waitTimeKnown}}
115+
<h2>Your estimated wait time is unknown.</h2>
116+
{{/waitTimeKnown}}
117+
{{#turnstile}}
118+
<!-- for a managed (and potentially interactive) challenge, you may want to instruct the user to complete the challenge -->
119+
<p>Please complete this challenge so we know you're a human:</p>
120+
{{{turnstile}}} <!-- include the turnstile widget -->
121+
{{/turnstile}}
122+
</body>
123+
</html>
124+
```
125+
126+
When using Infinite Queue (especially with managed challenges which may be interactive), you may want to let users know that they will not be in the queue until they complete the challenge.
127+
99128
#### Available variables
100129

101130
When you create a waiting room with custom HTML, you can have access to several variables to customize your response. For a full list of variables, refer to the `json_response_enabled` parameter in the [Cloudflare API docs](/api/resources/waiting_rooms/methods/create/).

‎src/content/docs/waiting-room/plans.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import { FeatureTable, Render } from "~/components"
1414

1515
The features available for a waiting room depend on your plan type. You can only have **one plan** per zone.
1616

17+
One basic waiting room is included in all Business and Enterprise plans. On an Enterprise plan, you can purchase advanced waiting room(s) to unlock all of the additional advanced features.
18+
1719
<FeatureTable id="traffic.waiting_room" />
1820

1921
<Render file="non-contract-enablement" product="fundamentals" />

‎src/content/docs/waiting-room/reference/queueing-methods.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Allow all traffic to pass immediately through your waiting room and into your ap
4242

4343
Use this setup when you only want to use your waiting room for events — where you can update the queueing method — and otherwise avoid queueing during low-traffic hours.
4444

45+
Additionally, you can use this queuing method when you want to gather analytics on your traffic but do not want to queue any users. With passthrough on, all traffic will be sent directly to your origin. However, analytics will be gathered on `total active users`, `new users per minute` and `time on origin`. We recommend this as a useful test to gather insights into your traffic patterns to help determine appropriate threshold settings.
46+
4547
## Reject
4648

4749
Prevent any traffic from reaching your application by setting its `queueing_method` to **reject**. Users will get a static page.

‎src/content/plans/index.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3187,47 +3187,47 @@
31873187
"free": 0,
31883188
"pro": 0,
31893189
"biz": 1,
3190-
"ent": "1 (default)\n\n<em>With add-on</em>\nCustom (can purchase more)"
3190+
"ent": "1 (default)\n\n<em>With advanced:</em>\nCustom (can purchase more)"
31913191
},
31923192
"customized_templates": {
31933193
"title": "Customized templates",
31943194
"link": "/waiting-room/how-to/customize-waiting-room/",
31953195
"free": "No",
31963196
"pro": "No",
31973197
"biz": "No",
3198-
"ent": "Paid add-on"
3198+
"ent": "Advanced add-on"
31993199
},
32003200
"queueing_methods": {
32013201
"title": "Queueing methods",
32023202
"link": "/waiting-room/reference/queueing-methods/",
32033203
"free": "No",
32043204
"pro": "No",
32053205
"biz": "First In First Out (FIFO)",
3206-
"ent": "First In First Out (FIFO) (default)\n\n<em>With add-on</em>\nAll options"
3206+
"ent": "First In First Out (FIFO) (default)\n\n<em>With advanced:</em>\nFIFO, Random, Reject, Passthrough"
32073207
},
32083208
"configure_multiple_hostnames_paths": {
32093209
"title": "Configure multiple hostnames and paths",
32103210
"link": "/waiting-room/how-to/place-waiting-room/",
32113211
"free": "No",
32123212
"pro": "No",
32133213
"biz": "No",
3214-
"ent": "Paid add-on"
3214+
"ent": "Advanced add-on"
32153215
},
32163216
"disable_session_renewal": {
32173217
"title": "Disable session renewal",
32183218
"link": "/waiting-room/reference/configuration-settings/",
32193219
"free": "No",
32203220
"pro": "No",
32213221
"biz": "No",
3222-
"ent": "Paid add-on"
3222+
"ent": "Advanced add-on"
32233223
},
32243224
"json_response": {
32253225
"title": "JSON-friendly response",
32263226
"link": "/waiting-room/how-to/json-response/",
32273227
"free": "No",
32283228
"pro": "No",
32293229
"biz": "No",
3230-
"ent": "Paid add-on"
3230+
"ent": "Advanced add-on"
32313231
},
32323232
"k_customize_queuing_status_code": {
32333233
"title": "Customize queuing status code",
@@ -3243,23 +3243,23 @@
32433243
"free": "No",
32443244
"pro": "No",
32453245
"biz": "No",
3246-
"ent": "Paid add-on"
3246+
"ent": "Advanced add-on"
32473247
},
32483248
"rules": {
32493249
"title": "Waiting Room rules",
32503250
"link": "/waiting-room/additional-options/waiting-room-rules/",
32513251
"free": "No",
32523252
"pro": "No",
32533253
"biz": "No",
3254-
"ent": "Paid add-on"
3254+
"ent": "Advanced add-on"
32553255
},
32563256
"session_revocation": {
32573257
"title": "Session Revocation",
32583258
"link": "/waiting-room/how-to/control-user-session/#revoke-a-users-session-using-origin-commands",
32593259
"free": "No",
32603260
"pro": "No",
32613261
"biz": "No",
3262-
"ent": "Paid add-on"
3262+
"ent": "Advanced add-on"
32633263
},
32643264
"seo_crawler": {
32653265
"title": "SEO Crawler Bypassing",
@@ -3275,15 +3275,15 @@
32753275
"free": "No",
32763276
"pro": "No",
32773277
"biz": "Invisible only",
3278-
"ent": "Invisible (default)\n\n<em>With add-on</em>\nAll options"
3278+
"ent": "Invisible (default)\n\n<em>With advanced:</em>\nInvisible, Managed, Non Interactive"
32793279
},
32803280
"turnstile_fail_action": {
32813281
"title": "Turnstile Fail Action",
32823282
"link": "/waiting-room/how-to/create-waiting-room/",
32833283
"free": "No",
32843284
"pro": "No",
32853285
"biz": "Log only",
3286-
"ent": "Log only (default)\n\n<em>With add-on</em>\nInfinite queue"
3286+
"ent": "Log only (default)\n\n<em>With advanced:</em>\nLog only & Infinite queue"
32873287
}
32883288
}
32893289
}

0 commit comments

Comments
 (0)