Skip to main content

​
Custom Domain Configuration

This guide walks through configuring the custom domain docs.auctionexcellence.com for the Mintlify documentation site.

​
Prerequisites

  • Access to your domain registrar’s DNS settings
  • Access to the Mintlify dashboard
  • Domain: auctionexcellence.com

​
Step 1: Add Domain in Mintlify Dashboard

  1. Log in to the Mintlify Dashboard
  2. Navigate to Settings > Custom Domain
  3. Enter docs.auctionexcellence.com as your custom domain
  4. Click Add Domain
  5. Note any verification records provided

​
Step 2: Configure DNS Records

Add the following DNS records at your domain registrar:

​
CNAME Record

TypeNameValueTTL
CNAMEdocscname.mintlify-dns.com.3600
The trailing period after cname.mintlify-dns.com. is important for some DNS providers. If your provider adds it automatically, you can omit it.
If your domain uses CAA records, add this to authorize Let’s Encrypt for SSL certificates:
TypeNameValue
CAA@0 issue “letsencrypt.org”

​
Verification TXT Record (If Required)

Some configurations may require a TXT record for domain verification:
TypeNameValue
TXT_mintlify(provided in Mintlify dashboard)

​
Step 3: Wait for DNS Propagation

DNS changes can take up to 48 hours to propagate globally, though most changes are visible within 15-30 minutes.

​
Verify DNS Configuration

Check your DNS settings using: 
# Check CNAME record
dig docs.auctionexcellence.com CNAME

# Check if DNS has propagated
nslookup docs.auctionexcellence.com
You can also use online tools like DNS Checker to verify global propagation.

​
Step 4: SSL Certificate Provisioning

Once DNS is configured correctly, Mintlify automatically provisions an SSL certificate via Let’s Encrypt. This typically takes 5-10 minutes after DNS verification.
Do not redirect the /.well-known/acme-challenge path - it’s reserved for SSL certificate validation.

​
Step 5: Verification Checklist

After setup, verify the following:
  • Site accessible at docs.auctionexcellence.com
  • HTTPS working with valid certificate (check for padlock icon)
  • No mixed content warnings in browser console
  • Redirects from HTTP to HTTPS working
  • All pages load correctly

​
Test SSL Certificate

# Check SSL certificate
curl -vI https://docs.auctionexcellence.com 2>&1 | grep -A 5 "Server certificate"

# Or use OpenSSL
openssl s_client -connect docs.auctionexcellence.com:443 -servername docs.auctionexcellence.com

​
Troubleshooting

​
Site Not Loading

  1. Verify DNS records are correct using dig or nslookup
  2. Check DNS propagation status
  3. Wait 24-48 hours for full propagation

​
SSL Certificate Errors

  1. Ensure CAA record allows Let’s Encrypt
  2. Verify /.well-known/acme-challenge path is not blocked
  3. Check Mintlify dashboard for certificate status

​
Mixed Content Warnings

  1. Ensure all internal links use relative paths or HTTPS
  2. Check for hardcoded HTTP URLs in content
  3. Review browser console for specific resources

​
Provider-Specific Notes

​
Cloudflare

If using Cloudflare:
  1. Set SSL/TLS mode to Full (strict)
  2. Disable Always Use HTTPS in Edge Certificates settings (let Mintlify handle this)
  3. Ensure the CNAME record is proxied (orange cloud)

​
Vercel

If domain is managed through Vercel:
  1. Add the TXT verification record provided in Mintlify dashboard
  2. Configure the CNAME as specified above

​
AWS Route 53

  1. Create a CNAME record set
  2. Set TTL to 300 seconds minimum
  3. Enable alias if required

​
Analytics Configuration

After the domain is live, configure analytics:
  1. Set up PostHog with your API key in mint.json
  2. Verify tracking is working by checking the PostHog dashboard
  3. Configure goals and funnels as needed