Skip to content

Commit 6ba8389

Browse files
dcpenathomasgauvin
dcpena
authored and
thomasgauvin
committed
[Fundamentals] Updated content for single use partials (#23772)
* Updated content for single use partials * Added line for Page Rules
1 parent 0f53b89 commit 6ba8389

Some content is hidden

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

44 files changed

+521
-727
lines changed

‎src/content/docs/cloudflare-challenges/reference/challenge-solve-rate.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,13 @@ sidebar:
55
order: 2
66
---
77

8-
import { Render } from "~/components"
8+
The challenge solve rate (CSR) is the percentage of issued challenges — Interactive Challenge, JS Challenge, or Managed Challenge actions — that were solved.
99

10-
<Render file="challenge-solve-rate" product="fundamentals"/>
10+
```sql
11+
CSR = number of challenges solved / number of challenges issued
12+
```
13+
14+
This metric helps you evaluate your rule's effectiveness, as well as whether you need to make any adjustments to the rule's criteria or action. Rules in Challenge mode will start generating Challenge Solve Rate data (CSR) which indicates the false positive percentage.
1115

1216
You can find the CSR of a rule by going to its corresponding dashboard page:
1317

‎src/content/docs/ddos-protection/reference/simulate-ddos-attack.mdx‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,24 @@ You do not have to obtain permission from Cloudflare to launch a DDoS attack sim
2121

2222
It is recommended that you choose the right service and enable the correct features to test against the corresponding DDoS attacks. For example, if you want to test Cloudflare against an HTTP DDoS attack and you are only using Magic Transit, the test is going to fail because you need to onboard your HTTP application to Cloudflare's reverse proxy service to test our HTTP DDoS Protection.
2323

24-
<Render file="support-ticket-information" product="fundamentals" params={{ one: "Attack" }} />
24+
### **For WAF/CDN customers:**
25+
26+
* Attack origin region
27+
* Attack duration
28+
* Attack window (UTC)
29+
* Attack method
30+
* Traffic estimate in both requests per second (rps) and bandwidth (Gbps/Mbps/MBps)
31+
* Target IPs, ports, ranges, zones, hostnames, full URLs
32+
* Contact in case of emergency
33+
34+
### For Magic Transit and Spectrum customers:
35+
36+
* Attack origin region
37+
* Attack duration
38+
* Attack date & timeframe
39+
* Attack method
40+
* Target IPs, ports, ranges, zones, hostnames, full URLs
41+
* Protocol
42+
* Traffic estimate in both requests per second (rps) and bandwidth (Gbps/Mbps/MBps)
43+
* Max packet/bit rate
44+
* Contact in case of emergency

‎src/content/docs/fundamentals/account/account-security/manage-active-sessions.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ import { Render } from "~/components"
1111

1212
## View active sessions
1313

14-
<Render file="account-view-active-sessions" />
14+
To view the active sessions associated with your email address:
15+
16+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com).
17+
2. Go to **My Profile** > **Sessions**.
1518

1619
## Revoke active sessions
1720

‎src/content/docs/fundamentals/account/create-account.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@ description: Learn how to create a new Cloudflare account.
1010

1111
import { Render } from "~/components"
1212

