Commit 478d9e9b authored by Marcia Ramos's avatar Marcia Ramos Committed by Achilleas Pipinellis
Browse files

Docs: Let's Encrypt certificate for GitLab Pages

parent f454e1535982
......@@ -234,26 +234,25 @@ reiterating the importance of HTTPS.
## Issuing Certificates
GitLab Pages accepts [PEM]( certificates issued by
[Certificate Authorities (CA)](
and self-signed certificates. Of course,
[you'd rather issue a certificate than generate a self-signed](,
for security reasons and for having browsers trusting your
site's certificate.
There are several different kinds of certificates, each one
with certain security level. A static personal website will
GitLab Pages accepts certificates provided in the [PEM]( format, issued by
[Certificate Authorities (CAs)]( or as
[self-signed certificates]( Note that [self-signed certificates are typically not used](
for public websites for security reasons and to ensure that browsers trust your site's certificate.
There are various kinds of certificates, each one
with a certain security level. A static personal website will
not require the same security level as an online banking web app,
for instance. There are a couple Certificate Authorities that
for instance.
There are some certificate authorities that
offer free certificates, aiming to make the internet more secure
to everyone. The most popular is [Let's Encrypt](,
which issues certificates trusted by most of browsers, it's open
source, and free to use. Please read through this tutorial to
understand [how to secure your GitLab Pages website with Let's Encrypt](
source, and free to use. See our tutorial on [how to secure your GitLab Pages website with Let's Encrypt](
With the same popularity, there are [certificates issued by CloudFlare](,
Similarly popular are [certificates issued by CloudFlare](,
which also offers a [free CDN service](
Their certs are valid up to 15 years. Read through the tutorial on
Their certs are valid up to 15 years. See the tutorial on
[how to add a CloudFlare Certificate to your GitLab Pages website](
### Adding certificates to your project
......@@ -170,7 +170,7 @@ optionally secure it with SSL/TLS certificates. You can read the following
tutorials to learn how to use these third-party certificates with GitLab Pages:
- [CloudFlare](
- [Let's Encrypt]( (mind that although this article is out-of-date, it can still be useful to guide you through the basic steps)
- [Let's Encrypt](
## Advanced use
description: "How to secure GitLab Pages websites with Let's Encrypt."
# Let's Encrypt for GitLab Pages
If you have a GitLab Pages website served under your own domain,
you might want to secure it with a SSL/TSL certificate.
[Let's Encrypt]( is a free, automated, and
open source Certificate Authority.
## Requirements
To follow along with this tutorial, we assume you already have:
- Created a [project]( in GitLab which
contains your website's source code.
- Acquired a domain (``) and added a [DNS entry](
pointing it to your Pages website.
- [Added your domain to your Pages project](
and verified your ownership.
- Cloned your project into your computer.
- Your website up and running, served under HTTP protocol at ``.
## Obtaining a Let's Encrypt certificate
Once you have the requirements addressed, follow the instructions
below to learn how to obtain the certificate.
NOTE: **Note:**
The instructions below were tested on macOS Mojave. For other
operating systems the steps might be slightly different. Follow the
[CertBot instructions]( according to your OS.
1. On your computer, open a terminal and navigate to your repository's
root directory:
cd path/to/dir
1. Install CertBot (the tool Let's Encrypt uses to issue certificates):
brew install certbot
1. Request a certificate for your domain (``) and
provide an email account (``) to receive notifications:
sudo certbot certonly -a manual -d --email
Alternatively, you can register without adding an e-mail account,
but you won't be notified about the certificate expiration's date:
sudo certbot certonly -a manual -d --register-unsafely-without-email
TIP: **Tip:**
Read through CertBot's documentation on their
[command line options](
1. You'll be prompted with a message to agree with their terms.
Press `A` to agree and `Y` to let they log your IP.
CertBot will then prompt you with the following message:
Create a file containing just this data:
And make it available on your web server at this URL:
Press Enter to Continue
1. **Do not press Enter yet.** Let's Encrypt will need to verify your
domain ownership before issuing the certificate. To do so, create 3
consecutive directories under your website's root:
and add to the last folder an `index.html` file containing the content
referred on the previous prompt message:
Note that this file needs to be accessed under
to allow Let's Encrypt to verify the ownership of your domain,
therefore, it needs to be part of the website content under the
repo's [`public`]( folder.
1. Add, commit, and push the file into your repo in GitLab. Once the pipeline
passes, press **Enter** on your terminal to continue issuing your
certificate. CertBot will then prompt you with the following message:
Waiting for verification...
Cleaning up challenges
- Congratulations! Your certificate and chain have been saved at:
Your key file has been saved at:
Your cert will expire on 2019-03-12. To obtain a new or tweaked
version of this certificate in the future, simply run certbot
again. To non-interactively renew *all* of your certificates, run
"certbot renew"
- If you like Certbot, please consider supporting our work by:
Donating to ISRG / Let's Encrypt:
Donating to EFF:
## Add your certificate to GitLab Pages
Now that your certificate has been issued, let's add it to your Pages site:
1. Back at GitLab, navigate to your project's **Settings > Pages**,
find your domain and click **Details** and **Edit** to add your certificate.
1. From your terminal, copy and paste the certificate into the first field
**Certificate (PEM)**:
sudo cat /etc/letsencrypt/live/ | pbcopy
1. Copy and paste the public key into the second field **Key (PEM)**:
sudo cat /etc/letsencrypt/live/ | pbcopy
1. Click **Save changes** to apply them to your website.
1. Wait a few minutes for DNS propagation.
1. Visit your website at ``.
To force `https` connections on your site, navigate to your
project's **Settings > Pages** and check **Force domains with SSL
certificates to use HTTPS**.
## Renewal
Let's Encrypt certificates expire every 90 days and you'll have to
renew them periodically. To renew all your certificates at once, run:
sudo certbot renew
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment