Set up Pages with a custom domain
- Adding more domain aliases
- Adding an SSL/TLS certificate to Pages
- Force HTTPS for GitLab Pages websites
Setting up GitLab Pages with custom domains, and adding SSL/TLS certificates to them, are optional features of GitLab Pages.
To use one or more custom domain names with your Pages site, you can:
To set up Pages with a custom domain name, read the requirements and steps below.
- A GitLab Pages website up and running, served under the default Pages domain
*.gitlab.io, for GitLab.com).
- A custom domain name
- Access to your domain’s server control panel to set up DNS records:
- A DNS A or CNAME record pointing your domain to GitLab Pages server.
- A DNS
TXTrecord to verify your domain’s ownership.
/etc/gitlab/gitlab.rbto the IP and port of your Pages Daemon. If you don’t have IPv6, you can omit the IPv6 address.
# Redirect pages from HTTP to HTTPS gitlab_pages['external_http'] = ['192.0.2.2:80', '[2001:db8::2]:80'] # The secondary IPs for the GitLab Pages daemon gitlab_pages['external_https'] = ['192.0.2.2:443', '[2001:db8::2]:443'] # The secondary IPs for the GitLab Pages daemon
Follow the steps below to add your custom domain to Pages. See also this document for an overview on DNS records.
Navigate to your project’s Setting > Pages and click + New domain to add your custom domain to GitLab Pages. You can choose whether to:
- Add an SSL/TLS certificate.
- Leave it blank (it can be added later).
Click Create New Domain.
After you add a new domain to Pages, the verification code prompts you. Copy the values from GitLab
and paste them in your domain’s control panel as a
TXT record on the next step.
Read this document for an overview of DNS records for Pages. If you’re familiar with the subject, follow the instructions below according to the type of domain you want to use with your Pages site:
Root domains (
- A DNS A record pointing your domain to the Pages server.
- A TXT record to verify your domain’s ownership.
For projects on GitLab.com, this IP is
For projects living in other GitLab instances (CE or EE), please contact
your sysadmin asking for this information (which IP address is Pages
server running on your instance).
CNAMErecord instead of an
Arecord. The main advantage of doing so is that when GitLab Pages IP on GitLab.com changes for whatever reason, you don’t need to update your
Arecord. There may be a few exceptions, but this method is not recommended as it most likely doesn’t work if you set an
MXrecord for your root domain.
- A DNS CNAME record pointing your subdomain to the Pages server.
- A DNS TXT record to verify your domain’s ownership.
Note that, whether it’s a user or a project website, the
should point to your Pages domain (
There are a few cases where you need to point both the subdomain and root
domain to the same website, for instance,
- A DNS A record for the domain.
- A DNS CNAME record for the subdomain.
- A DNS
TXTrecord for each.
If you’re using Cloudflare, check
domain.com with Cloudflare.
Do not use a CNAME record if you want to point your
domain.comto your GitLab Pages site. Use an
Do not add any special chars after the default Pages
domain. For example, don’t point
namespace.gitlab.io/. Some domain hosting providers may request a trailing dot (
- GitLab Pages IP on GitLab.com was changed in 2017.
- GitLab Pages IP on GitLab.com has changed
Once you have added all the DNS records:
- Go back at your project’s Settings > Pages.
- Locate your domain name and click Details.
- Click the Retry verification button to activate your new domain.
As soon as your domain becomes active, your website is available through your domain name.
- Domain verification is required for GitLab.com users; for GitLab self-managed instances, your GitLab administrator has the option to disabled custom domain verification.
- DNS propagation may take some time (up to 24h), although it’s usually a matter of minutes to complete. Until it does, verification fails, and attempts to visit your domain result in a 404.
- Once your domain has been verified, leave the verification record in place. Your domain is periodically reverified, and may be disabled if the record is removed.
To manually verify that you have properly configured the domain verification
TXT DNS entry, you can run the following command in your terminal:
dig _gitlab-pages-verification-code.<YOUR-PAGES-DOMAIN> TXT
Expect the output:
;; ANSWER SECTION: _gitlab-pages-verification-code.<YOUR-PAGES-DOMAIN>. 300 IN TXT "gitlab-pages-verification-code=<YOUR-VERIFICATION-CODE>"
In some cases it can help to add the verification code with the same domain name as you are trying to register.
For a root domain:
For a subdomain:
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.
All the aliases you’ve set to your site are listed on Setting > Pages. From that page, you can view, add, and remove them.
If you use Cloudflare, you can redirect
without adding both
domain.com to GitLab.
To do so, you can use Cloudflare’s page rules associated to a
CNAME record to redirect
can use the following setup:
- In Cloudflare, create a DNS
- In GitLab, add the domain to GitLab Pages and get the verification code.
- In Cloudflare, create a DNS
TXTrecord to verify your domain.
- In GitLab, verify your domain.
- In Cloudflare, create a DNS
- In Cloudflare, add a Page Rule pointing
- Navigate to your domain’s dashboard and click Page Rules on the top nav.
- Click Create Page Rule.
- Enter the domain
www.domain.comand click + Add a Setting.
- From the dropdown menu, choose Forwarding URL, then select the status code 301 - Permanent Redirect.
- Enter the destination URL
Read this document for an overview on SSL/TLS certification.
To secure your custom domain with GitLab Pages you can opt by:
- Using the Let’s Encrypt integration with GitLab Pages, which automatically obtains and renews SSL certificates for your Pages domains.
- Manually adding SSL/TLS certificates to GitLab Pages websites by following the steps below.
You can use any certificate satisfying the following requirements:
- A GitLab Pages website up and running accessible via a custom domain.
- A PEM certificate: it is the certificate generated by the CA, which needs to be added to the field Certificate (PEM).
- An intermediate certificate: (aka “root certificate”), it is the part of the encryption keychain that identifies the CA. Usually it’s combined with the PEM certificate, but there are some cases in which you need to add them manually. Cloudflare certs are one of these cases.
- A private key, it’s an encrypted key which validates your PEM against your domain.
For example, Cloudflare certificates meet these requirements.
- To add the certificate at the time you add a new domain, go to your project’s Settings > Pages > New Domain, add the domain name and the certificate.
- To add the certificate to a domain previously added, go to your project’s Settings > Pages, locate your domain name, click Details and Edit to add the certificate.
- Add the PEM certificate to its corresponding field.
- If your certificate is missing its intermediate, copy and paste the root certificate (usually available from your CA website) and paste it in the same field as your PEM certificate, just jumping a line between them.
- Copy your private key and paste it in the last field.
Do not open certificates or encryption keys in regular text editors. Always use code editors (such as Sublime Text, Atom, Dreamweaver, Brackets, etc).
To make your website’s visitors even more secure, you can choose to force HTTPS for GitLab Pages. By doing so, all attempts to visit your website through HTTP are automatically redirected to HTTPS through 301.
It works with both the GitLab default domain and with your custom domain (as long as you’ve set a valid certificate for it).
To enable this setting:
- Navigate to your project’s Settings > Pages.
- Tick the checkbox Force HTTPS (requires valid certificates).
If you use Cloudflare CDN in front of GitLab Pages, make sure to set the SSL connection setting to
full instead of
flexible. For more details, see the Cloudflare CDN directions.