具有存储库管理员权限的人员可以为 GitHub Pages 站点配置自定义域名。
关于自定义域名配置
提示
我们建议您在将自定义域名添加到存储库之前验证它,以提高安全性并避免接管攻击。有关更多信息,请参阅“验证 GitHub Pages 的自定义域名”。
请确保在使用 DNS 提供商配置自定义域名之前,将其添加到 GitHub Pages 站点。在将自定义域名添加到 GitHub 之前使用 DNS 提供商配置它可能会导致其他人能够在您的子域名之一上托管站点。
dig
命令(可用于验证 DNS 记录的正确配置)未包含在 Windows 中。要验证您的 DNS 记录是否已正确配置,您可以使用 Resolve-DnsName
PowerShell 命令或安装 BIND。
注意
DNS 更改可能需要长达 24 小时才能传播。
配置顶层域名
要设置顶层域名(例如 example.com
),您必须在存储库设置中以及使用 DNS 提供商配置至少一个 ALIAS
、ANAME
或 A
记录。
-
在 GitHub 上,导航到您站点的存储库。
-
在您的存储库名称下,单击 **设置**。如果您看不到“设置”选项卡,请选择****下拉菜单,然后单击**设置**。
-
在侧边栏的“代码和自动化”部分,单击** Pages**。
-
在“自定义域名”下,键入您的自定义域名,然后单击**保存**。如果您是从分支发布站点,这将创建一个提交,该提交会将
CNAME
文件直接添加到源分支的根目录。如果您使用自定义 GitHub Actions 工作流发布站点,则不会创建CNAME
文件,因此您需要手动创建一个(其中仅包含一行包含自定义域名的文本)。有关发布源的更多信息,请参阅“配置 GitHub Pages 站点的发布源”。 -
导航到您的 DNS 提供商并创建
ALIAS
、ANAME
或A
记录。您还可以创建AAAA
记录以支持 IPv6。如果您正在实施 IPv6 支持,我们强烈建议除了AAAA
记录之外还使用A
记录,因为 IPv6 在全球范围内的采用速度较慢。有关如何创建正确记录的更多信息,请参阅您的 DNS 提供商的文档。-
要创建
ALIAS
或ANAME
记录,请将您的顶层域名指向站点的默认域名。有关站点默认域名的更多信息,请参阅“关于 GitHub Pages”。 -
要创建
A
记录,请将您的顶层域名指向 GitHub Pages 的 IP 地址。185.199.108.153 185.199.109.153 185.199.110.153 185.199.111.153
-
要创建
AAAA
记录,请将您的顶层域名指向 GitHub Pages 的 IP 地址。2606:50c0:8000::153 2606:50c0:8001::153 2606:50c0:8002::153 2606:50c0:8003::153
警告
我们强烈建议您不要使用通配符 DNS 记录,例如
*.example.com
。即使您验证了域名,这些记录也会使您立即面临域名接管的风险。例如,如果您验证了example.com
,这将阻止其他人使用a.example.com
,但他们仍然可以接管b.a.example.com
(它受通配符 DNS 记录的覆盖)。有关更多信息,请参阅“验证 GitHub Pages 的自定义域名”。 -
-
打开 终端终端Git Bash。
-
要确认您的 DNS 记录已正确配置,请使用
dig
命令,将 EXAMPLE.COM 替换为您自己的顶层域名。确认结果与上面 GitHub Pages 的 IP 地址匹配。-
对于
A
记录$ dig EXAMPLE.COM +noall +answer -t A > EXAMPLE.COM 3600 IN A 185.199.108.153 > EXAMPLE.COM 3600 IN A 185.199.109.153 > EXAMPLE.COM 3600 IN A 185.199.110.153 > EXAMPLE.COM 3600 IN A 185.199.111.153
-
对于
AAAA
记录$ dig EXAMPLE.COM +noall +answer -t AAAA > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153
请记住也要检查您的
A
记录。
-
-
如果您使用静态站点生成器在本地构建站点并将生成的文件夹推送到 GitHub,请将添加了 CNAME 文件的提交拉取到本地存储库。有关更多信息,请参阅“排查自定义域名和 GitHub Pages 问题”。
-
或者,要为您的站点强制执行 HTTPS 加密,请选择**强制使用 HTTPS**。此选项可能需要长达 24 小时才能可用。有关更多信息,请参阅“使用 HTTPS 保护 GitHub Pages 站点”。
配置顶层域名和 www
子域名变体
注意
建议为 HTTPS 保护的网站设置 www
子域名。
如果您使用顶层域名作为自定义域名,我们建议您也设置 www
子域名。如果您通过 DNS 提供商为每个域名类型配置了正确的记录,GitHub Pages 将自动在域名之间创建重定向。例如,如果您将 www.example.com
配置为站点的自定义域名,并且您已为顶层域名和 www
域名设置了 GitHub Pages DNS 记录,则 example.com
将重定向到 www.example.com
。请注意,自动重定向仅适用于 www
子域名。自动重定向不适用于任何其他子域名,例如 blog
。有关更多信息,请参阅“配置子域名”。
转到您的 DNS 提供商并为www
子域创建一个CNAME
记录,使其指向您的 GitHub Pages 默认域名。例如,如果您的网站位于<user>.github.io
,则应创建一个将www.example.com
指向<user>.github.io
的CNAME
记录。类似地,对于位于<organization>.github.io
的组织网站,您应该创建一个将www.example.com
指向<organization>.github.io
的CNAME
记录。确保CNAME
记录直接指向<user>.github.io
或<organization>.github.io
,不包括存储库名称。
有关如何创建正确记录的更多信息,请参阅您的 DNS 提供商的文档。有关您网站的默认域名的更多信息,请参阅“关于 GitHub Pages”。
配置子域
要设置www
或自定义子域(例如www.example.com
或blog.example.com
),您必须在存储库设置中添加您的域名。之后,使用您的 DNS 提供商配置 CNAME 记录。
-
在 GitHub 上,导航到您站点的存储库。
-
在您的存储库名称下,单击 **设置**。如果您看不到“设置”选项卡,请选择****下拉菜单,然后单击**设置**。
-
在侧边栏的“代码和自动化”部分,单击** Pages**。
-
在“自定义域名”下,键入您的自定义域名,然后单击**保存**。如果您是从分支发布站点,这将创建一个提交,该提交会将
CNAME
文件直接添加到源分支的根目录。如果您使用自定义 GitHub Actions 工作流发布站点,则不会创建CNAME
文件,因此您需要手动创建一个(其中仅包含一行包含自定义域名的文本)。有关发布源的更多信息,请参阅“配置 GitHub Pages 站点的发布源”。 -
转到您的 DNS 提供商并创建一个
CNAME
记录,使您的子域指向您网站的默认域名。例如,如果您想为您的用户网站使用子域www.example.com
,请创建一个将www.example.com
指向<user>.github.io
的CNAME
记录。如果您想为您的组织网站使用子域another.example.com
,请创建一个将another.example.com
指向<organization>.github.io
的CNAME
记录。CNAME
记录应始终指向<user>.github.io
或<organization>.github.io
,不包括存储库名称。有关如何创建正确记录的更多信息,请参阅您的 DNS 提供商的文档。有关您网站的默认域名的更多信息,请参阅“关于 GitHub Pages”。警告
我们强烈建议您不要使用通配符 DNS 记录,例如
*.example.com
。即使您验证了域名,这些记录也会使您立即面临域名接管的风险。例如,如果您验证了example.com
,这将阻止其他人使用a.example.com
,但他们仍然可以接管b.a.example.com
(它受通配符 DNS 记录的覆盖)。有关更多信息,请参阅“验证 GitHub Pages 的自定义域名”。 -
打开 终端终端Git Bash。
-
要确认您的 DNS 记录是否已正确配置,请使用
dig
命令,将WWW.EXAMPLE.COM替换为您自己的子域。$ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd > ;WWW.EXAMPLE.COM. IN A > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1
-
如果您使用静态站点生成器在本地构建站点并将生成的文件夹推送到 GitHub,请将添加了 CNAME 文件的提交拉取到本地存储库。有关更多信息,请参阅“排查自定义域名和 GitHub Pages 问题”。
-
或者,要为您的站点强制执行 HTTPS 加密,请选择**强制使用 HTTPS**。此选项可能需要长达 24 小时才能可用。有关更多信息,请参阅“使用 HTTPS 保护 GitHub Pages 站点”。
注意
如果您将自定义子域指向您的顶层域名,则会出现强制 HTTPS 到您的网站的问题,并且您可能会遇到子域根本无法到达您的 GitHub Pages 网站的问题。
自定义域名的 DNS 记录
如果您熟悉为 GitHub Pages 网站配置域名的过程,则可以使用下表查找特定方案的 DNS 值以及您的 DNS 提供商支持的 DNS 记录类型。有关更多信息,包括如何在 GitHub 上配置您的 GitHub Pages 网站以及如何使用dig
命令验证配置,请参阅以上各节。
要配置顶层域名,您只需要从下表中选择一种 DNS 记录类型即可。要配置顶层域名和www
子域(例如,example.com
和www.example.com
),请先配置顶层域名,然后再配置子域。有关更多信息,请参阅“配置顶层域名和www
子域变体”。
警告
我们强烈建议您不要使用通配符 DNS 记录,例如 *.example.com
。即使您验证了域名,这些记录也会使您立即面临域名接管的风险。例如,如果您验证了 example.com
,这将阻止其他人使用 a.example.com
,但他们仍然可以接管 b.a.example.com
(它受通配符 DNS 记录的覆盖)。有关更多信息,请参阅“验证 GitHub Pages 的自定义域名”。
场景 | DNS 记录类型 | DNS 记录名称 | DNS 记录值 |
---|---|---|---|
顶层域名 ( example.com ) | A | @ | 185.199.108.153 185.199.109.153 185.199.110.153 185.199.111.153 |
顶层域名 ( example.com ) | AAAA | @ | 2606:50c0:8000::153 2606:50c0:8001::153 2606:50c0:8002::153 2606:50c0:8003::153 |
顶层域名 ( example.com ) | ALIAS 或 ANAME | @ | USERNAME.github.io 或ORGANIZATION.github.io |
子域 ( www.example.com ,blog.example.com ) | CNAME | SUBDOMAIN.example.com. | USERNAME.github.io 或ORGANIZATION.github.io |
删除自定义域名
如果您收到有关自定义域名已被占用的错误,则可能需要从另一个存储库中删除该自定义域名。
-
在 GitHub 上,导航到您站点的存储库。
-
在您的存储库名称下,单击 **设置**。如果您看不到“设置”选项卡,请选择****下拉菜单,然后单击**设置**。
-
在侧边栏的“代码和自动化”部分,单击** Pages**。
-
在“自定义域名”下,单击删除。
保护您的自定义域名
如果您的 GitHub Pages 网站已禁用但已设置自定义域名,则它有被域名接管的风险。在您的网站禁用时,如果您的 DNS 提供商配置了自定义域名,则可能导致其他人托管您子域上的网站。
验证您的自定义域名可防止其他 GitHub 用户将其存储库与您的域名一起使用。如果您的域名未经验证,并且您的 GitHub Pages 网站已禁用,则应立即更新或删除您与 DNS 提供商的 DNS 记录。有关更多信息,请参阅“验证您的 GitHub Pages 自定义域名”。