81 lines
3.5 KiB
Markdown
81 lines
3.5 KiB
Markdown
---
|
|
type: reference, how-to
|
|
stage: Create
|
|
group: Editor
|
|
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
|
|
---
|
|
|
|
# Gitpod integration **(FREE)**
|
|
|
|
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/228893) in GitLab 13.4.
|
|
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/258206) in GitLab 13.8
|
|
|
|
With [Gitpod](https://gitpod.io/) you can describe your development environment as code to get fully
|
|
set up, compiled, and tested development environments for any GitLab project. The development
|
|
environments are not only automated but also prebuilt which means that Gitpod continuously builds
|
|
your Git branches like a CI/CD server.
|
|
|
|
This means you don't have to wait for dependencies to be downloaded and builds to finish, you can start
|
|
coding immediately. With Gitpod you can start coding instantly on any project, branch, and merge
|
|
request from any device, at any time, from your browser:
|
|
|
|
|
|
|
|
To use the GitLab Gitpod integration, it must be enabled for your GitLab instance. Users of:
|
|
|
|
- GitLab.com can use it immediately after it's [enabled in their user settings](#enable-gitpod-in-your-user-settings).
|
|
- GitLab self-managed instances can use it after:
|
|
1. It's [enabled and configured by a GitLab administrator](#configure-a-self-managed-instance).
|
|
1. It's [enabled in their user settings](#enable-gitpod-in-your-user-settings).
|
|
|
|
To learn more about Gitpod, see their [features](https://www.gitpod.io/) and
|
|
[documentation](https://www.gitpod.io/docs/).
|
|
|
|
## Enable Gitpod in your user settings
|
|
|
|
With the Gitpod integration enabled for your GitLab instance, to enable it for yourself:
|
|
|
|
1. In the top-right corner, select your avatar.
|
|
1. Select **Preferences**.
|
|
1. Under **Preferences**, locate the **Integrations** section.
|
|
1. Select the **Enable Gitpod integration** checkbox and select **Save changes**.
|
|
|
|
## Configure a self-managed instance **(FREE SELF)**
|
|
|
|
For GitLab self-managed instances, a GitLab administrator needs to:
|
|
|
|
1. Set up a Gitpod instance to integrate with GitLab. Refer to the [Gitpod documentation](https://www.gitpod.io/docs/self-hosted/latest)
|
|
to get your instance up and running.
|
|
1. Enable it in GitLab:
|
|
1. On the top bar, select **Menu > Admin**.
|
|
1. On the left sidebar, select **Settings > General**.
|
|
1. Expand the **Gitpod** configuration section.
|
|
1. Select the **Enable Gitpod integration** checkbox.
|
|
1. Add your Gitpod instance URL (for example, `https://gitpod.example.com`).
|
|
1. Select **Save changes**.
|
|
|
|
Your users can then [enable it for themselves](#enable-gitpod-in-your-user-settings).
|
|
|
|
## Launch Gitpod in GitLab
|
|
|
|
You can launch Gitpod directly from GitLab in one of these ways:
|
|
|
|
- *From your project's page:*
|
|
1. Go to your project, and navigate to the page you want to edit.
|
|
1. Select the caret **(angle-down)** next to **Web IDE**, and select **Gitpod**
|
|
from the list:
|
|
|
|
|
|
|
|
1. Select **Open in Gitpod**.
|
|
- *From a merge request:*
|
|
1. Go to your merge request, and select **Overview** in the tab menu.
|
|
1. Scroll to the end of the merge request description.
|
|
1. Select the caret **(angle-down)** next to **Web IDE**, then select **Gitpod**
|
|
from the list:
|
|
|
|
|
|
|
|
1. Select **Open in Gitpod**.
|
|
|
|
Gitpod builds your development environment for your branch.
|