The GitLab Development Kit (GDK) installs a GitLab instance on your workstation. GDK can manage GitLab requirements, such as development tools and databases.
The GDK is recommended for anyone contributing to the GitLab codebase, whether a GitLab team member or a member of the wider community. It allows you to test your changes locally on your workstation in an isolated manner. This can speed up the time it takes to make successful contributions.
- Provide developer tooling to install, update, and develop against a local GitLab instance.
- Offer GDK users an automated method for installing required software.
- Only manage projects, software, and services that may be needed to run a GitLab instance.
- Out of the box, only enable the services GitLab strictly requires to operate.
- Support native operating systems as listed below.
You can install GDK using the following methods. Some are:
- Supported and frequently tested.
- Not supported, but we welcome merge requests to improve them.
The following installation methods are supported, actively maintained, and tested:
- One-line installation
- Simple installation on your local system. Requires at least 8GB RAM and 12GB disk space. Available for supported platforms.
- Gitpod.
| Operating system | Versions |
|---|---|
| macOS | 12, 11, 10.15 |
| Ubuntu | 22.04 (1), 21.10, 20.04, 18.04 |
| Fedora | 36 (1), 35 |
| Debian | 11, 10, 9 |
| Arch | latest |
| Manjaro | latest |
(1) Requires manual installation of OpenSSL 1.1.1.
The following documentation is provided for those who can benefit from it, but aren't supported installation methods:
- Advanced installation on your local system. Requires at least 8GB RAM and 12GB disk space.
- Vagrant.
- Minikube.
- We encourage you to create a new issue.
- GitLab team members can use the
#gdkchannel on the GitLab Slack workspace. - Review the troubleshooting information.
- Wider community members can use the Gitter contributors room or GitLab Forum.
Contributions are welcome; see CONTRIBUTING.md
for more details.
Please refer to our Lefthook Howto page.
The GitLab Development Kit is distributed under the MIT license; see the LICENSE file.