Note: This feature was first introduced in GitSwarm 2016.1. Custom CNAMEs with TLS support were introduced in GitSwarm 2016.2.
This document describes how to set up the latest GitSwarm Pages feature. Make sure to read the changelog if you are upgrading to a new GitSwarm version as it may include new features and changes needed to be made in your configuration.
If you are looking for ways to upload your static content in GitSwarm Pages, you probably want to read the user documentation.
Table of Contents generated with DocToc
Starting from GitSwarm 2016.2, GitSwarm Pages make use of the [GitSwarm 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. The GitSwarm Pages Daemon supports dynamic certificates through SNI and exposes pages using HTTP2 by default.
Here is a brief list with what it is supported when using the pages daemon:
You are encouraged to read its README to fully understand how it works.
In the case of custom 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, so you basically have three choices:
In this document, we will proceed assuming the first option. Let's begin by installing the pages daemon.
Source installations
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 v0.2.1
sudo -u git -H makepackage installations
The gitlab-pages daemon is included in the package installation.
There are multiple ways to set up GitSwarm Pages according to what URL scheme you are willing to support.
In the next section you will find all possible scenarios to choose from.
In either scenario, you will need:
Before proceeding with setting up GitSwarm Pages, you have to decide which route you want to take.
The possible scenarios are depicted in the table below.
| URL scheme | Option | Wildcard certificate | Custom domain with HTTP support | Custom domain with HTTPS support | Secondary IP | |
|---|---|---|---|---|---|---|
http://page.example.io |
1 | no | no | no | no | |
https://page.example.io |
1 | yes | no | no | no | |
http://page.example.io and http://page.com |
2 | no | yes | no | yes | |
https://page.example.io and https://page.com |
2 | yes | redirects to HTTPS | yes | yes |
As you see from the table above, each URL scheme comes with an option:
GitSwarm 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 GitSwarm runs. For example, an entry would look like this:
*.example.io. 1800 IN A 1.2.3.4where example.io is the domain under which GitSwarm Pages will be served and 1.2.3.4 is the IP address of your GitSwarm instance.
You should not use the GitSwarm domain to serve user pages. For more information see the security section.
Below are the four scenarios that are described in #configuration-scenarios.
Source installations:
Edit gitlab.yml to look like the example below. You need to change the host to the FQDN under which GitSwarm Pages will be served. Set external_http and external_https to the secondary IP on which the pages daemon will listen for connections:
```yaml ## GitSwarm 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: 1.1.1.1:80 external_https: 1.1.1.1:443 ```
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 1.1.1.1:80 -listen-https 1.1.1.1:443 -root-cert /path/to/example.io.crt -root-key /path/to/example.io.keypackage installations:
Edit /etc/gitswarm/gitswarm.rb:
pages_external_url "https://example.io"
nginx['listen_addresses'] = ['1.1.1.1']
pages_nginx['enable'] = false
gitlab_pages['cert'] = "/etc/gitswarm/ssl/example.io.crt"
gitlab_pages['cert_key'] = "/etc/gitswarm/ssl/example.io.key"
gitlab_pages['external_http'] = '1.1.1.2:80'
gitlab_pages['external_https'] = '1.1.1.2:443'where 1.1.1.1 is the primary IP address that GitSwarm is listening to and 1.1.1.2 the secondary IP where the GitSwarm Pages daemon listens to. Read more at the NGINX configuration for custom domains section.
Source installations:
Edit gitlab.yml to look like the example below. You need to change the host to the FQDN under which GitSwarm Pages will be served. Set external_http to the secondary IP on which the pages daemon will listen for connections:
```yaml pages: enabled: true # The location where pages are stored (default: shared/pages). # path: shared/pages
host: example.io port: 80 https: false
external_http: 1.1.1.1:80 ```
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 1.1.1.1:80"package installations:
Edit /etc/gitswarm/gitswarm.rb:
pages_external_url "https://example.io"
nginx['listen_addresses'] = ['1.1.1.1']
pages_nginx['enable'] = false
gitlab_pages['external_http'] = '1.1.1.2:80'where 1.1.1.1 is the primary IP address that GitSwarm is listening to and 1.1.1.2 the secondary IP where the GitSwarm Pages daemon listens to. Read more at the NGINX configuration for custom domains section.
Source installations:
Go to the GitLab installation directory:
bash cd /home/git/gitlab
Edit gitlab.yml and under the pages setting, set enabled to true and the host to the FQDN under which GitSwarm Pages will be served:
```yaml ## GitSwarm Pages pages: enabled: true # The location where pages are stored (default: shared/pages). # path: shared/pages
host: example.io port: 80 https: false ```
package installations:
Set the external URL for GitSwarm Pages in /etc/gitswarm/gitswarm.rb:
pages_external_url 'http://example.io'Source installations:
In gitlab.yml, set the port to 443 and https to true:
```bash ## GitSwarm Pages pages: enabled: true # The location where pages are stored (default: shared/pages). # path: shared/pages
host: example.io port: 443 https: true ```
Make sure to configure NGINX properly.
package installations:
/etc/gitswarm/sslIn /etc/gitswarm/gitswarm.rb specify the following configuration:
pages_external_url 'https://example.io'
pages_nginx['redirect_http_to_https'] = true
pages_nginx['ssl_certificate'] = "/etc/gitswarm/ssl/pages-nginx.crt"
pages_nginx['ssl_certificate_key'] = "/etc/gitswarm/ssl/pages-nginx.key"where pages-nginx.crt and pages-nginx.key are the SSL cert and key, respectively.
Depending on your setup, you will need to make some changes to NGINX. Specifically you must change the domain name and the IP address where NGINX listens to. Read the following sections for more details.
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.confReplace gitlab-pages-ssl with gitlab-pages if you are not using SSL.
If you are not using custom domains ignore this section.
In the case of custom domains, if you have the secondary IP address configured on the same server as GitSwarm, you need to change all NGINX configs to listen on the first IP address.
Source installations:
/etc/nginx/site-available/ and replace 0.0.0.0 with 1.1.1.1, where 1.1.1.1 the primary IP where GitSwarm listens to.package installations:
Edit /etc/gitswarm/gilab.rb:
nginx['listen_addresses'] = ['1.1.1.1']Be extra careful when setting up the domain name in the NGINX config. You must not remove the backslashes.
If your GitSwarm 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$;The maximum size of the unpacked archive per project can be configured in the Admin area under the Application settings in the Maximum size of pages (MB). The default is 100MB.
Source installations:
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:
yaml pages: enabled: true # The location where pages are stored (default: shared/pages). path: /mnt/storage/pages
package installations:
Pages are stored by default in /var/opt/gitswarm/gitlab-rails/shared/pages. If you wish to store them in another location you must set it up in /etc/gitswarm/gitswarm.rb:
ruby gitlab_rails['pages_path'] = "/mnt/storage/pages"
Pages are part of the regular backup so there is nothing to configure.
You should strongly consider running GitSwarm pages under a different hostname than GitSwarm to prevent XSS attacks.
GitSwarm Pages were first introduced in GitSwarm 2016.1. Since then, many features where added, like custom CNAME and TLS support, and many more are likely to come. Below is a brief changelog. If no changes were introduced or a version is missing from the changelog, assume that the documentation is the same as the latest previous version.
GitSwarm 2016.2 (documentation)
GitSwarm 2016.1
No new changes.
GitSwarm 2016.1 (source docs, Omnibus docs)