For the complete documentation index, see llms.txt. This page is also available as Markdown.

设置自定义域名

为你的文档站点设置自定义域名

默认情况下,你的网站可通过 [subdomain].gitbook.io 域名访问。

你可以通过设置自定义域名来进行个性化配置,这意味着你的受众可以通过你选择的域名访问你的文档。

1

选择子域名

在选择子域名时,你可以使用 www 或者自定义子域名。常见的子域名有:

  • docs.example.com

  • help.example.com

  • developers.example.com

2

开始设置自定义域名

前往你想要设置自定义域名的网站。点击 设置, 然后选择 设置自定义域名。

在这里,你会看到一个窗口,可以输入你在第一步中选择的自定义域名。输入后点击 下一步。

3

配置 DNS

在此阶段,你会看到一个包含三个字段的窗口: 类型、名称、目标。

这些就是你在 DNS 提供商处设置自定义域名时需要使用的详细信息。此操作是在 外部 GitBook 中、你用于域名的提供商处完成的。

复制 名称 和 目标 字段中的内容,并在你的 DNS 提供商中使用。每个提供商都不同,因此如果不确定,请直接向他们确认如何添加这条记录。你应该能够在提供商的列表中选择 类型 记录类型。

添加记录后,变更可能需要一些时间才能传播。我们建议 至少等待 1 小时 后再进行下一步。点击 下一步 ,准备好后继续。

4

完成设置

在添加记录并传播生效后,就可以上线了!GitBook 将验证该域名和你添加的记录,并自动为你的域名配置 SSL 证书。

完成后,你会收到通知,并且可以点击 完成。如果需要,你也可以关闭窗口;当我们这边处理完成后,我们会向你发送通知。

更改或更新你的自定义域名

要更改某个网站的自定义域名,请打开该网站的 设置 网站侧边栏中的 域名和 URL。你可以删除当前域名并添加新域名,或者编辑现有配置。

请记得在你的域名提供商处更新 DNS 设置,使其指向新的 GitBook 配置——这个过程与初始设置相同,使用指向 GitBook 提供值的 CNAME 记录。

故障排除

设置自定义域名有时可能会遇到障碍。下面,我们概述在此过程中常见的问题,并为每个问题提供详细解决方案。

我的自定义子域名无法正常工作。

自定义域名问题通常与 DNS 有关。请检查你的 DNS 配置:

  1. 确认你已创建 CNAME 记录 (不是 A 记录),并指向 GitBook 提供的值。

  2. 确保你使用的是子域名格式(docs.yoursite.com 或 www.yoursite.com).

  3. 如果你使用 Cloudflare,请关闭代理(橙色云朵)——该记录必须设置为“仅 DNS”。

常见的 DNS 问题:

  • 冲突记录 ——删除同一子域名的任何现有 A、AAAA 或其他记录。

  • TTL 延迟 ——DNS 变更在全球范围内传播最多可能需要 48 小时。

  • CAA 记录 ——如果你有 CAA 记录,请添加 0 issue "pki.goog" 以允许 GitBook 的 SSL 证书。

要测试你的设置,请使用类似 WhatsMyDNS 的 DNS 查询工具,验证你的 CNAME 记录是否指向正确的 GitBook 地址。如果 48 小时后问题仍然存在,请联系支持团队,并提供你的域名以及 GitBook 提供的 CNAME 值。

SSL 错误:配置 SSL 证书时发生错误。

当为你的组织、组或部分设置自定义域名时,我们会在后台为你配置 SSL 证书,以便你的文档通过 HTTPS 安全加载。\n\n当你设置自定义域名时,这一过程会自动完成——你无需购买或配置 SSL 证书。

在此阶段偶尔会发生错误,通常是因为自定义域名的 CNAME 记录尚未传播生效。

在这些情况下,我们建议如下:

  1. 检查你的 CNAME 记录是否设置正确。\n请查看我们关于配置 DNS 的页面以获取帮助。\n如果 CNAME 记录不正确,我们将无法配置 SSL 证书并完成自定义域名设置。

  2. 至少 一小时 以完成 CNAME 记录配置和自定义域名设置。

  3. 确认 CNAME 是否已传播生效。你可以尝试使用第三方 DNS 查询工具,例如 WhatsMyDNS,以了解服务器认为你的 CNAME 记录的正确值。

  4. 如果你使用 Cloudflare,请确认你没有将该记录代理 如本文所述.

域名已连接错误:你的子域名已配置为其他内容。

分配给网站的自定义域名必须是唯一的。在多个位置尝试使用相同的自定义域名会导致错误。

如果发生这种情况,你可以点击错误消息中的链接,查看该自定义域名已连接到的内容。这可能有助于你决定下一步怎么做。

不过,也有可能你无法访问该内容——如果是这样,请联系支持团队,他们可以帮助你了解下一步该怎么做。

不过,这个错误的解决方案通常只有两种:

  1. 选择不同的自定义域名;或

  2. 将自定义域名从当前连接的内容中断开,然后将其重新连接到新内容。

最后更新于

这有帮助吗?