Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar:
order: 21
---

import { DashButton } from "~/components";

Cloudflare recommends API tokens as the preferred authentication method with Cloudflare APIs. This article walks through creating API tokens for authentication to the GraphQL Analytics API.

For more details on API tokens and the full range of supported options, refer to [Creating API tokens](/fundamentals/api/get-started/create-token/).
Expand All @@ -18,15 +20,11 @@ To create an API token for authentication to the GraphQL Analytics API, use this

## Access the Create API Token page

To access the **Create Custom Token** page, follow these steps:

1. Log in to your Cloudflare account and select _My Profile_ from the user account drop-down list.

![User account drop-down menu](~/assets/images/analytics/account-profile.png)
1. In the Cloudflare dashboard, go to the **Account API tokens** page.

2. In your user profile page, select the **API Tokens** tab.
<DashButton url="/?to=/:account/api-tokens" />

3. In the **API Tokens** page, select **Create Token**.
2. Select **Create Token**.

![API Tokens tab](~/assets/images/analytics/user-profile-api-tokens-tab.png)

Expand Down
12 changes: 7 additions & 5 deletions src/content/docs/argo-smart-routing/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head: []
description: Learn how to enable Argo Smart Routing in the Cloudflare dashboard.
---

import { Render, TabItem, Tabs } from "~/components";
import { Render, TabItem, Tabs, DashButton } from "~/components";

<Render file="smart-shield-callout" product="smart-shield" />

Expand All @@ -17,10 +17,12 @@ Argo Smart Routing is a one-click solution to speed up your global traffic.

