# 设置自定义域名

{% hint style="warning" %}
此页面展示如何配置自定义域名和子域名。如果你想配置自定义子目录（例如 `example.com/docs`），请参阅 [设置自定义子目录](/docs/documentation/zh/docs-site/custom-domain/setting-a-custom-subdirectory.md) 页面。
{% endhint %}

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

你可以通过设置自定义域名来进行自定义，这意味着你的受众可以在所选域名上访问你的文档。

{% stepper %}
{% step %}

#### 选择一个子域名

在选择子域名时，你可以使用 `www` 或自定义子域名。一些常用的子域名有：

* `docs.example.com`
* `help.example.com`
* `developers.example.com`
  {% endstep %}

{% step %}

#### 开始设置自定义域名

导航到你想设置自定义域名的网站。点击 **设置，** 然后选择 **设置自定义域名。**

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

{% step %}

#### 配置 DNS

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

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

复制 **名称** 并 **目标** 字段中的内容，以便在你的 DNS 提供商中使用。每个提供商都不同，因此如有疑问，请直接向他们确认如何添加此记录。你应该能够从提供商的列表中选择 **输入** 记录的类型。

添加记录后，更改可能需要一些时间才能传播。我们建议在继续下一步之前 **至少等待 1 小时** 。准备好后点击 **下一步** 。
{% endstep %}

{% step %}

#### 完成你的设置

添加记录并完成传播后，就可以上线了！GitBook 将验证域名、你添加的记录，并自动为你的域名配置 SSL 证书。

完成后，你会收到通知，并可以点击 **完成**。如果需要，你也可以关闭窗口；当我们的处理完成后，我们会向你发送通知。
{% endstep %}
{% endstepper %}

### 故障排除

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

<details>

<summary>SSL 错误：在配置你的 SSL 证书时发生错误。</summary>

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

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

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

1. 检查你的 CNAME 记录是否设置正确。\
   请查看我们关于配置 DNS 的页面，以帮助你完成此操作。\
   如果 CNAME 记录不正确，我们将无法配置 SSL 证书并完成自定义域名设置。
2. 请允许 ***至少 1 小时*** 在配置 CNAME 记录和完成自定义域名设置之间留出时间。
3. 验证 CNAME 是否已传播。你可以尝试使用第三方 DNS 查询工具，例如 [WhatsMyDNS](https://www.whatsmydns.net/)，来查看服务器认为你的正确 CNAME 记录是什么。
4. 如果你使用的是 Cloudflare，请确认你没有将该记录代理 [，如这里所述](https://developers.cloudflare.com/fundamentals/setup/manage-domains/pause-cloudflare/#disable-proxy-on-dns-records).

</details>

<details>

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

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

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

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

不过，解决此错误的方法始终只有两种：

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

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://gitbook.com/docs/documentation/zh/docs-site/custom-domain.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.