1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review.
---
# Install the GDK development environment
If you want to contribute to the GitLab codebase and want a development environment in which to test
your changes, you can use [the GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit),
a local version of GitLab that's yours to play with.
The GDK is a local development environment that includes an installation of self-managed GitLab,
sample projects, and administrator access with which you can test functionality.
If you prefer to use GDK in a local virtual machine, use the steps in [Configure GDK-in-a-box](configure-dev-env-gdk-in-a-box.md)
[View an interactive demo of this step](https://gitlab.navattic.com/xtk20s8x).
## Install and configure GitLab Development Kit (GDK)
If you already have a working GDK,
[update it to use the community fork](#update-an-existing-gdk-installation).
Set aside about two hours to install the GDK. If all goes smoothly, it
should take about an hour to install.
Sometimes the installation needs some tweaks to make it work, so you should
also set aside some time for troubleshooting.
It might seem like a lot of work, but after you have the GDK running,
you'll be able to make any changes.
To install the GDK:
1. Ensure you're on
[one of the supported platforms](https://gitlab.com/gitlab-org/gitlab-development-kit/-/tree/main/#supported-platforms).
1. Confirm that [Git](../../../topics/git/how_to_install_git/index.md) is installed,
and that you have a source code editor.
1. Choose the directory where you want to install the GDK.
The installation script installs the application to a new subdirectory called `gitlab-development-kit`.
Keep the directory name short. Some users encounter issues with long directory names.
1. From the command line, go to that directory.
In this example, create and change to the `dev` directory:
```shell
mkdir ~/dev && cd "$_"
```
1. Run the one-line installation command:
```shell
curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash
```
This script clones the GitLab Development Kit (GDK) repository into a new subdirectory, and sets up necessary dependencies using the `asdf` version manager (including Ruby, Node.js, PostgreSQL, Redis, and more).
NOTE:
If you're using another version manager for those dependencies, refer to the [troubleshooting section](#error-no-version-is-set-for-command) to avoid conflicts.
1. For the message `Where would you like to install the GDK? [./gitlab-development-kit]`,
press <kbd>Enter</kbd> to accept the default location.
1. For the message `Which GitLab repo URL would you like to clone?`, enter the GitLab community fork URL:
```shell
https://gitlab.com/gitlab-community/gitlab.git
```
1. For the message `GitLab would like to collect basic error and usage data`,
choose your option based on the prompt.
While the installation is running, copy any messages that are displayed.
If you have any problems with the installation, you can use this output as
part of [troubleshooting](#troubleshoot-gdk).
1. After the installation is complete,
copy the `source` command from the message corresponding to your shell
from the message `INFO: To make sure GDK commands are available in this shell`:
```shell
source ~/.asdf/asdf.sh
```
1. Go to the directory where the GDK was installed:
```shell
cd gitlab-development-kit
```
1. Run `gdk truncate-legacy-tables` to ensure that the data in the main and CI databases are truncated,
then `gdk doctor` to confirm the GDK installation:
```shell
gdk truncate-legacy-tables && gdk doctor
```
- If `gdk doctor` returns errors, consult the [Troubleshoot GDK](#troubleshoot-gdk) section.
- If `gdk doctor` returns `Your GDK is healthy`, proceed to the next step.
1. Start the GDK:
```shell
gdk start
```
1. Wait for `GitLab available at http://127.0.0.1:3000`,
and connect to the GDK using the URL provided.
1. Sign in with the username `root` and the password `5iveL!fe`. You will be prompted
to reset your password the first time you sign in.
1. Continue to [Change the code with the GDK](contribute-gdk.md).
## Update an existing GDK installation
If you have an existing GDK installation, you should update it to use the community fork.
1. Delete the existing `gitlab-development-kit/gitlab` directory.
1. Clone the community fork into that location:
```shell
cd gitlab-development-kit
git clone https://gitlab.com/gitlab-community/gitlab.git
```
To confirm it was successful:
1. Ensure the `gitlab-development-kit/gitlab` directory exists.
1. Go to the top `gitlab-development-kit` directory and run `gdk stop` and `gdk start`.
If you get errors, run `gdk doctor` to troubleshoot.
For more advanced troubleshooting, continue to the [Troubleshoot GDK](#troubleshoot-gdk) section.
## Troubleshoot GDK
NOTE:
For more advanced troubleshooting, see
the [troubleshooting documentation](https://gitlab.com/gitlab-org/gitlab-development-kit/-/tree/main/doc/troubleshooting)
and the [#contribute channel on Discord](https://discord.com/channels/778180511088640070/997442331202564176).
If you encounter issues, go to the `gitlab-development-kit/gitlab`
directory and run `gdk doctor`.
If `gdk doctor` returns Node or Ruby-related errors, run:
```shell
yarn install && bundle install
bundle exec rails db:migrate RAILS_ENV=development
```
### Error: No version is set for command
If you already use another version manager in your system, you may encounter the "No version is set for command <command>" error.
To resolve this issue, you can temporarily comment out the sourcing of `asdf.sh` in your shell:
1. Open your shell configuration file (for example, `.zshrc`, `.bashrc`):
```shell
nano <path-to-shell-config>
```
1. Comment out the following line:
```shell
# Added by GDK bootstrap
# source ~/.asdf/asdf.sh
```
1. After making these changes, restart your shell or terminal session for the modifications to take effect.
To use `asdf` again, revert any previous changes.
## Change the code
After the GDK is ready, continue to [Contribute code with the GDK](contribute-gdk.md).
|
