diff --git a/quickstart.mdx b/quickstart.mdx index 076ea0a24..831468865 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -245,7 +245,11 @@ For more details about using the web editor, including using branches and pull r While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +### Add your domain in the dashboard + +1. Navigate to the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +2. Enter your domain name (for example, `docs.yourcompany.com`). +3. Click **Add domain**. -Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider. +### Configure DNS settings + +On your domain provider's website, navigate to your domain's DNS settings and create a new CNAME record: - | Record Type | Name | Value | TTL | - | ----------- | ------------------- | -------------------- | ---- | - | CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 | + | Record Type | Name | Value | TTL | + | ----------- | ------------------- | ----------------------- | ---- | + | CNAME | docs (or subdomain) | cname.mintlify-dns.com. | 3600 |
- - DNS changes can take up to 48 hours to propagate, though changes often complete much sooner. - + + Each domain provider has different ways to add DNS records. Refer to your provider's documentation for specific instructions. + + +### Wait for DNS propagation and TLS provisioning + +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 configuration using [DNSChecker](https://dnschecker.org). + +Once your DNS records propagate, Mintlify automatically provisions a free SSL/TLS certificate for your domain. Your site is first accessible via HTTP, then HTTPS becomes available after certificate provisioning completes. + + + + If Cloudflare is your DNS provider, enable "Full (strict)" mode for SSL/TLS encryption. Also disable "Always Use HTTPS" in Edge Certificates settings to allow certificate validation. + + + If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain. + + + If your domain uses CAA (Certification Authority Authorization) records, add `0 issue "letsencrypt.org"` to authorize certificate issuance. + + + +For more details on custom domains, including setting canonical URLs for SEO, see the [custom domain documentation](/customize/custom-domain). ## Next steps