Skip to main content
To host your documentation on a custom domain:
  1. Add your domain in your dashboard.
  2. Configure DNS settings on your domain provider.
  3. Allow time for DNS to propagate and TLS certificates to be automatically provisioned.
Looking to set up a custom subdirectory like mintlify.com/docs? See the custom subdirectory docs.

​
Add your custom domain

  1. Navigate to the Custom domain setup page in your dashboard.
  2. Enter your domain name. For example, docs.example.com or www.example.com.
  3. Click Add domain.
The Custom domain setup page showing the field to enter your custom domain URL.

​
Configure your DNS

  1. On your domain provider’s website, navigate to your domain’s DNS settings.
  2. Create a new DNS record with the following values:
CNAME | docs | cname.vercel-dns.com.
Each domain provider has different ways to add DNS records. Refer to your domain provider’s documentation for specific instructions.
Sample CNAME settings for a custom domain hosted on Vercel.

​
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. Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after Vercel provisions your TLS certificate.

​
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. 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.

​
CAA records

If your domain uses CAA (Certification Authority Authorization) records, you must authorize Let’s Encrypt to issue certificates for your domain. Add the following CAA record to your DNS settings: 
0 issue "letsencrypt.org"

​
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 will fail.

​
Provider-specific settings

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.
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 will block Let’s Encrypt from validating your domain during certificate provisioning.

​
Set a canonical URL

After configuring your DNS, set a canonical URL to ensure search engines index your preferred domain. A canonical URL tells search engines which version of your documentation is the primary one. This improves SEO when your documentation is accessible from multiple URLs and prevents issues with duplicate content. Add the canonical meta tag to your docs.json: 
"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}
Replace https://www.your-custom-domain-here.com with your actual custom domain. For example, if your custom domain is docs.mintlify.com, you would use: 
"seo": {
    "metatags": {
        "canonical": "https://docs.mintlify.com"
    }
}
⌘I