Skip to content

docs: document custom domain TXT verification records #5678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −6
Open

docs: document custom domain TXT verification records #5678

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 15 additions & 6 deletions customize/custom-domain.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,31 @@
</Tip>

<Warning>
If you migrate an existing domain and want zero downtime, add the verification `TXT` records before updating your `CNAME`. Then wait until SSL/TLS certificates pre-provision before cutting over. Switching the `CNAME` before certificates are issued causes HTTPS requests to fail until provisioning completes.

Check warning on line 49 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L49 

In general, use active voice instead of passive voice ('are issued').
</Warning>

### Verification TXT records

Check warning on line 52 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L52 

'Verification TXT records' should use sentence-style capitalization.

Check warning on line 52 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L52 

Spell out 'TXT', if it's unfamiliar to the audience.

Check warning on line 52 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L52 

Use 'txt' instead of 'TXT'.

After you add a custom domain, the dashboard displays two `TXT` records that you must add at your DNS provider:

```text
TXT | _acme-challenge.<your-domain> | <value shown in your dashboard>
TXT | _cf-custom-hostname.<your-domain> | <value shown in your dashboard>
```

The `_acme-challenge` record authorizes Let's Encrypt to issue a TLS certificate for your domain, and the `_cf-custom-hostname` record verifies that you control the domain.

The dashboard automatically checks these records and marks each one as configured once it detects the expected value in DNS. Refresh the page after publishing the records to update their status.

### DNS propagation

DNS changes typically take 1-24 hours to propagate globally, though it can take up to 48 hours in some cases. You can verify your DNS is configured correctly using [DNSChecker](https://dnschecker.org).

Check warning on line 67 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L67 

In general, use active voice instead of passive voice ('is configured').

Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after Vercel provisions your TLS certificate.
Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after your TLS certificate is provisioned.

Check warning on line 69 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L69 

In general, use active voice instead of passive voice ('is provisioned').

### Automatic TLS provisioning

Once your DNS records propagate and resolve correctly, Vercel automatically provisions a free SSL/TLS certificate for your domain using Let's Encrypt.
Once your DNS records propagate and the verification `TXT` records resolve correctly, Mintlify automatically provisions a free SSL/TLS certificate for your domain using Let's Encrypt.

This typically completes within a few hours of DNS propagation, though it can take up to 24 hours in rare cases. Certificates are automatically renewed before expiration.

Expand All @@ -71,15 +84,11 @@

### Reserved paths

The `/.well-known/acme-challenge` path is reserved for certificate validation and cannot be redirected or rewritten. If you have configured redirects or rewrites for this path, certificate provisioning fails.

Check warning on line 87 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L87 

In general, use active voice instead of passive voice ('is reserved').

Check warning on line 87 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L87 

In general, use active voice instead of passive voice ('be redirected').

### Provider-specific settings

<AccordionGroup>
<Accordion title="Vercel verification">
If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain, and is emailed to you.
</Accordion>

Copy link
Copy Markdown

@cursor cursor Bot May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant AccordionGroup wrapping a single Accordion element

Low Severity

After removing the "Vercel verification" accordion, the <AccordionGroup> now wraps only a single <Accordion>. In Mintlify, <AccordionGroup> exists to group multiple accordions together; a standalone <Accordion> renders fine on its own without a group wrapper. The <AccordionGroup> is now redundant and adds unnecessary nesting.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 800d62f. Configure here.

<Accordion title="Cloudflare encryption mode">
If Cloudflare is your DNS provider, you must enable the "Full (strict)" mode for the SSL/TLS encryption setting. Additionally, disable "Always Use HTTPS" in your Edge Certificates settings. Cloudflare's HTTPS redirect blocks Let's Encrypt from validating your domain during certificate provisioning.
</Accordion>
Expand Down
Loading