From 573c0e6bcd494da0d135f2e4c3bf9e2e858f85ba Mon Sep 17 00:00:00 2001 From: Angela Costa Date: Mon, 3 Feb 2025 10:07:00 +0000 Subject: [PATCH 1/2] Tunstile in waiting room --- .../how-to/create-waiting-room.mdx | 11 ++++---- .../reference/configuration-settings.mdx | 28 +++++++++++++++++++ src/content/plans/index.json | 16 +++++++++++ 3 files changed, 50 insertions(+), 5 deletions(-) diff --git a/src/content/docs/waiting-room/how-to/create-waiting-room.mdx b/src/content/docs/waiting-room/how-to/create-waiting-room.mdx index baaacd7007baaf5..466be4ca0b472a1 100644 --- a/src/content/docs/waiting-room/how-to/create-waiting-room.mdx +++ b/src/content/docs/waiting-room/how-to/create-waiting-room.mdx @@ -22,11 +22,12 @@ For additional context on creating a waiting room, refer to [Get started](/waiti 2. Select **Create**. 3. Customize the [settings](/waiting-room/reference/configuration-settings/) for your waiting room. For additional guidance refer to [Best practices](/waiting-room/reference/best-practices/). 4. Select **Next**. -5. If you wish to [customize your waiting room](/waiting-room/how-to/customize-waiting-room/), update the HTML and CSS as needed. If you are using this waiting room to manage traffic for your mobile app or API, enable the JSON response toggle. Make sure that you have set up a [JSON friendly response](/waiting-room/how-to/json-response/) for your client (mobile or web app). -6. Select the **Queuing status code** to determine the HTTP status code that is returned when a user is in the waiting room. -7. Select **Next**. -8. Review your settings before saving. If you customized your waiting room, make sure to [preview the result](/waiting-room/how-to/customize-waiting-room/#preview-waiting-room). -9. Select **Save**. Your new waiting room will be enabled by default. +5. In this section, you can choose whether to enable [Turnstile](/turnstile/) for your waiting room. If you select **Yes**, you will need to choose your [Widget mode](/turnstile/concepts/widget/) and define the action to take if a turnstile challenge fails. The available Widget modes and actions depend on your plan type. Refer to the [Plans](/waiting-room/plans/) for more details. +6. If you wish to [customize your waiting room](/waiting-room/how-to/customize-waiting-room/), update the HTML and CSS as needed. If you are using this waiting room to manage traffic for your mobile app or API, enable the JSON response toggle. Make sure that you have set up a [JSON friendly response](/waiting-room/how-to/json-response/) for your client (mobile or web app). +7. Select the **Queuing status code** to determine the HTTP status code that is returned when a user is in the waiting room. +8. Select **Next**. +9. Review your settings before saving. If you customized your waiting room, make sure to [preview the result](/waiting-room/how-to/customize-waiting-room/#preview-waiting-room). +10. Select **Save**. Your new waiting room will be enabled by default. diff --git a/src/content/docs/waiting-room/reference/configuration-settings.mdx b/src/content/docs/waiting-room/reference/configuration-settings.mdx index cc869af46c9e069..262a23c318ddd81 100644 --- a/src/content/docs/waiting-room/reference/configuration-settings.mdx +++ b/src/content/docs/waiting-room/reference/configuration-settings.mdx @@ -202,6 +202,34 @@ You can customize a variety of options for your waiting rooms. + + Turnstile Widget Mode + + turnstile_mode + + Yes, defaults invisible. + + The type of Turnstile widget to use - refer to the [Turnstile documentation](turnstile/concepts/widget/#widget-types) for details. Valid values are off, invisible, visible_non_interactive, and visible_managed. Setting this to off will completely disable the Turnstile integration. + + + Setting this to invisible makes sense for most rooms, unless you would like end users to be aware the challenge is running. + + + + + Turnstile Fail Action + + turnstile_action + + Yes, defaults to log. + + The action to take when an end user fails a Turnstile challenge. Valid values are log and infinite_queue. + + + Setting this to log makes sense for most rooms, unless you wish to aggressively block bots using an infinite queue. + + + diff --git a/src/content/plans/index.json b/src/content/plans/index.json index c7180cc4e6bb2ab..aed6dad90c8e302 100644 --- a/src/content/plans/index.json +++ b/src/content/plans/index.json @@ -3125,6 +3125,22 @@ "pro": "No", "biz": "Yes", "ent": "Yes" + }, + "turnstile_widget_mode": { + "title": "Turnstile Widget Mode", + "link": "/waiting-room/how-to/create-waiting-room/", + "free": "No", + "pro": "No", + "biz": "Invisible only", + "ent": "Invisible (default)\n\nWith add-on\nAll options" + }, + "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\nWith add-on\nInfinite queue" } } } From dad409c787f9633cfd5908481d7a1c4d800f504e Mon Sep 17 00:00:00 2001 From: Angela Costa Date: Mon, 3 Feb 2025 10:18:34 +0000 Subject: [PATCH 2/2] Corrects link --- .../docs/waiting-room/reference/configuration-settings.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/waiting-room/reference/configuration-settings.mdx b/src/content/docs/waiting-room/reference/configuration-settings.mdx index 262a23c318ddd81..405eeafb3ed97a4 100644 --- a/src/content/docs/waiting-room/reference/configuration-settings.mdx +++ b/src/content/docs/waiting-room/reference/configuration-settings.mdx @@ -209,7 +209,7 @@ You can customize a variety of options for your waiting rooms. Yes, defaults invisible. - The type of Turnstile widget to use - refer to the [Turnstile documentation](turnstile/concepts/widget/#widget-types) for details. Valid values are off, invisible, visible_non_interactive, and visible_managed. Setting this to off will completely disable the Turnstile integration. + The type of Turnstile widget to use - refer to the [Turnstile documentation](/turnstile/concepts/widget/#widget-types) for details. Valid values are off, invisible, visible_non_interactive, and visible_managed. Setting this to off will completely disable the Turnstile integration. Setting this to invisible makes sense for most rooms, unless you would like end users to be aware the challenge is running.