Skip to content

Commit 573c0e6

Browse files
committed
Tunstile in waiting room
1 parent bfa8e6b commit 573c0e6

File tree

3 files changed

+50
-5
lines changed

3 files changed

+50
-5
lines changed

src/content/docs/waiting-room/how-to/create-waiting-room.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ For additional context on creating a waiting room, refer to [Get started](/waiti
2222
2. Select **Create**.
2323
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/).
2424
4. Select **Next**.
25-
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).
26-
6. Select the **Queuing status code** to determine the HTTP status code that is returned when a user is in the waiting room.
27-
7. Select **Next**.
28-
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).
29-
9. Select **Save**. Your new waiting room will be enabled by default.
25+
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.
26+
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).
27+
7. Select the **Queuing status code** to determine the HTTP status code that is returned when a user is in the waiting room.
28+
8. Select **Next**.
29+
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).
30+
10. Select **Save**. Your new waiting room will be enabled by default.
3031

3132
</TabItem> <TabItem label="API">
3233

src/content/docs/waiting-room/reference/configuration-settings.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,34 @@ You can customize a variety of options for your waiting rooms.
202202
</td>
203203
<td></td>
204204
</tr>
205+
<tr>
206+
<td>Turnstile Widget Mode</td>
207+
<td>
208+
<code>turnstile_mode</code>
209+
</td>
210+
<td>Yes, defaults <code>invisible</code>.</td>
211+
<td>
212+
The type of Turnstile widget to use - refer to the [Turnstile documentation](turnstile/concepts/widget/#widget-types) for details. Valid values are <code>off</code>, <code>invisible</code>, <code>visible_non_interactive</code>, and <code>visible_managed</code>. Setting this to <code>off</code> will completely disable the Turnstile integration.
213+
</td>
214+
<td>
215+
Setting this to <code>invisible</code> makes sense for most rooms, unless you would like end users to be aware the challenge is running.
216+
</td>
217+
<td></td>
218+
</tr>
219+
<tr>
220+
<td>Turnstile Fail Action</td>
221+
<td>
222+
<code>turnstile_action</code>
223+
</td>
224+
<td>Yes, defaults to <code>log</code>.</td>
225+
<td>
226+
The action to take when an end user fails a Turnstile challenge. Valid values are <code>log</code> and <code>infinite_queue</code>.
227+
</td>
228+
<td>
229+
Setting this to <code>log</code> makes sense for most rooms, unless you wish to aggressively block bots using an infinite queue.
230+
</td>
231+
<td></td>
232+
</tr>
205233
</tbody>
206234
</table>
207235

src/content/plans/index.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3125,6 +3125,22 @@
31253125
"pro": "No",
31263126
"biz": "Yes",
31273127
"ent": "Yes"
3128+
},
3129+
"turnstile_widget_mode": {
3130+
"title": "Turnstile Widget Mode",
3131+
"link": "/waiting-room/how-to/create-waiting-room/",
3132+
"free": "No",
3133+
"pro": "No",
3134+
"biz": "Invisible only",
3135+
"ent": "Invisible (default)\n\n<em>With add-on</em>\nAll options"
3136+
},
3137+
"turnstile_fail_action": {
3138+
"title": "Turnstile Fail Action",
3139+
"link": "/waiting-room/how-to/create-waiting-room/",
3140+
"free": "No",
3141+
"pro": "No",
3142+
"biz": "Log only",
3143+
"ent": "Log only (default)\n\n<em>With add-on</em>\nInfinite queue"
31283144
}
31293145
}
31303146
}

0 commit comments

Comments
 (0)