Jamdesk Documentation logo

Subpath Hosting

Host your docs at yoursite.com/docs instead of a separate subdomain. Includes Vercel, CloudFront, Cloudflare, and reverse proxy setups.

Host your docs at yoursite.com/docs instead of a separate subdomain. For all deployment options, see Deployment Overview.

Why Use a Subpath?

Hosting docs at yoursite.com/docs instead of a subdomain like docs.yoursite.com provides:

  • Better SEO - Documentation pages contribute to your main domain's authority
  • Unified experience - Users stay on your primary domain
  • Simpler navigation - No context switching between domains

How It Works

Your web server or CDN proxies requests from /docs/* to your Jamdesk site while preserving the original URL in the browser:

The proxy passes the X-Jamdesk-Forwarded-Host header with your domain. Jamdesk uses this to:

  1. Verify your domain is authorized to serve the content
  2. Apply your configuration from the dashboard

This means your proxy configuration is a one-time setup - if you change settings in the dashboard, the proxy doesn't need to be updated.

Setup by Provider

Choose your hosting provider to get started:

Cloudflare

Use Cloudflare Workers to proxy /docs traffic

AWS

Configure CloudFront with Route 53

Vercel

Add rewrites to vercel.json

Reverse Proxy

nginx, Apache, or other proxy servers

Prerequisites

Before configuring your proxy:

  1. Enable subpath hosting in your Jamdesk dashboard under Settings → Custom Domain
  2. Toggle "Host at /docs" to on
  3. Add your domain (e.g., yoursite.com)

Your Jamdesk subdomain (e.g., acme.jamdesk.app) will be displayed in the dashboard - you'll need this for your proxy configuration.

Toggling "Host at /docs" on or off triggers an automatic rebuild of your documentation. This is required because the URL structure changes between /introduction and /docs/introduction.

Once you've configured your proxy, test by visiting https://yoursite.com/docs. Your documentation should load with all assets and links working correctly.

What's Next?

Deployment Overview

Compare subdomain, custom domain, and subpath hosting

Custom Domains

Verify DNS and troubleshoot domain setup

Subpath Hosting — Jamdesk Documentation