Custom Domains
Serve your docs from your own domain instead of the default *.jamdesk.app subdomain. DNS setup for subdomains and apex domains, SSL, and verification.
Serve your docs from your own domain instead of the default *.jamdesk.app subdomain.
Setup Overview
Go to your project Settings → Domain and enter your domain (e.g., docs.example.com or example.com).
Add the DNS records shown in the dashboard to your DNS provider. The records depend on your domain type (see below).
Jamdesk verifies ownership and provisions an SSL certificate.
Hosting Options
Choose a hosting mode when you add a domain.
Standard Domain
Jamdesk serves your documentation directly at your custom domain:
docs.example.com → acme.jamdesk.app
DNS points to Jamdesk. Jamdesk issues and renews the SSL certificate.
Host at /docs (Proxy-Based, Customizable Subpath)
Your documentation lives at a subpath on your existing website:
example.com/docs → acme.jamdesk.app/docs
/docs is the default. Pick any one-segment subpath instead (/help, /guide, and so on) from the same toggle. Configure a proxy (Cloudflare, Vercel, nginx, etc.) to forward requests for that subpath to Jamdesk. See Subpath Hosting for setup guides and the rules for choosing a subpath.
Toggling "Host at a subpath" or changing the subpath triggers a rebuild. The URL structure changes.
DNS Configuration
The records you need depend on whether you're using a subdomain or an apex (root) domain.
Subdomains (e.g., docs.example.com)
| Type | Name | Value |
|---|---|---|
| CNAME | docs | cname.jamdesk.com |
| TXT | _jamdesk.docs | (shown in dashboard) |
The "Name" field is the subdomain portion. For docs.example.com, enter docs.
Apex Domains (e.g., example.com)
| Type | Name | Value |
|---|---|---|
| A | @ | 76.76.21.21 |
| TXT | _jamdesk | (shown in dashboard) |
Apex domains use an A record instead of CNAME. DNS standards (RFC 1034) prohibit CNAME records at the zone apex.
DNS changes can take up to 48 hours to propagate. Most complete within minutes. Check status at whatsmydns.net.
Verification
Jamdesk runs these steps once you add the DNS records:
- Detects your DNS records (CNAME or A record, plus TXT)
- Verifies domain ownership via the TXT record
- Provisions an SSL certificate via Let's Encrypt
- Routes traffic to your documentation
Check verification status in Settings → Domain. Status shows as:
- Pending - Waiting for DNS propagation
- Active - Domain verified and serving traffic
- Needs Attention - Configuration mismatch or conflict (check email notification)
- Error - Configuration issue (see details in dashboard)
Click Refresh in the dashboard to check verification status now.
SSL Certificates
Jamdesk provisions SSL certificates and renews them before expiration. HTTP requests redirect to HTTPS.
Root Domains
Root (apex) domains like example.com work. The dashboard shows an A record pointing to 76.76.21.21 instead of a CNAME. DNS standards prohibit CNAME records at the zone apex.
Multiple Domains
Each project has one custom domain. To point more domains at the same docs:
- Set up your primary domain in Jamdesk
- Configure additional domains to redirect to the primary at the DNS/CDN level
Removing a Domain
- Go to Settings → Domain
- Click Remove Domain
- Your docs remain accessible at the
*.jamdesk.appsubdomain
Removing a domain with "Host at a subpath" enabled triggers a rebuild to update URL paths. Jamdesk also clears any custom subpath. A domain you reconnect later starts back at the default /docs.
Cloudflare Users
Follow these steps if Cloudflare is your DNS provider:
- Set proxy status to DNS only (gray cloud icon) during domain verification
- Let Vercel handle SSL: disable Cloudflare's "Always Use HTTPS" for the docs subdomain
- After verification completes, you can re-enable proxying (orange cloud)
Using a Cloudflare Worker? The DNS record must be proxied (orange cloud) for the Worker to run. Use gray cloud only during verification, then switch back. See Cloudflare Workers setup for details.
Troubleshooting
| Issue | Solution |
|---|---|
| Domain stuck on "Pending" | Check DNS records with dig (CNAME for subdomains, A for apex) |
| SSL certificate errors | Ensure no CAA records block Let's Encrypt |
| Redirect loops | If using Cloudflare, set to gray cloud during verification (see Cloudflare Users above) |
| CNAME not resolving | Verify record at DNS provider, wait for propagation |
| Domain already in use | Domain is registered in Vercel from a previous setup; verification usually completes automatically |
Verify DNS with dig
# Check CNAME record (subdomains)
dig CNAME docs.example.com
# Check A record (apex domains)
dig A example.com
# Check TXT record
dig TXT _jamdesk.example.com
For detailed diagnostics, see DNS Troubleshooting.
Does the jamdesk.app subdomain compete with my domain in search?
No. Pages served from your [slug].jamdesk.app subdomain include a canonical
link pointing at your active custom domain. Search engines credit your domain
with the ranking signals.
