Custom domains and SSL/TLS Certificates

原文：https://docs.gitlab.com/ee/user/project/pages/custom_domains_ssl_tls_certification/

• Set up Pages with a custom domain
  • Requirements
  • Steps
    • 1. Add a custom domain to Pages
    • 2. Get the verification code
    • 3. Set up DNS records for Pages
      • For root domains
      • For subdomains
      • For both root and subdomains
    • 4. Verify the domain’s ownership
      • Troubleshooting Pages domain verification
  • Adding more domain aliases
  • Redirecting www.domain.com to domain.com with Cloudflare
• Adding an SSL/TLS certificate to Pages
  • Requirements
  • Steps
• Force HTTPS for GitLab Pages websites

Custom domains and SSL/TLS Certificates

使用自定义域设置 GitLab 页面，并向其中添加 SSL / TLS 证书，是 GitLab 页面的可选功能.

要将一个或多个自定义域名用于您的 Pages 网站，您可以：

• 添加自定义根域或子域 .
• Add SSL/TLS certification.

Set up Pages with a custom domain

要使用自定义域名设置页面，请阅读以下要求和步骤.

Requirements

• 在默认的 Pages 域（ *.gitlab.io ，对于 GitLab.com）下运行的 GitLab Pages 网站已启动并正在运行.
• 自定义域名example.com或子subdomain.example.com .
• 访问您域的服务器控制面板以设置 DNS 记录：
  • 将您的域指向 GitLab Pages 服务器的 DNS A 或 CNAME 记录.
  • DNS TXT 记录以验证您的域的所有权.

Steps

请按照以下步骤将您的自定义域添加到 Pages. 另请参阅本文档，以获取有关 DNS 记录的概述 .

1. Add a custom domain to Pages

导航到项目的” 设置”>”页面” ，然后单击” +新域”将自定义域添加到 GitLab 页面. 您可以选择是否：

• Add an SSL/TLS certificate.
• 保留为空白（以后可以添加）.

Click 建立新网域.

2. Get the verification code

将新域添加到 Pages 后，系统将提示您输入验证码. 从 GitLab 复制值，并将其作为下一步的 TXT 记录粘贴到您域的控制面板中.

3. Set up DNS records for Pages

阅读本文档以获取 Pages 的 DNS 记录概述 . 如果您熟悉此主题，请根据您要与 Pages 网站一起使用的域类型，按照以下说明进行操作：

• For root domains, example.com.
• For subdomains, subdomain.example.com.
• For both.

注意：您可以在自管实例上配置 IPv6 ，但是 GitLab.com 上的 Pages 当前未配置 IPv6. 有关详细信息，请关注此问题 .

For root domains

根域（ example.com ）要求：

• 指向您的域指向 Pages 服务器的DNS A 记录 .
• TXT 记录以验证您的域的所有权.

对于 GitLab.com 上的项目，此 IP 为35.185.44.232 . 对于位于其他 GitLab 实例（CE 或 EE）中的项目，请联系您的系统管理员以询问此信息（该 IP 地址是实例上运行的 Pages 服务器）.

注意：请注意，如果仅将根域用于 GitLab Pages 网站，并且域注册商支持此功能，则可以添加 DNS 顶点CNAME记录而不是A记录. 这样做的主要优点是，当 GitLab.com 上的 GitLab Pages IP 出于任何原因更改时，您无需更新A记录. 可能会有一些例外，但是不建议使用此方法，因为如果您为根域设置MX记录 ，则该方法很可能不起作用.

For subdomains

子域（ subdomain.example.com ）要求：

• 将您的子域指向 Pages 服务器的 DNS CNAME 记录记录.
• DNS TXT 记录以验证您的域的所有权.

请注意，无论是用户网站还是项目网站， CNAME都应指向您的 Pages 域（ namespace.gitlab.io ），而不包含任何/project-name .

For both root and subdomains

在某些情况下，您需要将子域和根域都指向同一个网站，例如example.com和www.example.com .

他们要求：

• 域的 DNS A 记录.
• 子域的 DNS CNAME 记录.
• 每个 DNS TXT 记录.

如果您使用的是 CloudFlare，请选中使用 Cloudflare 将www.domain.com重定向到domain.com .

Notes:

• 如果要将domain.com指向 GitLab Pages 网站，请不要使用 CNAME 记录. 请改用A记录.
• 不要在默认的 Pages 域之后添加任何特殊字符. 例如，不要将subdomain.domain.com指向或namespace.gitlab.io/ . 但是，某些域托管服务提供商可能会请求结尾点（ namespace.gitlab.io. ）.
• GitLab.com 上的 GitLab Pages IP 在 2017 年进行了更改 .
• GitLab.com 上的 GitLab Pages IP 35.185.44.232 2018 年的 52.167.214.135 更改为52.167.214.135 .

4. Verify the domain’s ownership

添加所有 DNS 记录后：

1. 返回项目的设置>页面 .
2. 找到您的域名，然后单击” 详细信息” .
3. 点击重试验证按钮以激活您的新域.

一旦您的域名启用，您的网站就会通过您的域名可用.