13-
<Render file="create-account" product="fundamentals" />
13+
To create a Cloudflare account:
14+
15+
1. Go to the [Sign up page](https://dash.cloudflare.com/sign-up).
16+
2. Enter your **Email** and **Password**.
17+
3. Select **Create Account**.
18+
19+
Once you create your account, Cloudflare will automatically send an email to your address to [verify that email address](/fundamentals/user-profiles/verify-email-address/).
1420

1521
## Account name
1622

‎src/content/docs/fundamentals/api/get-started/account-owned-tokens.mdx‎

Lines changed: 84 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,88 @@ description: Learn what account owned tokens are, when to use them, and what the
88

99
---
1010

11-
import { Render } from "~/components"
11+
While user tokens act on behalf of a particular user and inherit a subset of that user's permissions, account owned tokens allow you to set up durable integrations that can act as service principals with their own specific set of permissions. This approach is ideal for scenarios like CI/CD, or building integrations with external services like SEIMs where it is important that the integration continues working, even long after the user who configured the integration may have left your organization altogether. User tokens are better for ad hoc tasks like scripting, where acting as the user is ideal and durability is less of a concern.
1212

13-
<Render file="account-owned-tokens" product="fundamentals" />
13+
## Create an account owned token
14+
15+
:::note
16+
Creating an account owned token requires Super Administrator permission on the account
17+
:::
18+
19+
1. Log into the [Cloudflare dashboard](https://dash.cloudflare.com).
20+
2. Go to **Manage Account** > **Account API Tokens**.
21+
3. Select **Create Token** and fill in the token name, permissions, and the optional expiration date for the token.
22+
4. Select **Continue to summary** and review the details.
23+
5. Select **Create Token**.
24+
25+
Alternatively, you can create a token using the [account owned token creation API](/api/resources/accounts/subresources/tokens/methods/create/).
26+
27+
Refer to the [blog post](https://blog.cloudflare.com/account-owned-tokens-automated-actions-zaraz/) for more information.
28+
29+
## Compatibility matrix
30+
31+
Account owned tokens are generally available for all accounts. Some services may not support account owned tokens yet. Refer to the compatibility matrix below for the latest status.
32+
33+
| Product | Compatibility |
34+
| ------------------------------- | ------------- |
35+
| Access | ✅ |
36+
| Account Analytics | ✅ |
37+
| Account Management | ✅ |
38+
| AI Gateway | ✅ |
39+
| AMP | ✅ |
40+
| API Shield | ✅ |
41+
| Argo | ✅ |
42+
| Billing | ✅ |
43+
| Cache | ✅ |
44+
| Tiered Cache | ✅ |
45+
| Cloud Connector | ✅ |
46+
| Configuration Rules | ✅ |
47+
| Custom Lists | ❌ |
48+
| Custom Pages | ✅ |
49+
| D1 | ✅ |
50+
| Data Loss Prevention | ✅ |
51+
| Digital Experience Monitoring | ✅ |
52+
| Distributed Web | ✅ |
53+
| DNS | ✅ |
54+
| Durable Objects | ✅ |
55+
| Email Relay | ✅ |
56+
| Secure Web Gateway | ✅ |
57+
| Healthchecks | ✅ |
58+
| Hyperdrive | ✅ |
59+
| Images | ✅ |
60+
| Intel Data Platform | ❌ |
61+
| Load Balancing | ✅ |
62+
| Log Explorer | ✅ |
63+
| Magic Network Monitoring | ✅ |
64+
| Magic Transit | ✅ |
65+
| Magic WAN | ✅ |
66+
| Managed Rules | ✅ |
67+
| Network Error Logging | ✅ |
68+
| Page Rules | ❌ |
69+
| Page Shield | ✅ |
70+
| Pages | ✅ |
71+
| Pub/Sub | ❌ |
72+
| R2 | ✅ |
73+
| Radar | ✅ |
74+
| Registrar | ❌ |
75+
| Rulesets | ✅ |
76+
| Spectrum | ❌ |
77+
| Speed | ✅ |
78+
| SSL/TLS | ✅ |
79+
| Stream | ✅ |
80+
| Super Bot Fight Mode | ❌ |
81+
| Trace | ✅ |
82+
| Tunnels | ✅ |
83+
| Turnstile | ❌ |
84+
| Vectorize | ✅ |
85+
| Waiting Room | ✅ |
86+
| Workers | ✅ |
87+
| Workers AI | ✅ |
88+
| Workers KV | ✅ |
89+
| Workers Observability | ❌ |
90+
| Workers Queues | ✅ |
91+
| Workflows | ✅ |
92+
| Zaraz | ✅ |
93+
| Zero Trust Client Platform | ❌ |
94+
| Zero Trust Devices and Services | ✅ |
95+
| Zone/Domain Management | ✅ |

‎src/content/docs/fundamentals/api/get-started/create-token.mdx‎

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,61 @@ description: Learn how to create a token to perform actions using the Cloudflare
1010

1111
import { Render } from "~/components"
1212

13-
<Render file="create-token" product="fundamentals" />
13+
:::note[Prerequisite]
14+
15+
Before you begin, [find your zone and account IDs](/fundamentals/account/find-account-and-zone-ids/).
16+
17+
:::
18+
19+
1. Determine if you want a user token or an [Account owned token](/fundamentals/api/get-started/account-owned-tokens/). Use Account owned tokens if you prefer service tokens that are not associated with users and your [desired API endpoints are compatible](/fundamentals/api/get-started/account-owned-tokens/#compatibility-matrix).
20+
2. From the [Cloudflare dashboard](https://dash.cloudflare.com/profile/api-tokens/), go to **My Profile** > **API Tokens** for user tokens. For Account Tokens, go to **Manage Account** > **API Tokens**.
21+
3. Select **Create Token**.
22+
4. Select a template from the available [API token templates](/fundamentals/api/reference/template/) or create a custom token. The following example uses the **Edit zone DNS** template.
23+
5. Add or edit the token name to describe why or how the token is used. Templates are prefilled with a token name and permissions.
24+
25+
![Token template overview screen](~/assets/images/fundamentals/api/template-customize.png)
26+
27+
6. Modify the token's permissions. After selecting a permissions group (*Account*, *User*, or *Zone*), choose what level of access to grant the token. Most groups offer `Edit` or `Read` options. `Edit` is full CRUDL (create, read, update, delete, list) access, while `Read` is the read permission and list where appropriate. Refer to the [available token permissions](/fundamentals/api/reference/permissions/) for more information.
28+
7. Select which resources the token is authorized to access. For example, granting `Zone DNS Read` access to a zone `example.com` will allow the token to read DNS records only for that specific zone. Any other zone will return an error for DNS record reads operations. Any other operation on that zone will also return an error.
29+
8. (Optional) Restrict how a token is used in the **Client IP Address Filtering** and **TTL (time to live)** fields.
30+
9. Select **Continue to summary**.
31+
10. Review the token summary. Select **Edit token** to make adjustments. You can also edit a token after creation.
32+
33+
![Token summary screen displaying the resources and permissions selected](~/assets/images/fundamentals/api/token-summary.png)
34+
35+
11. Select **Create Token** to generate the token's secret.
36+
12. Copy the secret to a secure place.
37+
38+
<Render file="new-token-warning" product="fundamentals" />
39+
40+
![Token creation completion screen displaying your API token and the curl command to test your token](~/assets/images/fundamentals/api/token-complete.png)
41+
42+
The token secret page also includes an example command to test the token. Use the `/user/tokens/verify` endpoint to fetch the current status of the given token.
43+
44+
```bash
45+
curl "https://api.cloudflare.com/client/v4/user/tokens/verify" \
46+
--header "Authorization: Bearer <API_TOKEN>"
47+
```
48+
49+
The result:
50+
51+
```json
52+
{
53+
"result": {
54+
"id": "100bf38cc8393103870917dd535e0628",
55+
"status": "active"
56+
},
57+
"success": true,
58+
"errors": [],
59+
"messages": [
60+
{
61+
"code": 10000,
62+
"message": "This API Token is valid and active",
63+
"type": null
64+
}
65+
]
66+
}
67+
```
68+
69+
With this you have successfully created an API token and can start working with the Cloudflare API. After creating your first API token, you can create additional API tokens [via the API](/fundamentals/api/how-to/create-via-api/).
70+

‎src/content/docs/fundamentals/concepts/cloudflare-ip-addresses.mdx‎

Lines changed: 50 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,62 @@ sidebar:
66

77
---
88

9-
import { Render } from "~/components"
9+
import { GlossaryTooltip, Render } from "~/components"
1010

11-
<Render file="cloudflare-ips" product="fundamentals" />
11+
Cloudflare has several [IP address ranges](https://www.cloudflare.com/ips/) which are shared by all proxied hostnames.
12+
13+
Together, these IP addresses form the backbone of our [anycast network](https://www.cloudflare.com/learning/cdn/glossary/anycast-network/), helping distribute traffic amongst various edge network servers.
14+
15+
:::note
16+
17+
Cloudflare uses other IP ranges for various products and services, but these addresses will not make connections to your origin.
18+
19+
:::
1220

1321
## Allow Cloudflare IP addresses
1422

15-
<Render file="allow-cloudflare-ips" product="fundamentals" />
23+
All traffic to [proxied DNS records](/dns/proxy-status/) passes through Cloudflare before reaching your origin server. This means that your origin server will stop receiving traffic from individual visitor IP addresses and instead receive traffic from [Cloudflare IP addresses](https://www.cloudflare.com/ips), which are shared by all proxied hostnames.
24+
25+
This setup can cause issues if your origin server blocks or rate limits connections from Cloudflare IP addresses. Because all visitor traffic will appear to come from Cloudflare IP addresses, blocking these IPs — even accidentally — will prevent visitor traffic from reaching your application.
26+
27+
In addition, allowing Cloudflare IPs might be needed to avoid <GlossaryTooltip term="rate limiting">rate limiting</GlossaryTooltip> or blocking these requests at your origin server.
28+
29+
For [Magic Transit](/magic-transit/) customers, Cloudflare routes the traffic instead of proxying it. Once Cloudflare starts advertising your IP prefixes, it will accept IP packets destined for your network, process them, and then output these packets to your origin infrastructure.
1630

1731
## Configure origin server
1832

1933
### Allowlist Cloudflare IP addresses
2034

21-
<Render file="allow-cloudflare-ips-tactical" product="fundamentals" />
35+
To avoid blocking Cloudflare IP addresses unintentionally, you also want to allow Cloudflare IP addresses at your origin web server.
36+
37+
You can explicitly allow these IP addresses with a [.htaccess file](https://httpd.apache.org/docs/trunk/mod/mod_authz_core.html#require) or by using [iptables](https://www.linode.com/docs/security/firewalls/control-network-traffic-with-iptables/#block-or-allow-traffic-by-port-number-to-create-an-iptables-firewall).
38+
39+
The following example demonstrates how you could use an iptables rule to allow a Cloudflare IP address range. Replace `$ip` below with one of the [Cloudflare IP address ranges](https://www.cloudflare.com/ips).
40+
41+
```bash
42+
# For IPv4 addresses
43+
$ iptables -I INPUT -p tcp -m multiport --dports http,https -s $ip -j ACCEPT
44+
45+
# For IPv6 addresses
46+
$ ip6tables -I INPUT -p tcp -m multiport --dports http,https -s $ip -j ACCEPT
47+
```
48+
49+
For more specific guidance, contact your hosting provider or website administrator.
2250

2351
### Block other IP addresses (recommended)
2452

25-
<Render file="block-cloudflare-ips-tactical" product="fundamentals" />
53+
As a best practice, we also recommend that you explicitly block all traffic that does not come from Cloudflare IP addresses or the IP addresses of your trusted partners, vendors, or applications.
54+
55+
For example, you might [update your iptables](https://www.linode.com/docs/guides/control-network-traffic-with-iptables/#block-or-allow-traffic-by-port-number-to-create-an-iptables-firewall) with the following commands:
56+
57+
```sh
58+
# For IPv4 addresses
59+
iptables -A INPUT -p tcp -m multiport --dports http,https -j DROP
60+
# For IPv6 addresses
61+
ip6tables -A INPUT -p tcp -m multiport --dports http,https -j DROP
62+
```
63+
64+
For more specific guidance, contact your hosting provider or website administrator.
2665

2766
## Review external tools
2867

@@ -39,7 +78,12 @@ For further recommendations on securing your origin server, refer to our guide o
3978

4079
### Customize Cloudflare IP addresses
4180

42-
<Render file="customize-cloudflare-ips" product="fundamentals" />
81+
If they do not want to use Cloudflare IP addresses — which are shared by all proxied hostnames — Enterprise customers have two potential alternatives:
82+
83+
* [**Bring Your Own IP (BYOIP)**](/byoip/): Cloudflare announces your IPs (an IP address range you lease/own) in all of our [locations](https://www.cloudflare.com/network/).
84+
* **Static IP addresses**: Cloudflare sets static IP addresses for your domain. For more details, contact your account team.
85+
86+
Business and Enterprise customers can also reduce the number of Cloudflare IPs that their domain shares with other Cloudflare customer domains by [uploading a Custom SSL certificate](/ssl/edge-certificates/custom-certificates/).
4387

4488
### IP range updates
4589

0 commit comments

Comments
 (0)