Deployment Overview
Hosting options for your documentation: Jamdesk subdomain, custom domain with SSL, or a /docs subpath behind your existing site using a reverse proxy.
Jamdesk deploys your docs to a *.jamdesk.app subdomain. To go live on your own domain, pick a custom subdomain (like docs.example.com) or a subpath on your main site. The subpath is /docs by default, or any custom segment you choose.
Deployment Options
| Option | Best For | Setup Complexity |
|---|---|---|
Jamdesk subdomain (your-project.jamdesk.app) | Fastest launch, zero DNS work | Low |
Custom subdomain (docs.example.com) | Production docs with your brand | Medium |
Subpath hosting (example.com/docs, customizable) | Keep docs on the main domain | High |
Default Hosting (No Setup)
Every project goes live on a Jamdesk subdomain as soon as you connect a repo. Use it for internal docs, previews, or early launches.
Custom Domain (Subdomain)
Use your own subdomain (for example, docs.example.com) for a branded, public URL. Add DNS records and verify ownership in the Jamdesk dashboard.
Jamdesk verifies DNS and issues SSL once the records are in place. See Custom Domains for setup.
Subpath Hosting
Proxy traffic to Jamdesk to host docs at a subpath on your domain. The default is example.com/docs, or pick a custom segment like example.com/help. Use this option to keep docs under your main marketing domain.
Subpath hosting requires a proxy or CDN layer to forward requests and set the X-Jamdesk-Forwarded-Host header. See Subpath Hosting.
Example Proxy Snippet (nginx)
location /docs {
proxy_pass https://YOUR_SLUG.jamdesk.app;
proxy_set_header X-Jamdesk-Forwarded-Host $host;
}
location /_next/ {
proxy_pass https://YOUR_SLUG.jamdesk.app;
}
location /_jd/ {
proxy_pass https://YOUR_SLUG.jamdesk.app;
}
See the Subpath Hosting guide for a full configuration with SSL, headers, and provider-specific steps.
Provider Guides
Pick the guide for your infrastructure: