管理 GitHub Pages 站点的自定义域

本文内容

  • 关于自定义域配置
  • 配置子域
  • 配置 apex 域
  • 配置顶点域和 www 子域变体
  • 自定义域的 DNS 记录
  • 删除自定义域
  • 保护自定义域
  • 延伸阅读

您可以设置或更新某些 DNS 记录和仓库设置,以将 GitHub Pages 站点的默认域指向自定义域。

Platform navigation

MacWindowsLinux

GitHub Pages 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。 有关详细信息,请参阅“GitHub 的计划”。

拥有仓库管理员权限的人可为 GitHub Pages 站点配置自定义域。

关于自定义域配置

使用 DNS 提供程序配置自定义域之前,请确保将自定义域添加到您的 GitHub Pages 站点。 使用 DNS 提供程序配置自定义域而不将其添加到 GitHub,可能导致其他人能够在您的某个子域上托管站点。

dig 命令可用于验证 DNS 记录的配置是否正确,它未包含在 Windows 中。 必须安装 BIND 才能验证 DNS 记录是否配置正确。

注意:传播 DNS 更改可能需要长达 24 小时的时间。

配置子域

要设置 www 或自定义子域(例如 www.example.comblog.example.com),必须在存储库设置中添加你的域。 然后,通过 DNS 提供商配置 CNAME 记录。

  1. 在 GitHub 上,导航到站点的仓库。

  2. 在存储库名称下,单击 “设置”。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“代码和自动化”部分中,单击“ Pages”。

  4. 在“自定义域”下,键入自定义域,然后单击“保存”。 如果从分支发布站点,会创建一个提交,将 CNAME 直接文件添加到源分支的根目录。 如果使用自定义 GitHub Actions 工作流发布站点,则不会创建 CNAME 文件。 有关发布源的详细信息,请参阅“配置 GitHub Pages 站点的发布源”。

    注意:如果自定义域是国际化域名,则必须输入 Punycode 编码版本。

    有关 Punycodes 的详细信息,请参阅国际化域名

  5. 导航到 DNS 提供程序并创建 CNAME 记录,使子域指向站点的默认域。 例如,如果要使用子域 www.example.com 作为你的用户站点,请创建将 www.example.com 指向 <user>.github.ioCNAME 记录。 如果要使用子域 another.example.com 作为你的组织站点,请创建将 another.example.com 指向 <organization>.github.ioCNAME 记录。 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 的自定义域”。

  6. 打开Git Bash。

  7. 要确认 DNS 记录配置正确,请使用 dig 命令,将 WWW.EXAMPLE.COM 替换为子域。

    1
    2
    3
    4
    5
    $ 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
  8. 如果你使用静态站点生成器在本地构建站点并将生成的文件推送到 GitHub,请将添加 CNAME 文件的提交拉取到本地存储库。 有关详细信息,请参阅“自定义域和 GitHub Pages 疑难解答”。

  9. (可选)若要为站点强制实施 HTTPS 加密,请选择“强制实施 HTTPS”。 可能要过 24 小时才能使用此选项。 有关详细信息,请参阅“使用 HTTPS 保护 GitHub Pages 站点”。

—-