To enable [Argo Smart Routing](https://dash.cloudflare.com/?to=/:account/:zone/traffic) in the dashboard:

1. Log in to your [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
2. Go to **Traffic** > **Argo Smart Routing**.
3. For **Argo Smart Routing**, switch the toggle to **On**.
4. Provide your billing information.
1. In the Cloudflare dashboard, go to the **Argo Smart Routing** page.

<DashButton url="/?to=/:account/:zone/traffic" />

2. For **Argo Smart Routing**, switch the toggle to **On**.
3. Provide your billing information.

- If you do not have a [billing profile](/billing/create-billing-profile/), enter your billing information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ sidebar:

---

import { DashButton } from "~/components";

After you [change your nameservers](/automatic-platform-optimization/get-started/change-nameservers/), activate the Cloudflare WordPress plugin.

## Prerequisites
Expand Down Expand Up @@ -54,13 +56,15 @@ To create the connection between WordPress and Cloudflare, you will create an AP

## Create the API token from Cloudflare

1. Open your Cloudflare dashboard.
2. Select **My Profile** from the top of the page.
3. Select **API Tokens** > **Create Token**.
4. Locate **WordPress** from the list and select **Use template**.
5. Select **Continue to summary** at the bottom of the page.
6. On the **WordPress API token summary** page, select **Create Token**. Your API token displays.
7. Select the **Copy** button to copy your token. You will need to paste the token in the next section.
1. In the Cloudflare dashboard, go to the **Account API tokens** page.

<DashButton url="/?to=/:account/api-tokens" />

2. Select **Create Token**.
3. Locate **WordPress** from the list and select **Use template**.
4. Select **Continue to summary** at the bottom of the page.
5. On the **WordPress API token summary** page, select **Create Token**. Your API token displays.
6. Select the **Copy** button to copy your token. You will need to paste the token in the next section.

:::note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 5
---

import { TabItem, Tabs } from "~/components";
import { TabItem, Tabs, DashButton } from "~/components";

In the following sections, we will give you some details about how to configure Cloudflare for SaaS with Regional Services and Customer Metadata Boundary.

Expand All @@ -15,9 +15,11 @@ To configure Regional Services for both hostnames [proxied](/dns/proxy-status/)

<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select an account and zone.
2. Go to the **Custom Hostnames** tab.
3. Follow these steps to [configure Cloudflare for SaaS](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/).
1. In the Cloudflare dashboard, go to the **Custom Hostnames** page.

<DashButton url="/?to=/:account/:zone/ssl-tls/custom-hostnames" />

2. Follow these steps to [configure Cloudflare for SaaS](/cloudflare-for-platforms/cloudflare-for-saas/start/getting-started/).

</TabItem>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 2
---

import { Details, APIRequest } from "~/components";
import { Details, APIRequest, DashButton } from "~/components";

You can configure the Metadata Boundary to select the region where your logs and analytics are stored via API or dashboard.

Expand All @@ -15,9 +15,11 @@ Currently, this can only be applied at the account-level. If you only want the M

To configure Customer Metadata Boundary in the dashboard:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account.
2. Go to **Manage Account** > **Configurations**.
3. In **Customer Metadata Boundary**, select the region you want to use. You have the option to select `EU` or `US`. If you want to select both regions, select `Global` instead.
1. In the Cloudflare dashboard, go to the **Settings** page.

<DashButton url="/?to=/:account/configurations" />

2. In **Customer Metadata Boundary**, select the region you want to use. You have the option to select `EU` or `US`. If you want to select both regions, select `Global` instead.

## Configure Customer Metadata Boundary via API

Expand Down Expand Up @@ -71,6 +73,9 @@ Here is an example request using cURL to delete regions:

To view or change your Customer Metadata Boundary setting:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account.
2. Go to **Manage Account** > **Configurations** > **Preferences**.
1. In the Cloudflare dashboard, go to the **Settings** page.

<DashButton url="/?to=/:account/configurations" />

2. Go to **Preferences**.
3. Locate the **Customer Metadata Boundary** section.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ head:
content: Get Started — Regional Services
---

import { Details, APIRequest } from "~/components";
import { Details, APIRequest, DashButton } from "~/components";

:::note

Expand All @@ -22,6 +22,10 @@ You can use Regional Services through the dashboard or via API.

To use Regional Services, you need to first create a DNS record in the dashboard:

1. In the Cloudflare dashboard, go to the **DNS** page.

<DashButton url="/?to=/:account/:zone/dns" />

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select an account and domain.
2. Go to the **DNS** tab.
3. Follow these steps to [create a DNS record](/dns/manage-dns-records/how-to/create-dns-records/).
Expand Down
12 changes: 7 additions & 5 deletions src/content/docs/health-checks/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@ sidebar:

---

import { Render } from "~/components";
import { Render, DashButton } from "~/components";

<Render file="smart-shield-callout" product="smart-shield" />

This guide will get you started with creating and managing configured Health Checks.

## Create a Health Check

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
2. Go to **Traffic** > **Health Checks**.
3. Select **Create** and fill out the form, paying special attention to:
1. In the Cloudflare dashboard, go to the **Health Checks** page.

<DashButton url="/?to=/:account/:zone/traffic/health-checks" />

2. Select **Create** and fill out the form, paying special attention to:
* The values for **Interval** and **Check regions**, because decreasing the **Interval** and increasing **Check regions** may increase the load on your origin server.
* **Retries**, which specify the number of retries to attempt in case of a timeout before marking the origin as unhealthy.
4. Select **Save and Deploy**.
3. Select **Save and Deploy**.

## Manage Health Checks

Expand Down
7 changes: 4 additions & 3 deletions src/content/docs/health-checks/health-checks-analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@ sidebar:

---

import { AvailableNotifications, Render } from "~/components"
import { AvailableNotifications, Render, DashButton } from "~/components"

<Render file="smart-shield-callout" product="smart-shield" />

Once you have set up a standalone Health Check including notification emails, use Health Check Analytics to debug possible origin issues.

To access health check analytics:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
2. Go to **Traffic** > **Health Check Analytics**.
1. In the Cloudflare dashboard, go to the **Health Check Analytics** page.

<DashButton url="/?to=/:account/:zone/traffic/health-check-analytics" />

<Render file="health-checks-analytics" product="smart-shield" />

Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/logs/instant-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 116
---

import { FeatureTable, APIRequest } from "~/components";
import { FeatureTable, APIRequest, DashButton } from "~/components";

Instant Logs allows Cloudflare customers to access a live stream of the traffic for their domain from the Cloudflare dashboard or from a command-line interface (CLI). Seeing data in real time allows you to investigate an attack, troubleshoot, debug or test out changes made to your network. Instant Logs is lightweight, simple to use and does not require any additional setup.

Expand All @@ -15,13 +15,13 @@ Instant Logs allows Cloudflare customers to access a live stream of the traffic

## Instant Logs via Cloudflare Dashboard

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select the [zone](/fundamentals/concepts/accounts-and-zones/#zones) you want to use with Instant Logs.
1. In the Cloudflare dashboard, go to the **Instant Logs** page.

2. Go to **Analytics & Logs** > **Instant Logs**.
<DashButton url="/?to=/:account/:zone/analytics/instant-logs" />

3. Select **Start streaming**.
2. Select **Start streaming**.

4. (optional) Select **Add filter** to narrow down the events to be shown.
3. (optional) Select **Add filter** to narrow down the events to be shown.

Fields supported in our [HTTP requests dataset](/logs/logpush/logpush-job/datasets/zone/http_requests/) can be used when you add filters. Some fields with additional subscriptions required are not supported in the dashboard, you will need to use CLI instead.

Expand Down
16 changes: 9 additions & 7 deletions src/content/docs/logs/logpush/logpush-job/custom-fields.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 8
---

import { APIRequest } from "~/components";
import { APIRequest, DashButton } from "~/components";

The HTTP requests dataset includes most standard log information by default. However, if you need to capture additional request or response headers or cookies, you can use custom fields to tailor the logs to your specific needs

Expand Down Expand Up @@ -262,12 +262,14 @@ If you are a Cloudflare Access user, as of March 2022 you have to manually add t

## Enable custom fields via dashboard

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select the domain you want to use.
2. Go to **Analytics & Logs** > **Logpush**.
3. In the **Custom log fields** section, select **Edit Custom Fields**.
4. Select **Set new Custom Field**.
5. From the **Field Type** dropdown, select _Request Header_, _Response Header_ or _Cookies_ and type the **Field Name**.
6. When you are done, select **Save**.
1. In the Cloudflare dashboard, go to the **Logpush** page.

<DashButton url="/?to=/:account/:zone/analytics/logs" />

2. In the **Custom log fields** section, select **Edit Custom Fields**.
3. Select **Set new Custom Field**.
4. From the **Field Type** dropdown, select _Request Header_, _Response Header_ or _Cookies_ and type the **Field Name**.
5. When you are done, select **Save**.

## Limitations

Expand Down
40 changes: 22 additions & 18 deletions src/content/docs/spectrum/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 4
---

import { Details, Render, APIRequest } from "~/components";
import { Details, Render, APIRequest, DashButton } from "~/components";

Spectrum is available on all paid plans. Pro and Business support selected protocols only, whereas Enterprise supports all TCP and UDP based traffic. Refer to [Configuration options](/spectrum/reference/configuration-options/) for more configuration details.

Expand All @@ -19,15 +19,17 @@ To create a Spectrum application using an IP address, Cloudflare normally assign

<Details header="Add your application via Dashboard">

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login).
2. Select **Spectrum**.
3. Select **Create an Application**. If this is your first time using Spectrum, the **Create an Application** modal appears.
4. Select your **Application Type**.
5. Under **Domain**, enter the domain that will use Spectrum.
6. Under **Edge Port**, enter the port Cloudflare should use for your application.
7. Under **Origin**, enter your application's origin IP and port.
8. If your application requires the client IP and supports [Proxy Protocol](https://www.haproxy.com/blog/haproxy/proxy-protocol/), enable **Proxy Protocols**. Proxy Protocol is a method for a proxy like Cloudflare to send the client IP to the origin application.
9. Select **Add**.
1. In the Cloudflare dashboard, go to the **Spectrum** page.

<DashButton url="/?to=/:account/:zone/spectrum" />

2. Select **Create an Application**. If this is your first time using Spectrum, the **Create an Application** modal appears.
3. Select your **Application Type**.
4. Under **Domain**, enter the domain that will use Spectrum.
5. Under **Edge Port**, enter the port Cloudflare should use for your application.
6. Under **Origin**, enter your application's origin IP and port.
7. If your application requires the client IP and supports [Proxy Protocol](https://www.haproxy.com/blog/haproxy/proxy-protocol/), enable **Proxy Protocols**. Proxy Protocol is a method for a proxy like Cloudflare to send the client IP to the origin application.
8. Select **Add**.

</Details>

Expand Down Expand Up @@ -97,14 +99,16 @@ To create a Spectrum application using a CNAME record, you will need to create a

<Details header="Add your application via Dashboard">

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login).
2. Select **Spectrum**.
3. Select **Create an Application**. If this is your first time using Spectrum, the **Create an Application** modal appears.
4. Select your **Application Type**.
5. Under **Domain**, enter the domain that will use Spectrum.
6. Under **Edge Port**, enter the port Cloudflare should use for your application.
7. Under **Origin**, enter your `CNAME` record name.
8. Select **Add**.
1. In the Cloudflare dashboard, go to the **Spectrum** page.

<DashButton url="/?to=/:account/:zone/spectrum" />

2. Select **Create an Application**. If this is your first time using Spectrum, the **Create an Application** modal appears.
3. Select your **Application Type**.
4. Under **Domain**, enter the domain that will use Spectrum.
5. Under **Edge Port**, enter the port Cloudflare should use for your application.
6. Under **Origin**, enter your `CNAME` record name.
7. Select **Add**.

</Details>

Expand Down
22 changes: 14 additions & 8 deletions src/content/docs/spectrum/how-to/enable-proxy-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ weight: 0

---

import { DashButton } from "~/components";

Because Cloudflare intercepts packets before forwarding them to your server, if you were to look up the client IP, you would see Cloudflare's IP rather than the true client IP.

Some services you run may require knowledge of the true client IP. In those cases, you can use a proxy protocol for Cloudflare to pass on the client IP to your service. Sending proxy information along is dependent on whether TCP or UDP is used. For TCP, Spectrum supports adding [Proxy Protocol v1](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt), which is the human readable version supported by Amazon ELB and [NGINX](https://docs.nginx.com/nginx/admin-guide/load-balancer/using-proxy-protocol/). For UDP applications, Cloudflare has developed a custom proxy protocol called Simple Proxy Protocol. Be aware that Proxy Protocol is not supported for Spectrum egresses to Magic WAN.
Expand All @@ -19,10 +21,12 @@ This feature requires an Enterprise plan. If you would like to upgrade, contact

## Enable Proxy Protocol v1 for TCP

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login).
2. Select **Spectrum**.
3. Locate the application that will use the PROXY protocol and select **Configure**.
4. From the dropdown, select **PROXY Protocol v1**.
1. In the Cloudflare dashboard, go to the **Spectrum** page.

<DashButton url="/?to=/:account/:zone/spectrum" />

2. Locate the application that will use the PROXY protocol and select **Configure**.
3. From the dropdown, select **PROXY Protocol v1**.

When TCP applications are configured to use **PROXY Protocol v1**, Cloudflare will prepend each inbound TCP connection with the PROXY Protocol plain-text header.

Expand All @@ -48,10 +52,12 @@ PROXY TCP6 2001:db8:: 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff 42300 443\r\n

## Enable Proxy Protocol v2 for TCP/UDP

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login).
2. Select **Spectrum**.
3. Locate the application that will use the PROXY protocol and select **Configure**.
4. From the dropdown, select **PROXY Protocol v2**.
1. In the Cloudflare dashboard, go to the **Spectrum** page.

<DashButton url="/?to=/:account/:zone/spectrum" />

2. Locate the application that will use the PROXY protocol and select **Configure**.
3. From the dropdown, select **PROXY Protocol v2**.

When TCP applications are configured to use **PROXY Protocol v2**, Cloudflare will prepend each inbound TCP connection with the PROXY Protocol binary header.

Expand Down
Loading
Loading