设置自定义域名

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

本页展示如何配置自定义域名和子域名。如果你想配置自定义子目录（例如 example.com/docs），请参阅 设置自定义子目录 页面。

默认情况下，你的网站可通过一个 [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 证书。

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

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

当为你的组织、群组或版块设置自定义域名时，我们会在后台为你配置 SSL 证书，这样你的文档就会通过 HTTPS 安全加载。 当你设置自定义域名时，这一切会自动完成——你无需购买或配置 SSL 证书。

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

在这种情况下，我们建议如下：

1. 请检查你的 CNAME 记录是否设置正确。 请查看我们关于配置 DNS 的页面以获取帮助。 如果 CNAME 记录不正确，我们将无法配置 SSL 证书并完成自定义域名设置。
2. 请留出 至少一小时 在配置 CNAME 记录和完成自定义域名设置之间。
3. 确认 CNAME 已传播。你可以尝试使用第三方 DNS 查询工具，例如 WhatsMyDNS，以查看服务器认为你的 CNAME 记录应指向什么。
4. 如果你使用 Cloudflare，请确认该记录未设置代理 ，如这里所述.

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

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

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

不过，也有可能你无法访问这些内容——如果是这样，请联系支持团队，他们可以帮助你决定下一步。

不过，这个错误的解决方案始终只有两种：

1. 选择另一个自定义域名；或
2. 将自定义域名从其当前连接的内容中断开，然后重新连接到新内容。