> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/fa-bu/custom-domain.md).

# 设置自定义域名

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

默认情况下，您的站点可通过一个 `[子域名].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 %}

### 更改或更新您的自定义域名

若要更改站点的自定义域名，请打开该站点的 **设置**，在 **常规** 站点侧边栏中的 **域名和 URL**。您可以移除当前域名并添加新域名，或编辑现有配置。

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

### 故障排查

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

<details>

<summary>我的自定义子域名无法使用。</summary>

自定义域名问题通常与 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](https://www.whatsmydns.net/#CNAME) 的 DNS 查询工具，验证您的 CNAME 记录是否指向正确的 GitBook 地址。如果 48 小时后问题仍然存在，请联系支持团队，并提供您的域名及 GitBook 提供的 CNAME 值。

</details>

<details>

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

当为您的组织、群组或部分设置自定义域名时，我们会在我们这边设置 SSL 证书，以便您的文档能通过 HTTPS 安全加载。\
\
这会在您设置自定义域名时自动完成——您无需购买或配置 SSL 证书。

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

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

1. 检查您的 CNAME 记录是否已正确设置。\
   请查看我们关于配置 DNS 的页面以获取帮助。\
   如果 CNAME 记录不正确，我们将无法配置 SSL 证书并完成自定义域名设置。
2. 在 ***至少一小时*** 后再完成自定义域名设置，即在配置 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
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/documentation/zh/fa-bu/custom-domain.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.