注意：考虑到启用了域验证的 GitLab 实例，如果该域不能在 7 天之内得到验证，它将被从 GitLab 项目中删除.

Notes:

• GitLab.com 用户必须进行域验证； 对于 GitLab 自管实例，您的 GitLab 管理员可以选择禁用自定义域验证 .
• DNS 传播可能需要一些时间（最多 24 小时） ，尽管通常只需几分钟即可完成. 否则，验证将失败，并且尝试访问您的域的尝试将以 404 响应.
• 验证您的域后，请保留验证记录：您的域将定期重新验证，如果删除该记录，则可能会被禁用.

Troubleshooting Pages domain verification

要手动验证您已正确配置了域验证TXT DNS 条目，可以在终端中运行以下命令：

dig _gitlab-pages-verification-code.<YOUR-PAGES-DOMAIN> TXT

期望输出：

;; ANSWER SECTION:
_gitlab-pages-verification-code.<YOUR-PAGES-DOMAIN>. 300 IN TXT "gitlab-pages-verification-code=<YOUR-VERIFICATION-CODE>"

Adding more domain aliases

You can add more than one alias (custom domains and subdomains) to the same project. An alias can be understood as having many doors leading to the same room.

您为网站设置的所有别名都将在” 设置”>”页面”上列出. 在该页面上，您可以查看，添加和删除它们.

Redirecting www.domain.com to domain.com with Cloudflare

如果您使用 Cloudflare，则可以将www重定向到domain.com而无需同时将www.domain.com和domain.com添加到 GitLab.

为此，您可以使用与 CNAME 记录关联的 Cloudflare 的页面规则将www.domain.com重定向到domain.com . 您可以使用以下设置：

1. 在 Cloudflare 中，创建一个 DNS A记录，将domain.com指向35.185.44.232 .
2. 在 GitLab 中，将域添加到 GitLab 页面中并获取验证码.
3. 在 Cloudflare 中，创建 DNS TXT记录以验证您的域.
4. 在 GitLab 中，验证您的域.
5. 在 Cloudflare 中，创建将www指向domain.com的 DNS CNAME记录.
6. 在 Cloudflare 中，添加将www.domain.com指向domain.com的页面规则：
   • 导航到您域的信息中心，然后点击顶部导航栏中的页面规则 .
   • 单击创建页面规则 .
   • 输入域名www.domain.com ，然后点击+添加设置 .
   • 从下拉菜单中，选择转发 URL ，然后选择状态代码301-永久重定向 .
   • 输入目标网址https://domain.com .

Adding an SSL/TLS certificate to Pages

阅读本文档以获取有关 SSL / TLS 认证的概述 .

要使用 GitLab 页面保护您的自定义域，您可以选择：

• 使用Let’s Encrypt 与 GitLab Pages 的集成 ，该集成会自动获取和续订您 Pages 域的 SSL 证书.
• 遵循以下步骤，将 SSL / TLS 证书手动添加到 GitLab Pages 网站.

Requirements

• 可通过自定义域访问 GitLab Pages 网站并正在运行.
• PEM 证书 ：它是由 CA 生成的证书，需要将其添加到字段Certificate（PEM）中 .
• 中间证书 ：（也称为”根证书”），它是标识 CA 的加密密钥链的一部分. 通常，它与 PEM 证书结合在一起，但是在某些情况下，您需要手动添加它们. CloudFlare 证书就是其中一种.
• 私钥 ，这是一个加密密钥，可根据您的域验证您的 PEM.

Steps

• 要在添加新域时添加证书，请转至项目的“设置”>”页面”>”新域” ，添加域名和证书.
• 要将证书添加到先前添加的域中，请转到项目的“设置”>”页面” ，找到您的域名，单击” 详细信息”和” 编辑”以添加证书.

1. 将 PEM 证书添加到其相应的字段.
2. 如果您的证书缺少中间证书，请复制并粘贴根证书（通常可从您的 CA 网站获得），然后将其粘贴到与 PEM 证书相同的字段中 ，只需在它们之间跳过一行即可.
3. 复制您的私钥并将其粘贴到最后一个字段中.

注意： 请勿在常规文本编辑器中打开证书或加密密钥. 始终使用代码编辑器（例如 Sublime Text，Atom，Dreamweaver，括号等）.

Force HTTPS for GitLab Pages websites

在 GitLab 10.7 中引入 .

为了使您的网站访问者更加安全，您可以选择对 GitLab 页面强制使用 HTTPS. 这样，所有通过 HTTP 访问您的网站的尝试都会通过 301 自动重定向到 HTTPS.

它既可以与 GitLab 的默认域一起使用，也可以与您的自定义域一起使用（只要您为其设置了有效的证书）.

要启用此设置：

1. 导航到项目的“设置”>”页面” .
2. 选中” 强制 HTTPS “复选框（需要有效的证书） .

注意：如果在 GitLab 页面前面使用 CloudFlare CDN，请确保将 SSL 连接设置设置为full而不是flexible . 有关更多详细信息，请参阅CloudFlare CDN 指导 .