Skip to content

Commit a8cae8f

Browse files
[Turnstile] Documentation overhaul (#24068)
* new structure * sidebar nav order * plans * widget overview * widget config * widget mgmt pt 1 * widget mgmt pt 2 * dash * client-side * updates * api * server side validation updates contd * update structure * terraform * server-side validation * edits * broken links * broken links pt 2 * edits again * redirects and edits * possible broken links * fix redirect * fixes * some edits * feedback * testing
1 parent 3ad99b0 commit a8cae8f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2226
-1096
lines changed

public/__redirects

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1549,6 +1549,16 @@
15491549
/turnstile/concepts/widget-types/ /turnstile/concepts/widget/ 301
15501550
/turnstile/concepts/domain-management/ /turnstile/concepts/hostname-management/ 301
15511551
/turnstile/troubleshooting/challenge-solve-issues/ /cloudflare-challenges/troubleshooting/challenge-solve-issues/ 301
1552+
/turnstile/concepts/ephemeral-id/ /turnstile/additional-configuration/ephemeral-id/ 301
1553+
/turnstile/concepts/hostname-management/ /turnstile/additional-configuration/hostname-management/ 301
1554+
/turnstile/concepts/pre-clearance-support/ /cloudflare-challenges/concepts/clearance/ 301
1555+
/turnstile/api-reference/ /turnstile/get-started/widget-management/api/ 301
1556+
/turnstile/concepts/appearance-modes/ /turnstile/get-started/client-side-rendering/widget-configurations/ 301
1557+
/turnstile/demos/ /turnstile/tutorials/ 301
1558+
/turnstile/get-started/pre-clearance/ /cloudflare-challenges/concepts/clearance/ 301
1559+
/turnstile/get-started/terraform/ /turnstile/get-started/widget-management/terraform/ 301
1560+
/turnstile/glossary/ /turnstile/ 301
1561+
/turnstile/get-started/supported-browsers/ /cloudflare-challenges/reference/supported-browsers/ 301
15521562

15531563
# waf
15541564
/waf/about/ /waf/concepts/ 301

src/content/docs/cloudflare-challenges/concepts/clearance.mdx

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,31 @@ Allows a user with a clearance cookie to not be challenged by JavaScript Challen
6464

6565
### Clearance cookie duration
6666

67-
Clearance cookies generated by the Turnstile widget will be valid for the time specified by the zone-level Challenge Passage value. To configure the Challenge Passage setting, refer to the [Cloudflare Challenges documentation](/cloudflare-challenges/challenge-types/challenge-pages/challenge-passage/).
67+
Clearance cookies generated by the Turnstile widget will be valid for the time specified by the zone-level Challenge Passage value. To configure the Challenge Passage setting, refer to [Challenge Passage](/cloudflare-challenges/challenge-types/challenge-pages/challenge-passage/).
6868

6969
### Setup
7070

71-
To set up pre-clearance cookies for Turnstile, refer to [Enable pre-clearance cookies](/turnstile/get-started/pre-clearance/).
71+
To enable pre-clearance, you must ensure that the hostname of the Turnstile widget matches the zone with the WAF rules. During the Turnstile configuration setup in the Cloudflare dashboard, you have access to a list of registered zones. Select the appropriate hostname from this list.
72+
73+
The prerequisite is crucial for pre-clearance to function properly. If set up correctly, visitors who successfully solve Turnstile will receive a cookie with the security clearance level set by the customer. When encountering a WAF challenge on the same zone, they will bypass additional challenges for the configured clearance level and below.
74+
75+
For more details on managing hostnames, refer to the [Hostname Management documentation](/turnstile/additional-configuration/hostname-management/).
76+
77+
<Render file="cf-clearance-cookie" product="cloudflare-challenges" />
78+
79+
#### Enable pre-clearance on a new site
80+
81+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
82+
2. Go to **Turnstile** > **Add widget**.
83+
3. Under **Would you like to opt for pre-clearance for this site?** select **Yes**.
84+
4. Choose the pre-clearance level from the select box.
85+
5. Select **Create**.
86+
87+
#### Enable pre-clearance on an existing site
88+
89+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
90+
2. Go to **Turnstile**.
91+
3. Go to the existing widget or site and select **Settings**.
92+
4. Under **Would you like to opt for pre-clearance for this site?** select **Yes**.
93+
5. Choose the pre-clearance level from the select box.
94+
6. Select **Update**.

src/content/docs/cloudflare-challenges/frequently-asked-questions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Block Amazon Web Services (AWS) and Google Cloud Platform (GCP) because of large
8585

8686
Previously, unless you customize your front-end application, any AJAX request that is challenged will fail because AJAX calls are not rendered in the DOM.
8787

88-
Now, you can [opt-in to Turnstile's Pre-clearance cookies](/turnstile/concepts/pre-clearance-support/). This allows you to issue a Challenge early in your web application flow and pre-clear users to interact with sensitive APIs. Clearance cookies issued by a Turnstile widget are automatically applied to the Cloudflare zone that the Turnstile widget is embedded on, with no configuration necessary. The duration of the clearance cookie's validity is controlled by the zone-specific configurable [Challenge Passage](/cloudflare-challenges/challenge-types/challenge-pages/challenge-passage/) security setting.
88+
Now, you can [opt-in to Turnstile's Pre-clearance cookies](/cloudflare-challenges/concepts/clearance/#pre-clearance-support-in-turnstile). This allows you to issue a Challenge early in your web application flow and pre-clear users to interact with sensitive APIs. Clearance cookies issued by a Turnstile widget are automatically applied to the Cloudflare zone that the Turnstile widget is embedded on, with no configuration necessary. The duration of the clearance cookie's validity is controlled by the zone-specific configurable [Challenge Passage](/cloudflare-challenges/challenge-types/challenge-pages/challenge-passage/) security setting.
8989

9090
## Why would I not find any failed Challenges?
9191

File renamed without changes.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Additional configurations
3+
pcx_content_type: navigation
4+
sidebar:
5+
order: 5
6+
group:
7+
hideIndex: true
8+
9+
---
10+
11+
import { DirectoryListing } from "~/components"
12+
13+
Refer to the following pages for more information about Turnstile's additional configurations:
14+
15+
<DirectoryListing />

src/content/docs/turnstile/api-reference.mdx

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/content/docs/turnstile/concepts/appearance-modes.mdx

Lines changed: 0 additions & 53 deletions
This file was deleted.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Cloudflare Challenges
3+
pcx_content_type: navigation
4+
external_link: /cloudflare-challenges/
5+
sidebar:
6+
order: 2
7+
8+
---

0 commit comments

Comments
 (0)