Skip to content

Commit 06e7608

Browse files
authored
feat: add captcha byo mode doc (#2463)
1 parent 6ba8d39 commit 06e7608

1 file changed

Lines changed: 28 additions & 12 deletions

File tree

docs/kratos/concepts/security.mdx

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ Ory OAuth2 and OpenID Connect is a certified OAuth2 and OpenID Connect provider.
7373

7474
## CAPTCHAs
7575

76-
Ory Identities supports protecting the registration and login endpoints with CAPTCHA challenges. This is useful to prevent
77-
credential stuffing, brute force and other automated attacks.
76+
Ory Identities supports protecting self-service flows with CAPTCHA challenges. This is useful to prevent credential stuffing,
77+
brute force and other automated attacks.
7878

79-
#### Prerequisites
79+
### Prerequisites
8080

81-
Before proceeding, ensure you are on a plan that supports this feature. If you need CAPTCHA support, please
82-
[reach out](https://www.ory.com/contact).
81+
Before proceeding, ensure you are on a plan that supports this feature. If you need CAPTCHA support,
82+
[contact us](https://www.ory.com/contact).
8383

8484
Supported CAPTCHA providers are:
8585

@@ -92,25 +92,41 @@ Supported CAPTCHA providers are:
9292

9393
1. Go to <ConsoleLink route="project.authentication" />.
9494
2. Toggle **CAPTCHA protection**.
95-
3. (optional) Add or remove domains from the **Allowed domains** list.
96-
97-
- You must define at least one valid domain.
98-
- You can list up to 10 domains in total.
99-
95+
3. Choose your preferred configuration mode:
96+
- **Managed**: Our standard, zero-setup integrated Cloudflare Turnstile widget.
97+
- Add or remove domains from the **Allowed domains** list.
98+
- You must define at least one valid domain.
99+
- You can list up to 10 domains in total.
100+
- **Bring Your Own Keys**: Connect your existing Cloudflare Turnstile account to view detailed security analytics directly
101+
within your own Cloudflare dashboard.
102+
- Enter your Turnstile **Site Key** and **Secret Key**.
100103
4. Click **Save**.
101-
5. Navigate to your registration or login screen to test the CAPTCHA protection.
104+
5. Navigate to any protected self-service screen, for example the registration or login page, to test the CAPTCHA protection.
102105

103106
```mdx-code-block
104107
</TabItem>
105108
<TabItem value="cli" label="Ory CLI">
106109
```
107110

111+
Configure Managed Mode:
112+
108113
```shell
109114
ory patch identity-config --project <project-id> --workspace <workspace-id> \
110-
--replace '/selfservice/mehods/captcha/enabled=true' \
115+
--replace '/selfservice/methods/captcha/enabled=true' \
116+
--replace '/selfservice/methods/captcha/config/byo=false' \
111117
--replace '/selfservice/methods/captcha/config/allowed_domains=["example.org", "foo.bar.dev"]'
112118
```
113119

120+
Configure BYO Mode:
121+
122+
```shell
123+
ory patch identity-config --project <project-id> --workspace <workspace-id> \
124+
--replace '/selfservice/methods/captcha/enabled=true' \
125+
--replace '/selfservice/methods/captcha/config/byo=true' \
126+
--replace '/selfservice/methods/captcha/config/cf_turnstile/sitekey=your-site-key' \
127+
--replace '/selfservice/methods/captcha/config/cf_turnstile/secret=your-secret-key'
128+
```
129+
114130
```mdx-code-block
115131
</TabItem>
116132
</Tabs>

0 commit comments

Comments
 (0)