Jamdesk Documentation logo

部署概览

文档的托管选项:Jamdesk 子域名、带 SSL 的自定义域名,或通过反向代理置于现有网站下的 /docs 子路径。

Jamdesk 会将你的文档部署到 *.jamdesk.app 子域名。要在自己的域名上上线,可以选择自定义子域名(如 docs.example.com)或主站上的子路径。子路径默认为 /docs,也可以选择任何自定义路径段。

部署选项

选项适用场景设置复杂度
Jamdesk 子域名(your-project.jamdesk.app)最快上线,无需 DNS 操作低
自定义子域名(docs.example.com)使用品牌的生产文档中
子路径托管(example.com/docs,可自定义)将文档保留在主域名下高

默认托管(无需设置)

连接代码仓库后,每个项目都会立即在 Jamdesk 子域名上线。适用于内部文档、预览或早期发布。

自定义域名(子域名)

使用你自己的子域名(例如 docs.example.com)获得带品牌的公开 URL。在 Jamdesk 控制台中添加 DNS 记录并验证所有权。

DNS 记录生效后,Jamdesk 会验证 DNS 并签发 SSL。设置方法请参阅自定义域名。

子路径托管

将流量代理到 Jamdesk,即可在你的域名下的子路径托管文档。默认为 example.com/docs,也可以选择自定义路径段,如 example.com/help。若希望文档保留在主营销域名之下,请使用此选项。

子路径托管需要代理或 CDN 层来转发请求并设置 X-Jamdesk-Forwarded-Host 请求头。请参阅子路径托管。

代理示例代码片段(nginx)

nginx.conf
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;
}

如需包含 SSL、请求头及各服务商具体步骤的完整配置,请参阅子路径托管指南。

提供商指南

选择与你的基础设施对应的指南:

Cloudflare

使用 Cloudflare Workers 代理 /docs 流量

AWS

配置 CloudFront 与 Route 53

Vercel

添加重写规则或边缘中间件

反向代理

nginx、Apache 或其他代理服务器

接下来做什么?

构建与部署生命周期

构建如何被触发并部署

子路径托管

在主域名的 /docs 下托管文档

自定义域名

设置 docs.yourdomain.com

DNS 故障排除

解决 DNS 传播与验证问题