Skip to content

[WR] Updates to WR docs #22009

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

Merged
merged 3 commits into from
Apr 29, 2025
+44 −11
Merged

[WR] Updates to WR docs #22009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d99ce4f
Updates to WR docs
angelampcosta Apr 28, 2025
ca0d42c
Update src/content/docs/waiting-room/reference/queueing-methods.mdx
angelampcosta Apr 28, 2025
54ad4a7
Update src/content/docs/waiting-room/how-to/customize-waiting-room.mdx
angelampcosta Apr 29, 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
29 changes: 29 additions & 0 deletions src/content/docs/waiting-room/how-to/customize-waiting-room.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,35 @@ The following script within the `<body>` section after `<main>` fetches the wait
</script>
```

#### Turnstile variable

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.

```html
<!DOCTYPE html>
<html>
<head>
<title>Waiting Room</title>
</head>
<body>
<h1>You are currently in the queue.</h1>
{{#waitTimeKnown}}
<h2>Your estimated wait time is {{waitTimeFormatted}}.</h2>
{{/waitTimeKnown}}
{{^waitTimeKnown}}
<h2>Your estimated wait time is unknown.</h2>
{{/waitTimeKnown}}
{{#turnstile}}
<!-- for a managed (and potentially interactive) challenge, you may want to instruct the user to complete the challenge -->
<p>Please complete this challenge so we know you're a human:</p>
{{{turnstile}}} <!-- include the turnstile widget -->
{{/turnstile}}
</body>
</html>
```

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.

#### Available variables

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/).
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/waiting-room/plans.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import { FeatureTable, Render } from "~/components"

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

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.

<FeatureTable id="traffic.waiting_room" />

<Render file="non-contract-enablement" product="fundamentals" />
Expand Down
2 changes: 2 additions & 0 deletions src/content/docs/waiting-room/reference/queueing-methods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Allow all traffic to pass immediately through your waiting room and into your ap

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.

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.

## Reject

Prevent any traffic from reaching your application by setting its `queueing_method` to **reject**. Users will get a static page.
Expand Down
22 changes: 11 additions & 11 deletions src/content/plans/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3187,47 +3187,47 @@
"free": 0,
"pro": 0,
"biz": 1,
"ent": "1 (default)\n\n<em>With add-on</em>\nCustom (can purchase more)"
"ent": "1 (default)\n\n<em>With advanced:</em>\nCustom (can purchase more)"
},
"customized_templates": {
"title": "Customized templates",
"link": "/waiting-room/how-to/customize-waiting-room/",
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"queueing_methods": {
"title": "Queueing methods",
"link": "/waiting-room/reference/queueing-methods/",
"free": "No",
"pro": "No",
"biz": "First In First Out (FIFO)",
"ent": "First In First Out (FIFO) (default)\n\n<em>With add-on</em>\nAll options"
"ent": "First In First Out (FIFO) (default)\n\n<em>With advanced:</em>\nFIFO, Random, Reject, Passthrough"
},
"configure_multiple_hostnames_paths": {
"title": "Configure multiple hostnames and paths",
"link": "/waiting-room/how-to/place-waiting-room/",
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"disable_session_renewal": {
"title": "Disable session renewal",
"link": "/waiting-room/reference/configuration-settings/",
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"json_response": {
"title": "JSON-friendly response",
"link": "/waiting-room/how-to/json-response/",
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"k_customize_queuing_status_code": {
"title": "Customize queuing status code",
Expand All @@ -3243,23 +3243,23 @@
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"rules": {
"title": "Waiting Room rules",
"link": "/waiting-room/additional-options/waiting-room-rules/",
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"session_revocation": {
"title": "Session Revocation",
"link": "/waiting-room/how-to/control-user-session/#revoke-a-users-session-using-origin-commands",
"free": "No",
"pro": "No",
"biz": "No",
"ent": "Paid add-on"
"ent": "Advanced add-on"
},
"seo_crawler": {
"title": "SEO Crawler Bypassing",
Expand All @@ -3275,15 +3275,15 @@
"free": "No",
"pro": "No",
"biz": "Invisible only",
"ent": "Invisible (default)\n\n<em>With add-on</em>\nAll options"
"ent": "Invisible (default)\n\n<em>With advanced:</em>\nInvisible, Managed, Non Interactive"
},
"turnstile_fail_action": {
"title": "Turnstile Fail Action",
"link": "/waiting-room/how-to/create-waiting-room/",
"free": "No",
"pro": "No",
"biz": "Log only",
"ent": "Log only (default)\n\n<em>With add-on</em>\nInfinite queue"
"ent": "Log only (default)\n\n<em>With advanced:</em>\nLog only & Infinite queue"
}
}
}
Expand Down
Loading