配置 GDK-in-a-box

如果您想为 GitLab 代码库做贡献，并希望有一个可以测试您更改的开发环境，您可以使用 GDK-in-a-box。GDK-in-a-box 是一个多平台容器镜像，预配置了 GitLab Development Kit (GDK)。

GDK 是一个本地开发环境，包含 GitLab 自托管版本、示例项目和管理员访问权限，您可以用来测试功能。

它需要 30 GB 的磁盘空间。

如果您更喜欢在本地使用 GDK 而不使用 VM，请使用 安装 GDK 开发环境 中的步骤

下载 GDK-in-a-box

1. 安装容器运行时。

   • 有多种选择，包括 Docker Desktop、Docker Engine 和 Rancher Desktop。
   • Docker Desktop 也可以通过 Homebrew 等包管理器安装。
   • 注意：在 Rancher Desktop 上，您可能需要在"偏好设置"中禁用 Kubernetes。
   • 其他支持 Docker 兼容命令的容器运行时也应该可以工作。

2. 拉取容器镜像。镜像下载大小小于 6 GB，可能需要一些时间下载。

   • docker pull registry.gitlab.com/gitlab-org/gitlab-development-kit/gitlab-gdk-in-a-box:latest

3. 从镜像创建容器：

   docker run -d -h gdk.local --name gdk \
   -p 2022:2022 \
   -p 2222:2222 \
   -p 3000:3000 \
   -p 3005:3005 \
   -p 3010:3010 \
   -p 3038:3038 \
   -p 5100:5100 \
   -p 5778:5778 \
   -p 9000:9000 \
   registry.gitlab.com/gitlab-org/gitlab-development-kit/gitlab-gdk-in-a-box:latest

4. 继续到 使用 VS Code 连接到 GDK。

使用 VS Code 连接到 GDK

观看此步骤的演示视频。

1. 启动容器。

2. 在 VS Code 中，选择 终端 > 新建终端，然后运行 curl 命令将 SSH 密钥添加到您的本地 ~/.ssh/config：

   curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/gdk-in-a-box/setup-ssh-key" | bash

   要了解更多关于该脚本的信息，您可以查看 setup-ssh-key 代码。

3. 在脚本中，输入 1 选择容器安装。

4. 在 VS Code 中，安装 Remote - SSH 扩展：

   • VS Code
   • VSCodium

5. 将 VS Code 连接到虚拟机：

   • 从命令面板中选择 Remote-SSH: Connect to host。
   • 选择 gdk.local 进行连接。

6. 会打开一个新的 VS Code 窗口。 您可以关闭旧窗口以避免混淆。 在新窗口中完成剩余步骤。

7. 在 VS Code 终端中，运行 curl 命令来配置 GDK 中的 Git：

   curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/gdk-in-a-box/first_time_setup" | bash

   • 当提示时输入您的姓名和电子邮件地址。
   • 将显示的 SSH 密钥添加到您的个人资料。

   要了解更多关于该脚本的信息，您可以查看 first_time_setup 代码。

8. 在 VS Code 中，选择 文件 > 打开文件夹，然后导航到：/home/gdk/gitlab-development-kit/gitlab/。

9. 在浏览器中打开 GitLab：http://gdk.local:3000。

   • 如果页面无法加载，请将 127.0.0.1 gdk.local 添加到您本地计算机的 hosts 文件中。

10. 使用用户名 root 和密码 5iveL!fe 登录。

11. 继续到 使用 GDK 修改代码。

关闭 GDK 容器

您可以通过在主机上运行以下命令来停止容器：

docker stop gdk

删除 GDK 容器

您可以通过在主机上运行以下命令来删除容器：

docker rm gdk

更新 GDK-in-a-box

当在 VS Code 中连接到 gdk.local 时，您可以更新 GDK-in-a-box。

在 VS Code 终端中输入：

gdk update

修改代码

GDK 准备就绪后，继续到 使用 GDK 贡献代码。

下载 GDK-in-a-box 虚拟机镜像（已弃用）

1. 下载并安装虚拟化软件来运行虚拟机：
   • 具有 Apple silicon 的 Mac 计算机：UTM。 选择 从 GitHub 下载。
   • 具有 Intel silicon 的 Linux / Windows / Mac 计算机：VirtualBox
2. 下载并解压 GDK-in-a-box。文件大小可达 15 GB，可能需要一些时间下载：
   • 具有 Apple silicon 的 Mac 计算机：UTM 镜像
   • Linux / Windows / Mac：VirtualBox 镜像
3. 双击虚拟机镜像打开它：
   • UTM：gdk.utm
   • VirtualBox：gdk.vbox
4. 继续到 使用 VS Code 连接到 GDK（虚拟机）。

使用 VS Code 连接到 GDK（虚拟机）

1. 启动虚拟机（您可以最小化 UTM 或 VirtualBox）。

2. 在 VS Code 中，选择 终端 > 新建终端，然后运行 curl 命令将 SSH 密钥添加到您的本地 ~/.ssh/config：

   curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/gdk-in-a-box/setup-ssh-key" | bash

   要了解更多关于该脚本的信息，您可以查看 setup-ssh-key 代码。

3. 在脚本中，输入 2 选择虚拟机安装。

4. 在 VS Code 中，安装 Remote - SSH 扩展：

   • VS Code
   • VSCodium

5. 确保 VS Code 可以访问本地网络（隐私与安全 > 本地网络）。

6. 将 VS Code 连接到虚拟机：

   • 从命令面板中选择 Remote-SSH: Connect to host。
   • 输入 SSH 主机：gdk.local

7. 会打开一个新的 VS Code 窗口。 您可以关闭旧窗口以避免混淆。 在新窗口中完成剩余步骤。

8. 在 VS Code 终端中，运行 curl 命令来配置 GDK 中的 Git：

   curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/gdk-in-a-box/first_time_setup" | bash

   • 当提示时输入您的姓名和电子邮件地址。
   • 将显示的 SSH 密钥添加到您的个人资料。

   要了解更多关于该脚本的信息，您可以查看 first_time_setup 代码。

9. 在 VS Code 中，选择 文件 > 打开文件夹，然后导航到：/home/debian/gitlab-development-kit/gitlab/。

10. 在浏览器中打开 GitLab：http://gdk.local:3000。

11. 使用用户名 root 和密码 5iveL!fe 登录。

12. 继续到 使用 GDK 修改代码。

关闭 GDK 虚拟机

您可以选择电源图标 ( ) 来关闭 虚拟机，或者在终端中输入 shutdown 命令。 使用密码 debian：

sudo shutdown now