Document custom hostname setup for Cloudflare-proxied domains#6154
Conversation
TXT pre-validation cannot complete while a domain is proxied through Cloudflare, even when the records resolve correctly. Add a section with the setup order for proxied domains and link it from the warning. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
ethanpalm
left a comment
ethanpalm
left a comment
There was a problem hiding this comment.
a tiny style nit but lgtm!
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
3 participants
Summary
A customer whose domain was already proxied through Cloudflare (orange cloud) was blocked setting up their custom domain. The docs tell users to wait until both verification TXT records show as verified before updating the CNAME, but that pre-validation never completes for Cloudflare-proxied domains — even when the records resolve correctly via dig or DNSChecker.
This PR adds a "Cloudflare-proxied domains" section to customize/custom-domain.mdx explaining:
It also links to the new section from the existing warning so proxied users don't get stuck waiting on verification.
Test Plan
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes to custom domain guidance; no application or infrastructure code is modified.
Overview
Documents why Cloudflare-proxied (orange cloud) custom domains cannot complete TXT pre-validation before the
CNAMEpoints at Mintlify, and gives an alternate setup path so users are not blocked by the existing “wait for green checks” guidance.The existing Warning now links to a new Cloudflare-proxied domains section. That section explains the proxy limitation, lists steps to add TXT records, update
CNAMEtocname.mintlify.builderswithout waiting on dashboard verification, and notes possible brief invalid TLS during provisioning. It also describes using DNS only (gray cloud) for zero-downtime migration via the standard pre-validation flow.Reviewed by Cursor Bugbot for commit e1a45fa. Bugbot is set up for automated code reviews on this repo. Configure here.