Menu

Gitpod - A frictionless cloud based IDE

Gitpod is an open-source Kubernetes application providing fully-baked, collaborative development environments in your browser - powered by VS Code. Tightly integrated with GitLab, GitHub, and Bitbucket, Gitpod automatically and continuously prebuilds dev environments for all your branches. As a result, team members can instantly start coding with fresh, ephemeral and fully-compiled dev environments - no matter if you are building a new feature, want to fix a bug or do a code review.

Gitpod provides continuous dev environments for the development flows of common code hosting platforms. The following example shows how to use Gitpod with a source code repository.

  • Point your browser to a GitLab, GitHub or Bitbucket repository, Pull/Merge Request, or issue, e.g. https://gitlab.com/gitpod/spring-petclinic
  • Either prefix the URL in the address bar of your browser with gitpod.io/# (e.g. https://gitpod.io/#https://gitlab.com/gitpod/spring-petclinic ) or click the Gitpod button if you’ve installed the Gitpod browser extension.
  • On first use you will have to authorize access to your GitLab, GitHub or Bitbucket account. This is necessary so you can access your data from within Gitpod.
  • Gitpod will now launch a workspace container for you in the cloud, containing a full Linux environment. It will also clone the repository, branch, or commit based on which code-hosting page you were coming from.

GitHub Integration

Gitpod comes with a GitHub integration that allows you to start Gitpod workspaces from any GitHub project.

Starting Workspaces

To start a workspace from a GitHub project, prefix the GitHub URL with gitpod.io/# as described in Getting Started.

Enabling Prebuilds

To enable prebuilt workspaces for your GitHub project you need to install the Gitpod GitHub app and configure it for the GitHub user or organization that the project belongs to. Install the app as described in the prebuilds page.

OAuth Application

In Gitpod Self-Hosted you can register your own GitLab OAuth application. This allows to use Gitpod with any GitHub instance.

Here’s how to do that:
  • When first starting your Gitpod installation, you’ll get redirected to /first-steps where you get prompted to add a Git Provider. Click the button.
  • In the pop-up you choose GitHub as the type and type the host URL of the GitHub installation you want to use. If you want to hook up with the github.com you can use that host as well, of course.
  • The form for your GitHub integration now shows three values. The first one is the redirect URL, that you need to register on the GitHub side. Copy the redirect Url to your clipboard.
  • Go to /settings/developers on your GitHub installation to create an OAuth App. Type in a name (e.g. Gitpod) and paste the Redirect URL in the corresponding text area.
  • Copy the Application ID and the Secret in the corresponding form fields (Client ID resp. Client Secret) of your Gitpod installation.
  • Press Connect and go through the Auth flow the first time.
Congrats you have setup the GitHub OAuth applicaton. 🎉