设置自定义域名

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

本页展示如何配置自定义域名和子域名。如果你想配置自定义子目录（例如 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 证书。

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

故障排除

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

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

当为你的组织、集合或空间设置了自定义域名时，我们会在后台为你配置 SSL 证书，以便你的文档能够通过 HTTPS 安全加载。 当你设置自定义域名时，这一过程会自动进行——你无需购买或配置 SSL 证书。

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

在这些情况下，我们建议你采取以下措施：

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

2. 请至少 等待 1 小时 ，再在配置 CNAME 记录后完成自定义域名设置。

3. 验证 CNAME 是否已传播。你可以尝试使用第三方 DNS 查询工具，例如 WhatsMyDNS，来查看服务器认为正确的 CNAME 记录内容。

4. 如果你使用的是 Cloudflare，请确认该记录没有启用代理 ，如下所述.

域名已连接错误：你的子域名已为不同内容配置。

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

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

也有可能你无法访问该内容——如果是这样，请联系支持团队，他们可以帮助你了解后续步骤。

不过，这种错误的解决方案通常只有两种：

1. 选择另一个自定义域名；或

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