Jamdesk Documentation logo

自定义域名

使用您自己的域名而非默认的 *.jamdesk.app 子域名提供文档服务。包括子域名与根域名的 DNS 设置、SSL 及验证。

使用您自己的域名而非默认的 *.jamdesk.app 子域名提供文档服务。

设置概览

1
在控制台中添加域名

前往项目的 Settings → Domain,输入您的域名(例如 docs.example.com 或 example.com)。

2
配置 DNS

将控制台中显示的 DNS 记录添加到您的 DNS 提供商。记录内容取决于您的域名类型(见下文)。

3
验证并等待

Jamdesk 会验证所有权并签发 SSL 证书。

托管选项

添加域名时选择托管模式。

标准域名

Jamdesk 直接在您的自定义域名上提供文档服务:

docs.example.com → acme.jamdesk.app

DNS 指向 Jamdesk。Jamdesk 负责签发和续订 SSL 证书。

在 /docs 托管(基于代理,可自定义子路径)

您的文档位于现有网站的子路径下:

example.com/docs → acme.jamdesk.app/docs

/docs 为默认值。您也可以在同一开关中选择任意单段子路径(如 /help、/guide 等)。配置代理(Cloudflare、Vercel、nginx 等),将该子路径的请求转发至 Jamdesk。有关设置指南及选择子路径的规则,请参阅子路径托管。

切换"托管在子路径"或更改子路径会触发重新构建,URL 结构也会随之改变。

DNS 配置

所需记录取决于您使用的是子域名还是根(apex)域名。

子域名(例如 docs.example.com)

类型名称值
CNAMEdocscname.jamdesk.com
TXT_jamdesk.docs(在控制台中显示)

"Name"字段填写子域名部分。对于 docs.example.com,请填写 docs。

根域名(例如 example.com)

类型名称值
A@76.76.21.21
TXT_jamdesk(在控制台中显示)

根域名使用 A 记录而非 CNAME。DNS 标准(RFC 1034)禁止在区域顶点使用 CNAME 记录。

DNS 更改最长可能需要 48 小时才能生效,多数会在几分钟内完成。您可以在 whatsmydns.net 查看状态。

验证

添加 DNS 记录后,Jamdesk 将执行以下步骤:

  1. 检测您的 DNS 记录(CNAME 或 A 记录,以及 TXT)
  2. 通过 TXT 记录验证域名所有权
  3. 通过 Let's Encrypt 签发 SSL 证书
  4. 将流量路由至您的文档

在 Settings → Domain 中查看验证状态。状态包括:

  • Pending - 等待 DNS 生效
  • Active - 域名已验证并正在提供服务
  • Needs Attention - 配置不匹配或存在冲突(请查看邮件通知)
  • Error - 配置问题(详情见控制台)

在控制台中点击 Refresh 可立即检查验证状态。

SSL 证书

Jamdesk 会签发 SSL 证书,并在到期前续订。HTTP 请求会重定向至 HTTPS。

根域名

根(apex)域名如 example.com 同样适用。控制台会显示指向 76.76.21.21 的 A 记录,而非 CNAME。DNS 标准禁止在区域顶点使用 CNAME 记录。

多个域名

每个项目只能绑定一个自定义域名。若要让更多域名指向同一文档:

  1. 在 Jamdesk 中设置您的主域名
  2. 在 DNS/CDN 层面将其他域名重定向至主域名

移除域名

  1. 前往 Settings → Domain
  2. 点击 Remove Domain
  3. 您的文档仍可通过 *.jamdesk.app 子域名访问

在启用"托管在子路径"的情况下移除域名,会触发重新构建以更新 URL 路径。Jamdesk 还会清除自定义子路径。之后重新连接的域名将恢复为默认的 /docs。

Cloudflare 用户

若您使用 Cloudflare 作为 DNS 提供商,请按以下步骤操作:

  1. 在域名验证期间,将代理状态设为 DNS only(灰色云图标)
  2. 让 Vercel 处理 SSL:为文档子域名禁用 Cloudflare 的"Always Use HTTPS"
  3. 验证完成后,可重新启用代理(橙色云)

使用 Cloudflare Worker? DNS 记录必须开启代理(橙色云)Worker 才能运行。仅在验证期间使用灰色云,之后再切换回橙色云。详情请参阅 Cloudflare Workers 设置。

故障排除

问题解决方案
域名一直停留在 "Pending"使用 dig 检查 DNS 记录(子域名用 CNAME,根域名用 A)
SSL 证书错误确保没有 CAA 记录阻止 Let's Encrypt
重定向循环若使用 Cloudflare,请在验证期间设为灰色云(见上方 Cloudflare 用户)
CNAME 无法解析在 DNS 提供商处核实记录,并等待生效
域名已被占用该域名在之前的设置中已在 Vercel 注册;验证通常会自动完成

使用 dig 验证 DNS

# 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

如需详细诊断,请参阅 DNS 故障排除。

jamdesk.app 子域名会在搜索中与我的域名竞争吗?

不会。从您的 [slug].jamdesk.app 子域名提供的页面包含指向您当前活动自定义域名的 canonical 链接。搜索引擎会将排名信号计入您的域名。

下一步

子域名

配置子域名专属设置

子路径托管

将文档托管在 example.com/docs

DNS 故障排除

诊断 DNS 配置问题