gitlab-org--gitlab-foss/doc/administration/pages/source.md

stage	group	info
Release	Release Management	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers

GitLab Pages administration for source installations

NOTE: Note: Before attempting to enable GitLab Pages, first make sure you have installed GitLab successfully.

This is the documentation for configuring a GitLab Pages when you have installed GitLab from source and not using the Omnibus packages.

You are encouraged to read the Omnibus documentation as it provides some invaluable information to the configuration of GitLab Pages. Please proceed to read it before going forward with this guide.

We also highly recommend that you use the Omnibus GitLab packages, as we optimize them specifically for GitLab, and we will take care of upgrading GitLab Pages to the latest supported version.

Overview

GitLab Pages makes use of the GitLab Pages daemon, a simple HTTP server written in Go that can listen on an external IP address and provide support for custom domains and custom certificates. It supports dynamic certificates through SNI and exposes pages using HTTP2 by default. You are encouraged to read its README to fully understand how it works.

In the case of custom domains (but not wildcard domains), the Pages daemon needs to listen on ports 80 and/or 443. For that reason, there is some flexibility in the way which you can set it up:

1. Run the Pages daemon in the same server as GitLab, listening on a secondary IP.
2. Run the Pages daemon in a separate server. In that case, the Pages path must also be present in the server that the Pages daemon is installed, so you will have to share it via network.
3. Run the Pages daemon in the same server as GitLab, listening on the same IP but on different ports. In that case, you will have to proxy the traffic with a load balancer. If you choose that route note that you should use TCP load balancing for HTTPS. If you use TLS-termination (HTTPS-load balancing) the pages will not be able to be served with user provided certificates. For HTTP it's OK to use HTTP or TCP load balancing.

In this document, we will proceed assuming the first option. If you are not supporting custom domains a secondary IP is not needed.

Prerequisites

Before proceeding with the Pages configuration, make sure that:

1. You have a separate domain under which GitLab Pages will be served. In this document we assume that to be example.io.
2. You have configured a wildcard DNS record for that domain.
3. You have installed the zip and unzip packages in the same server that GitLab is installed since they are needed to compress and decompress the Pages artifacts.
4. (Optional) You have a wildcard certificate for the Pages domain if you decide to serve Pages (*.example.io) under HTTPS.
5. (Optional but recommended) You have configured and enabled the shared runners so that your users don't have to bring their own.

DNS configuration

GitLab Pages expect to run on their own virtual host. In your DNS server/provider you need to add a wildcard DNS A record pointing to the host that GitLab runs. For example, an entry would look like this:

*.example.io. 1800 IN A 192.0.2.1

where example.io is the domain under which GitLab Pages will be served and 192.0.2.1 is the IP address of your GitLab instance.

NOTE: Note: You should not use the GitLab domain to serve user pages. For more information see the security section.

Configuration

Depending on your needs, you can set up GitLab Pages in 4 different ways. The following options are listed from the easiest setup to the most advanced one. The absolute minimum requirement is to set up the wildcard DNS since that is needed in all configurations.

Wildcard domains

Requirements:

• Wildcard DNS setup

URL scheme: http://<namespace>.example.io/<project_slug>

This is the minimum setup that you can use Pages with. It is the base for all other setups as described below. NGINX will proxy all requests to the daemon. The Pages daemon doesn't listen to the outside world.

1. Install the Pages daemon:

   cd /home/git
   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
   cd gitlab-pages
   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
   sudo -u git -H make
   

2. Go to the GitLab installation directory:

   cd /home/git/gitlab
   

3. Edit gitlab.yml and under the pages setting, set enabled to true and the host to the FQDN under which GitLab Pages will be served:

   ## GitLab Pages
   pages:
     enabled: true
     # The location where pages are stored (default: shared/pages).
     # path: shared/pages
   
     host: example.io
     port: 80
     https: false
   

4. Edit /etc/default/gitlab and set gitlab_pages_enabled to true in order to enable the pages daemon. In gitlab_pages_options the -pages-domain must match the host setting that you set above.

   gitlab_pages_enabled=true
   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090"
   

