How to use GitLab Development Kit
NGINX

NGINX

Installing and configuring NGINX allows you to enable HTTPS (with SSL/TLS), HTTP/2 as well as greater flexibility around HTTP routing.

Install dependencies

You need to install NGINX:

# on macOS
brew install nginx

# on Debian/Ubuntu
apt install nginx

# on Fedora
yum install nginx

Versions of NGINX packaged with some Linux distributions might not work. You should install the Homebrew version of NGINX using the official NGINX installation.

Add entry to /etc/hosts

To be able to use a hostname instead of IP address, add a line to /etc/hosts.

echo '127.0.0.1 gdk.test' | sudo tee -a /etc/hosts

gdk.test (or anything ending in .test) is recommended as .test is a reserved TLD for testing software.

Configuring a loopback device (optional)

Note

You can skip this step unless you need a runner under Docker.

If you want an isolated network space for all the services of your GDK, you can add a loopback network interface.

Update gdk.yml

Place the following settings in your gdk.yml:

---
hostname: gdk.test
nginx:
  enabled: true
  http:
    enabled: true

Update gdk.yml for HTTPS (optional)

Place the following settings in your gdk.yml:

---
hostname: gdk.test
port: 3443
https:
  enabled: true
nginx:
  enabled: true
  ssl:
    certificate: gdk.test.pem
    key: gdk.test-key.pem

Generate certificate

mkcert is needed to generate certificates. Check out their installation instructions for all the different platforms.

On macOS, install with brew:

brew install mkcert nss
mkcert -install

Using mkcert you can generate a self-signed certificate. It also ensures your browser and OS trust the certificate.

mkcert gdk.test

On Linux (e.g. GDK-in-a-box), you’ll need sudo to install mkcert’s generated CA certificate in the system’s trust store (/usr/local/share/ca-certificates). Also, you need to preserve your user’s HOME environment variable so it will install the rootCA.pem from your $HOME, not /root.

sudo --preserve-env=HOME mkcert -install

Update gdk.yml for HTTP/2 (optional)

Place the following settings in your gdk.yml:

---
hostname: gdk.test
port: 3443
https:
  enabled: true
nginx:
  enabled: true
  http2:
    enabled: true
  ssl:
    certificate: <path/to/file/gdk.test.pem>
    key: <path/to/file/gdk.test-key.pem>

Configure GDK

Run the following to apply these changes:

gdk reconfigure
gdk restart

Run

GitLab should now be available for:

GitLab Docs should now be available for:

Troubleshooting

nginx: invalid option: "e"

NGINX v1.19 supports the -e flag, but v1.18 does not. If you encounter this error, use NGINX’s repositories to install the latest package instead of the one shipped with your distribution.

Last updated on
NFSObject storage