Skip to content

Commit 499f3d8

Browse files
authored
Added dashbuttons to some zone-level pages in Email Routing, Web3, etc. (#26917)
* Added dashbuttons to some zone-level pages in Email Routing, Web3, etc. * Adding dashbuttons to unowned product docs
1 parent 1f2b21b commit 499f3d8

18 files changed

+214
-152
lines changed

src/content/docs/email-routing/email-workers/edit-email-workers.mdx

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,29 @@ sidebar:
55
order: 2
66
---
77

8-
import { Render } from "~/components";
8+
import { Render, DashButton } from "~/components";
99

1010
Adding or editing Email Workers is straightforward. You can rename, delete or edit Email Workers, as well as change the routes bound to a specific Email Worker.
1111

1212
## Add an Email worker
1313

14-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
14+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
1515

16-
2. Go to **Email** > **Email Routing** > **Email Workers**.
16+
<DashButton url="/?to=/:account/:zone/email/routing" />
17+
18+
2. Select **Email Workers**.
1719

1820
3. Select **Create**.
1921

2022
<Render file="enable-create-worker" product="email-routing" />
2123

2224
## Edit an Email Worker
2325

24-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
26+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
27+
28+
<DashButton url="/?to=/:account/:zone/email/routing" />
2529

26-
2. Go to **Email** > **Email Routing** > **Email Workers**.
30+
2. Select **Email Workers**.
2731

2832
3. Find the Email Worker you want to rename, and select the three-dot button next to it.
2933

@@ -37,9 +41,11 @@ Adding or editing Email Workers is straightforward. You can rename, delete or ed
3741

3842
When you rename an Email Worker, you will lose the route that was previously bound to it. You will need to configure the route again after renaming the Email Worker.
3943

40-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
44+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
45+
46+
<DashButton url="/?to=/:account/:zone/email/routing" />
4147

42-
2. Go to **Email** > **Email Routing** > **Email workers**.
48+
2. Select **Email Workers**.
4349

4450
3. Find the Email Worker you want to rename, and select the three-dot button next to it.
4551

@@ -63,9 +69,11 @@ When you rename an Email Worker, you will lose the route that was previously bou
6369

6470
The following steps show how to change a route associated with an Email Worker.
6571

66-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
72+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
6773

68-
2. Go to **Email** > **Email Routing** > **Email workers**.
74+
<DashButton url="/?to=/:account/:zone/email/routing" />
75+
76+
2. Select **Email Workers**.
6977

7078
3. Find the Email Worker you want to change the associated route, and select **route** on its card.
7179

@@ -75,14 +83,16 @@ The following steps show how to change a route associated with an Email Worker.
7583

7684
## Delete an Email Worker
7785

78-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
86+
11. In the Cloudflare dashboard, go to the **Email Routing** page.
7987

80-
2. Go to **Email** > **Email Routing** > **Email workers**.
88+
<DashButton url="/?to=/:account/:zone/email/routing" />
8189

82-
3. Find the Email Worker you want to delete, and select the three-dot button next to it.
90+
12. Select **Email Workers**.
8391

84-
4. From the drop-down menu, select **Manage Worker**.
92+
13. Find the Email Worker you want to delete, and select the three-dot button next to it.
93+
94+
14. From the drop-down menu, select **Manage Worker**.
8595

86-
5. Select **Manage Service** > **Delete**.
96+
15. Select **Manage Service** > **Delete**.
8797

88-
6. Type the name of the Email Worker to confirm you want to delete it, and select **Delete**.
98+
16. Type the name of the Email Worker to confirm you want to delete it, and select **Delete**.

src/content/docs/email-routing/email-workers/enable-email-workers.mdx

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,19 @@ sidebar:
55
order: 1
66
---
77

8-
import { Render } from "~/components";
8+
import { Render, DashButton } from "~/components";
99

1010
Follow these steps to enable and add your first Email Worker. If you have never used Cloudflare Workers before, Cloudflare will create a subdomain for you, and assign you to the Workers [free pricing plan](/workers/platform/pricing/).
1111

12-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
12+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
1313

14-
2. Go to **Email** > **Email Routing**.
14+
<DashButton url="/?to=/:account/:zone/email/routing" />
1515

16-
3. Select **Get started**.
16+
2. Select **Get started**.
17+
3. In **Custom address**, enter the custom email address you want to use (for example, `my-new-email`).
18+
4. In **Destination**, choose the email address or Email Worker you want your emails to be forwarded to — for example, `[email protected]`. You can only choose a destination address you have already verified. To add a new destination address, refer to [Destination addresses](#destination-addresses).
19+
5. Select **Create and continue**.
20+
6. Verify your destination address and select **Continue**.
21+
7. Configure your DNS records and select **Add records and enable**.
1722

18-
<Render file="enable-create-worker" product="email-routing" />
23+
You have successfully created your Email Worker. In the Email Worker’s card, select the **route** field to expand it and check the routes associated with the Worker.

src/content/docs/email-routing/get-started/enable-email-routing.mdx

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,22 @@ sidebar:
55
order: 1
66
---
77

8+
import { DashButton } from "~/components";
9+
810
:::caution[Important]
911
Enabling Email Routing adds the appropriate `MX` records to the DNS settings of your zone in order for the service to work. You can [change these `MX` records](/email-routing/setup/email-routing-dns-records/) at any time. However, depending on how you configure them, Email Routing might stop working.
1012
:::
1113

12-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
13-
2. Go to **Email** > **Email Routing**.
14-
3. Review the records that will be added to your zone.
15-
4. Select **Add records and enable**.
16-
5. Go to **Routing rules**.
17-
6. For **Custom addresses**, select **Create address**.
18-
7. Enter the custom email address you want to use (for example, `[email protected]`).
19-
8. In **Destination addresses**, enter the full email address you want your emails to be forwarded to — for example, `[email protected]`.
14+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
15+
16+
<DashButton url="/?to=/:account/:zone/email/routing" />
17+
18+
2. Review the records that will be added to your zone.
19+
3. Select **Add records and enable**.
20+
4. Go to **Routing rules**.
21+
5. For **Custom addresses**, select **Create address**.
22+
6. Enter the custom email address you want to use (for example, `[email protected]`).
23+
7. In **Destination addresses**, enter the full email address you want your emails to be forwarded to — for example, `[email protected]`.
2024

2125
:::note[Notes]
2226

@@ -26,11 +30,11 @@ Enabling Email Routing adds the appropriate `MX` records to the DNS settings of
2630

2731
:::
2832

29-
9. Select **Save**.
30-
10. Cloudflare will send a verification email to the address provided in the **Destination address** field. You must verify your email address before being able to proceed.
31-
11. In the verification email Cloudflare sent you, select **Verify email address** > **Go to Email Routing** to activate Email Routing.
32-
12. Your Destination address should now show **Verified**, under **Status**. Select **Continue**.
33-
13. Cloudflare needs to add the relevant `MX` and `TXT` records to DNS records for Email Routing to work. This step is automatic and is only needed the first time you configure Email Routing. It is meant to ensure you have the proper records configured in your zone. Select **Add records and finish**.
33+
8. Select **Save**.
34+
9. Cloudflare will send a verification email to the address provided in the **Destination address** field. You must verify your email address before being able to proceed.
35+
10. In the verification email Cloudflare sent you, select **Verify email address** > **Go to Email Routing** to activate Email Routing.
36+
11. Your Destination address should now show **Verified**, under **Status**. Select **Continue**.
37+
12. Cloudflare needs to add the relevant `MX` and `TXT` records to DNS records for Email Routing to work. This step is automatic and is only needed the first time you configure Email Routing. It is meant to ensure you have the proper records configured in your zone. Select **Add records and finish**.
3438

3539
Email Routing is now enabled. You can add other custom addresses to your account.
3640

src/content/docs/email-routing/setup/disable-email-routing.mdx

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,40 @@ title: Disable Email Routing
33
pcx_content_type: reference
44
sidebar:
55
order: 3
6-
76
---
87

8+
import { DashButton } from "~/components";
9+
910
Email Routing provides two options for disabling the service:
1011

11-
* **Delete and Disable**: This option will immediately disable Email Routing and remove its `MX` records. Your custom email addresses will stop working, and your email will not be routed to its final destination.
12-
* **Unlock and keep DNS records**: (Advanced) This option is recommended if you plan to migrate to another provider. It allows you to add new `MX` records before disabling the service. Email Routing will stop working when you change your `MX` records.
12+
- **Delete and Disable**: This option will immediately disable Email Routing and remove its `MX` records. Your custom email addresses will stop working, and your email will not be routed to its final destination.
13+
- **Unlock and keep DNS records**: (Advanced) This option is recommended if you plan to migrate to another provider. It allows you to add new `MX` records before disabling the service. Email Routing will stop working when you change your `MX` records.
1314

1415
## Delete and disable Email Routing
1516

16-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
17-
2. Go to **Email** > **Email Routing** > **Settings**.
17+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
18+
19+
<DashButton url="/?to=/:account/:zone/email/routing" />
20+
21+
2. Select **Settings**.
1822
3. Select **Start disabling** > **Delete and Disable**. Email Routing will show you the list of records associated with your account that will be deleted.
1923
4. Select **Delete records**.
2024

2125
Email Routing is now disabled for your account and will stop forwarding email. To enable the service again, select **Enable Email Routing** and follow the wizard.
2226

2327
## Unlock and keep DNS records
2428

25-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
26-
2. Go to **Email** > **Email Routing** > **Settings**.
29+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
30+
31+
<DashButton url="/?to=/:account/:zone/email/routing" />
32+
33+
2. Select **Settings**.
2734
3. Select **Start disabling** > **Unlock records and continue**.
2835
4. Select **Edit records on DNS**.
2936

3037
You now have the option to edit your DNS records to migrate your service to another provider.
3138

3239
:::caution
3340

34-
Changing your DNS records will make Email Routing stop working. If you changed your mind and want to keep Email Routing working with your account, select **Lock DNS records**.
41+
Changing your DNS records will make Email Routing stop working. If you changed your mind and want to keep Email Routing working with your account, select **Lock DNS records**.
3542
:::

src/content/docs/email-routing/setup/email-routing-addresses.mdx

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,19 @@ title: Configure rules and addresses
33
pcx_content_type: how-to
44
sidebar:
55
order: 1
6-
76
---
87

8+
import { DashButton } from "~/components";
9+
910
An email rule is a pair of a custom email address and a destination address, or a custom email address with an Email Worker. This allows you to route emails to your preferred inbox, or apply logic through Email Workers before deciding what should happen to your emails. You can have multiple custom addresses, to route email from specific providers to specific mail inboxes.
1011

1112
## Custom addresses
1213

13-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
14-
2. Go to **Email** > **Email Routing** > **Routes**.
14+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
15+
16+
<DashButton url="/?to=/:account/:zone/email/routing" />
17+
18+
2. Select **Routing rules**.
1519
3. Select **Create address**.
1620
4. In **Custom address**, enter the custom email address you want to use (for example, `my-new-email`).
1721
5. In the **Action** drop-down menu, choose what this email rule should do. Refer to [Email rule actions](#email-rule-actions) for more information.
@@ -26,22 +30,23 @@ If you have more than one destination address linked to the same custom address,
2630

2731
When creating an email rule, you must specify an **Action**:
2832

29-
* *Send to an email*: Emails will be routed to your destination address. This is the default action.
30-
* *Send to a Worker*: Emails will be processed by the logic in your [Email Worker](/email-routing/email-workers).
31-
* *Drop*: Deletes emails sent to the custom address without routing them. This can be useful if you want to make an email address appear valid for privacy reasons.
33+
- _Send to an email_: Emails will be routed to your destination address. This is the default action.
34+
- _Send to a Worker_: Emails will be processed by the logic in your [Email Worker](/email-routing/email-workers).
35+
- _Drop_: Deletes emails sent to the custom address without routing them. This can be useful if you want to make an email address appear valid for privacy reasons.
3236

3337
:::note
3438

35-
3639
To prevent spamming unintended recipients, all email rules are automatically disabled until the destination address is validated by the user.
3740

38-
3941
:::
4042

4143
### Disable an email rule
4244

43-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
44-
2. Go to **Email** > **Email Routing** > **Routes**.
45+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
46+
47+
<DashButton url="/?to=/:account/:zone/email/routing" />
48+
49+
2. Select **Routing rules**.
4550
3. In **Custom addresses**, identify the email rule you want to pause, and toggle the status button to **Disabled**.
4651

4752
Your email rule is now disabled. It will not forward emails to a destination address or Email Worker. To forward emails again, toggle the email rule status button to **Active**.
@@ -85,8 +90,6 @@ To prevent spam, email rules do not become active until after the destination ad
8590

8691
:::note
8792

88-
8993
Deleting a destination address automatically disables all email rules that use that email address as destination.
9094

91-
92-
:::
95+
:::

src/content/docs/email-routing/setup/mta-sts.mdx

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

8+
import { DashButton } from "~/components";
9+
810
MTA Strict Transport Security ([MTA-STS](https://datatracker.ietf.org/doc/html/rfc8461)) was introduced by email service providers including Microsoft, Google and Yahoo as a solution to protect against downgrade and man-in-the-middle attacks in SMTP sessions, as well as solving the lack of security-first communication standards in email.
911

1012
Suppose that `example.com` is your domain and uses Email Routing. Here is how you can enable MTA-STS for it.
1113

12-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
13-
2. Go to **DNS** > **Records** and create a new CNAME record with the name `_mta-sts` that points to Cloudflare’s record `_mta-sts.mx.cloudflare.net`. Make sure to disable the proxy mode.
14+
1. In the Cloudflare dashboard, go to the **Records** page.
15+
16+
<DashButton url="/?to=/:account/:zone/dns/records" />
17+
18+
2. Create a new CNAME record with the name `_mta-sts` that points to Cloudflare’s record `_mta-sts.mx.cloudflare.net`. Make sure to disable the proxy mode.
1419

1520
![MTA-STS CNAME record](~/assets/images/email-routing/mta-sts-record.png)
1621

@@ -35,13 +40,15 @@ To do this you need to deploy a Worker that allows email clients to pull Cloudfl
3540

3641
```js
3742
export default {
38-
async fetch(request, env, ctx) {
39-
return await fetch("https://mta-sts.mx.cloudflare.net/.well-known/mta-sts.txt")
40-
},
43+
async fetch(request, env, ctx) {
44+
return await fetch(
45+
"https://mta-sts.mx.cloudflare.net/.well-known/mta-sts.txt",
46+
);
47+
},
4148
};
4249
```
4350

44-
This Worker proxies `https://mta-sts.mx.cloudflare.net/.well-known/mta-sts.txt` to your own domain.
51+
This Worker proxies `https://mta-sts.mx.cloudflare.net/.well-known/mta-sts.txt` to your own domain.
4552

4653
5. After deploying it, go to the Worker configuration, then **Settings** > **Domains & Routes** > **+Add**. Type the subdomain `mta-sts.example.com`.
4754

src/content/docs/email-routing/setup/subdomains.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,19 @@ title: Subdomains
33
pcx_content_type: how-to
44
sidebar:
55
order: 5
6-
76
---
87

8+
import { DashButton } from "~/components";
9+
910
Email Routing is a [zone-level](/fundamentals/concepts/accounts-and-zones/#zones) feature. A zone has a top-level domain (the same as the zone name) and it can have subdomains (managed under the DNS feature.) As an example, you can have the `example.com` zone, and then the `mail.example.com` and `corp.example.com` sub-domains under it.
1011

1112
You can use Email Routing with any subdomain of any zone in your account. Follow these steps to add Email Routing features to a new subdomain:
1213

13-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and zone.
14-
2. Go to **Email** > **Email Routing** > **Settings**, and select **Add subdomain**.
14+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
15+
16+
<DashButton url="/?to=/:account/:zone/email/routing" />
17+
18+
2. Go to **Settings**, and select **Add subdomain**.
1519

1620
Once the subdomain is added and the DNS records are configured, you can see it in the **Settings** list under the **Subdomains** section.
1721

src/content/docs/email-routing/troubleshooting/email-routing-dns-records.mdx

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,20 @@ sidebar:
66
head:
77
- tag: title
88
content: Troubleshooting misconfigured DNS records
9-
109
---
1110

12-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account and domain.
13-
2. Go to **Email** > **Email Routing** > **Settings**. Email Routing will show you the status of your DNS records, such as `Missing`.
11+
import { DashButton } from "~/components";
12+
13+
1. In the Cloudflare dashboard, go to the **Email Routing** page.
14+
15+
<DashButton url="/?to=/:account/:zone/email/routing" />
16+
17+
2. Go to **Settings**. Email Routing will show you the status of your DNS records, such as `Missing`.
1418
3. Select **Enable Email Routing**.
1519
4. The next page will show you what kind of action is needed. For example, if you are missing DNS records, select **Add records and enable**.
1620

1721
If there is a problem with your SPF records, refer to [Troubleshooting SPF records](/email-routing/troubleshooting/email-routing-spf-records/).
1822

1923
:::note[Note]
20-
If you are not using Email Routing but notice an Email Routing DNS record in your zone that you cannot delete, you can use the [Disable Email Routing API call](/api/resources/email_routing/subresources/dns/methods/delete/). It will remove any unexpected records, such as DKIM TXT records like `cf2024-1._domainkey.<hostname>`.
24+
If you are not using Email Routing but notice an Email Routing DNS record in your zone that you cannot delete, you can use the [Disable Email Routing API call](/api/resources/email_routing/subresources/dns/methods/delete/). It will remove any unexpected records, such as DKIM TXT records like `cf2024-1._domainkey.<hostname>`.
2125
:::

0 commit comments

Comments
 (0)