Jamdesk Documentation logo

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

1
Add domain in dashboard

Go to your project Settings → Domain and enter your domain (e.g., docs.example.com or example.com).

2
Configure DNS

Add the DNS records shown in the dashboard to your DNS provider. The records depend on your domain type (see below).

3
Verify and wait

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)

TypeNameValue
CNAMEdocscname.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)

TypeNameValue
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:

  1. Detects your DNS records (CNAME or A record, plus TXT)
  2. Verifies domain ownership via the TXT record
  3. Provisions an SSL certificate via Let's Encrypt
  4. 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:

  1. Set up your primary domain in Jamdesk
  2. Configure additional domains to redirect to the primary at the DNS/CDN level

Removing a Domain

  1. Go to Settings → Domain
  2. Click Remove Domain
  3. Your docs remain accessible at the *.jamdesk.app subdomain

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:

  1. Set proxy status to DNS only (gray cloud icon) during domain verification
  2. Let Vercel handle SSL: disable Cloudflare's "Always Use HTTPS" for the docs subdomain
  3. 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

IssueSolution
Domain stuck on "Pending"Check DNS records with dig (CNAME for subdomains, A for apex)
SSL certificate errorsEnsure no CAA records block Let's Encrypt
Redirect loopsIf using Cloudflare, set to gray cloud during verification (see Cloudflare Users above)
CNAME not resolvingVerify record at DNS provider, wait for propagation
Domain already in useDomain 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.

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.

What's Next?

Subdomains

Configure subdomain-specific settings

Subpath Hosting

Host docs at example.com/docs

DNS Troubleshooting

Diagnose DNS configuration issues