Custom Domains
Set up and troubleshoot custom domains for your documentation site
Connect your own domain to serve documentation at docs.yourdomain.com or yourdomain.com/docs.
Setting Up a Custom Domain
Go to your project in the Jamdesk dashboard, then click Custom Domain in the GitHub Integration card.
Type your domain (e.g., docs.example.com) and choose your hosting option:
- Standard - Point your domain directly to Jamdesk (docs.example.com)
- Host at /docs - Serve docs at a subpath on your existing site (example.com/docs)
Add the DNS records shown in the dashboard to your DNS provider. Records vary based on your setup:
- Subdomain (docs.example.com): Add a CNAME record
- Apex domain (example.com): Add an A record
- Host at /docs: Add a TXT record for verification, then configure your proxy
DNS changes can take 1-24 hours to propagate. The dashboard will show "Active" once verified.
Hosting Options
Standard Domain
Your documentation is served directly from Jamdesk at your custom domain:
docs.example.com → acme.jamdesk.app
DNS points to Jamdesk, and we handle SSL certificates automatically.
Host at /docs (Proxy-Based)
Your documentation is served at a subpath on your existing website:
example.com/docs → acme.jamdesk.app/docs
You configure a proxy (Cloudflare, Vercel, nginx, etc.) to forward /docs/* requests to Jamdesk. See Hosting at /docs Subpath for setup guides.
Toggling "Host at /docs" triggers an automatic rebuild since the URL structure changes.
Verification Status
| Status | Meaning |
|---|---|
| Pending | DNS records not yet detected. Check your configuration and wait for propagation. |
| Active | Domain verified and working. |
| Failed | Verification failed. Check the error message for details. |
Click Refresh in the dashboard to manually check verification status.
Troubleshooting
DNS records not verifying
- Wrong record type: Use CNAME for subdomains, A record for apex domains
- Cloudflare proxy enabled: Set DNS to "DNS only" (gray cloud) until verification completes
- Missing trailing dot: Some providers require a trailing dot on CNAME values
- TTL too high: Lower TTL speeds up propagation (300-600 seconds recommended)
Verify your DNS configuration
Use these commands to check if your DNS is configured correctly:
# Check CNAME record
dig CNAME docs.example.com
# Check A record
dig A example.com
# Check TXT record (for Host at /docs)
dig TXT _vercel.example.comSSL certificate issues
SSL certificates are provisioned automatically after DNS verification. If your site shows certificate errors:
- Ensure DNS is pointing to the correct records
- Wait up to 24 hours for certificate provisioning
- Clear your browser cache and try again
Domain already in use
If you see "Domain already configured", the domain is registered in Vercel from a previous setup. This usually means verification will complete automatically without additional DNS changes.
Removing a Custom Domain
- Click Remove next to your domain in the dashboard
- Optionally remove the DNS records from your provider
Removing a domain that had "Host at /docs" enabled will trigger a rebuild to update URL paths.