Deployment Overview
Hosting options for your documentation — Jamdesk subdomain, custom domain with SSL, or /docs subpath behind your existing site using a reverse proxy.
Jamdesk deploys your docs automatically to a *.jamdesk.app subdomain. When you are ready to go live on your own domain, you can choose a custom subdomain (like docs.example.com) or host at a /docs subpath on your main site.
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) | Keep docs on the main domain | High |
Default Hosting (No Setup)
Every project ships live on a Jamdesk subdomain as soon as you connect a repo. This is the simplest option for internal docs, previews, or early launches.
Custom Domain (Subdomain)
Use your own subdomain (for example, docs.example.com) for a branded, public-facing URL. You will add DNS records and verify ownership in the Jamdesk dashboard.
DNS verification and SSL are handled automatically once the records are in place. See Custom Domains for setup.
Subpath Hosting (/docs)
Host docs at example.com/docs by proxying traffic to Jamdesk. This is ideal when you want docs to live 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;
}
For a full configuration with SSL, headers, and provider-specific guidance, see the Subpath Hosting guide.
Provider Guides
Choose your infrastructure to implement subpath hosting: