Skip to content

Commit c6a32aa

Browse files
committed
Configure DNS for Intake Email
1 parent f0dc676 commit c6a32aa

File tree

3 files changed

+98
-2
lines changed

3 files changed

+98
-2
lines changed

mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
]
9191
},
9292
"self-hosting/govern/communication",
93+
"self-hosting/govern/configure-dns-email-service",
9394
"self-hosting/govern/database-and-storage",
9495
"self-hosting/govern/custom-domain",
9596
"self-hosting/govern/private-bucket",

self-hosting/govern/communication.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title : Email notifications
3-
sidebarTitle: Email
2+
title : Configure SMTP for email notifications
3+
sidebarTitle: SMTP for Email
44
description: Either during your set-up or sometime later, you will want to set SMTP settings to let your users get emails to reset passwords, onboard themselves right, and get notifications for changes, and receive exports of your data.
55
---
66

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: Configure DNS for Intake Email
3+
sidebarTitle: DNS for Intake Email
4+
description: Configure DNS records to enable automatic conversion of incoming emails into work items in your project's Intake section.
5+
---
6+
7+
You will need to set up DNS records to allow your domain to receive incoming [Intake Emails](https://docs.plane.so/intake/intake-email). These configurations enable your server to accept messages sent to your project's dedicated Intake address, which are then converted into work items in your project's Intake section.
8+
9+
The instructions below will help you establish the required DNS records to properly receive and process emails for your Plane instance.
10+
11+
## Configure DNS records
12+
13+
1. **Create an A Record**
14+
This record points to the server running your email service.
15+
16+
```bash
17+
Type: A
18+
Host: <host-domain> # Example: plane.example.com
19+
Value: <public-ip-address> # Your server's public IP address
20+
TTL: Auto | 3600
21+
```
22+
23+
<Note>
24+
You can alternatively use a CNAME record if you're using a cloud load balancer.
25+
</Note>
26+
27+
2. **Add an MX Record**
28+
This record directs email traffic to your mail server.
29+
```bash
30+
Type: MX
31+
Host: <mail-domain> # Example: intake.example.com
32+
Value: <host-domain> # Same as your A record host
33+
Priority: 10
34+
TTL: Auto | 3600
35+
```
36+
37+
3. **Configure an SPF Record**
38+
This record helps prevent email spoofing.
39+
40+
```bash
41+
Type: TXT
42+
Host: <mail-domain> # Example: intake.example.com
43+
Value: "v=spf1 ip4:<A-record-ip-host-domain> -all"
44+
TTL: Auto | 3600
45+
```
46+
4. **Set Up a DMARC record**
47+
This record specifies how receiving mail servers should handle authentication failures.
48+
49+
```bash
50+
Type: TXT
51+
Host: _dmarc.<mail-domain> # Example: _dmarc.intake.example.com
52+
Value: "v=DMARC1; p=reject; rua=mailto:<valid-email-addr>"
53+
TTL: Auto | 3600
54+
```
55+
## Verify your configuration
56+
After setting up your DNS records, verify that they're correctly configured:
57+
58+
```bash
59+
# Verify A record
60+
dig A <mail-domain>
61+
62+
# Verify MX record
63+
dig MX <mail-domain>
64+
65+
# Verify SPF record
66+
dig TXT <mail-domain>
67+
68+
# Verify DMARC record
69+
dig TXT _dmarc.<mail-domain>
70+
```
71+
72+
You can also use [MXToolbox](https://mxtoolbox.com) to check for any issues with your DNS configuration.
73+
74+
## Test your mail server
75+
Once your DNS records have propagated, test your SMTP connections:
76+
77+
```bash
78+
# Test SMTP connection on standard ports
79+
telnet <host-domain> 25
80+
telnet <host-domain> 465
81+
telnet <host-domain> 587
82+
```
83+
84+
## Troubleshooting
85+
86+
- MX Record issues
87+
88+
- Ensure there's a proper dot at the end of the domain.
89+
- Check that the priority number is correct (lower = higher priority).
90+
- Allow 24-48 hours for DNS changes to fully propagate.
91+
92+
- A Record issues
93+
94+
- Verify that the IP address is correct.
95+
- Ensure your mail subdomain matches the MX record.

0 commit comments

Comments
 (0)