5. Copy the gitlab-pages NGINX configuration file:

   sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages.conf
   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
   

6. Restart NGINX

7. Restart GitLab

Wildcard domains with TLS support

Requirements:

• Wildcard DNS setup
• Wildcard TLS certificate

URL scheme: https://<namespace>.example.io/<project_slug>

NGINX will proxy all requests to the daemon. Pages daemon doesn't listen to the outside world.

1. Install the Pages daemon:

   cd /home/git
   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
   cd gitlab-pages
   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
   sudo -u git -H make
   

2. In gitlab.yml, set the port to 443 and https to true:

   ## GitLab Pages
   pages:
     enabled: true
     # The location where pages are stored (default: shared/pages).
     # path: shared/pages
   
     host: example.io
     port: 443
     https: true
   

3. Edit /etc/default/gitlab and set gitlab_pages_enabled to true in order to enable the pages daemon. In gitlab_pages_options the -pages-domain must match the host setting that you set above. The -root-cert and -root-key settings are the wildcard TLS certificates of the example.io domain:

   gitlab_pages_enabled=true
   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.key"
   

4. Copy the gitlab-pages-ssl NGINX configuration file:

   sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages-ssl.conf
   

5. Restart NGINX

6. Restart GitLab

Advanced configuration

In addition to the wildcard domains, you can also have the option to configure GitLab Pages to work with custom domains. Again, there are two options here: support custom domains with and without TLS certificates. The easiest setup is that without TLS certificates.

Custom domains

Requirements:

• Wildcard DNS setup
• Secondary IP

URL scheme: http://<namespace>.example.io/<project_slug> and http://custom-domain.com

In that case, the pages daemon is running, NGINX still proxies requests to the daemon but the daemon is also able to receive requests from the outside world. Custom domains are supported, but no TLS.

1. Install the Pages daemon:

   cd /home/git
   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
   cd gitlab-pages
   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
   sudo -u git -H make
   

2. Edit gitlab.yml to look like the example below. You need to change the host to the FQDN under which GitLab Pages will be served. Set external_http to the secondary IP on which the pages daemon will listen for connections:

   pages:
     enabled: true
     # The location where pages are stored (default: shared/pages).
     # path: shared/pages
   
     host: example.io
     port: 80
     https: false
   
     external_http: 192.0.2.2:80
   

3. Edit /etc/default/gitlab and set gitlab_pages_enabled to true in order to enable the pages daemon. In gitlab_pages_options the -pages-domain and -listen-http must match the host and external_http settings that you set above respectively:

   gitlab_pages_enabled=true
   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -listen-http 192.0.2.2:80"
   

4. Copy the gitlab-pages-ssl NGINX configuration file:

   sudo cp lib/support/nginx/gitlab-pages /etc/nginx/sites-available/gitlab-pages.conf
   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages.conf
   

5. Edit all GitLab related configurations in /etc/nginx/site-available/ and replace 0.0.0.0 with 192.0.2.1, where 192.0.2.1 the primary IP where GitLab listens to.

6. Restart NGINX

7. Restart GitLab

Custom domains with TLS support

Requirements:

• Wildcard DNS setup
• Wildcard TLS certificate
• Secondary IP

URL scheme: https://<namespace>.example.io/<project_slug> and https://custom-domain.com

In that case, the pages daemon is running, NGINX still proxies requests to the daemon but the daemon is also able to receive requests from the outside world. Custom domains and TLS are supported.

1. Install the Pages daemon:

   cd /home/git
   sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git
   cd gitlab-pages
   sudo -u git -H git checkout v$(</home/git/gitlab/GITLAB_PAGES_VERSION)
   sudo -u git -H make
   

2. Edit gitlab.yml to look like the example below. You need to change the host to the FQDN under which GitLab Pages will be served. Set external_http and external_https to the secondary IP on which the pages daemon will listen for connections:

   ## GitLab Pages
   pages:
     enabled: true
     # The location where pages are stored (default: shared/pages).
     # path: shared/pages
   
     host: example.io
     port: 443
     https: true
   
     external_http: 192.0.2.2:80
     external_https: 192.0.2.2:443
   

3. Edit /etc/default/gitlab and set gitlab_pages_enabled to true in order to enable the pages daemon. In gitlab_pages_options the -pages-domain, -listen-http and -listen-https must match the host, external_http and external_https settings that you set above respectively. The -root-cert and -root-key settings are the wildcard TLS certificates of the example.io domain:

   gitlab_pages_enabled=true
   gitlab_pages_options="-pages-domain example.io -pages-root $app_root/shared/pages -listen-proxy 127.0.0.1:8090 -listen-http 192.0.2.2:80 -listen-https 192.0.2.2:443 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.key"
   

4. Copy the gitlab-pages-ssl NGINX configuration file:

   sudo cp lib/support/nginx/gitlab-pages-ssl /etc/nginx/sites-available/gitlab-pages-ssl.conf
   sudo ln -sf /etc/nginx/sites-{available,enabled}/gitlab-pages-ssl.conf
   

5. Edit all GitLab related configurations in /etc/nginx/site-available/ and replace 0.0.0.0 with 192.0.2.1, where 192.0.2.1 the primary IP where GitLab listens to.

6. Restart NGINX

7. Restart GitLab

NGINX caveats

NOTE: Note: The following information applies only for installations from source.

Be extra careful when setting up the domain name in the NGINX configuration. You must not remove the backslashes.

If your GitLab Pages domain is example.io, replace:

server_name ~^.*\.YOUR_GITLAB_PAGES\.DOMAIN$;

with:

server_name ~^.*\.example\.io$;

If you are using a subdomain, make sure to escape all dots (.) except from the first one with a backslash (). For example pages.example.io would be:

server_name ~^.*\.pages\.example\.io$;

Access control

Introduced in GitLab 11.5.

GitLab Pages access control can be configured per-project, and allows access to a Pages site to be controlled based on a user's membership to that project.

Access control works by registering the Pages daemon as an OAuth application with GitLab. Whenever a request to access a private Pages site is made by an unauthenticated user, the Pages daemon redirects the user to GitLab. If authentication is successful, the user is redirected back to Pages with a token, which is persisted in a cookie. The cookies are signed with a secret key, so tampering can be detected.

Each request to view a resource in a private site is authenticated by Pages using that token. For each request it receives, it makes a request to the GitLab API to check that the user is authorized to read that site.

From GitLab 12.8 onward, Access Control parameters for Pages are set in a configuration file, which by convention is named gitlab-pages-config. The configuration file is passed to pages using the -config flag or CONFIG environment variable.

Pages access control is disabled by default. To enable it:

1. Modify your config/gitlab.yml file:

   pages:
     access_control: true
   

2. Restart GitLab.

3. Create a new system OAuth application. This should be called GitLab Pages and have a Redirect URL of https://projects.example.io/auth. It does not need to be a "trusted" application, but it does need the api scope.

4. Start the Pages daemon by passing a configuration file with the following arguments:

     auth-client-id=<OAuth Application ID generated by GitLab>
     auth-client-secret=<OAuth code generated by GitLab>
     auth-redirect-uri='http://projects.example.io/auth'
     auth-secret=<40 random hex characters>
     auth-server=<URL of the GitLab instance>
   

5. Users can now configure it in their projects' settings.

Change storage path

Follow the steps below to change the default path where GitLab Pages' contents are stored.

1. Pages are stored by default in /home/git/gitlab/shared/pages. If you wish to store them in another location you must set it up in gitlab.yml under the pages section:

   pages:
     enabled: true
     # The location where pages are stored (default: shared/pages).
     path: /mnt/storage/pages
   

2. Restart GitLab

Set maximum Pages size

The maximum size of the unpacked archive per project can be configured in Admin Area > Settings > Preferences > Pages, in Maximum size of pages (MB). The default is 100MB.

Backup

Pages are part of the regular backup so there is nothing to configure.

Security

You should strongly consider running GitLab Pages under a different hostname than GitLab to prevent XSS attacks.