Docs

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 GitHub OAuth application. This allows to use Gitpod with any GitHub instance.

Here’s how to do that:

  1. 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.
Screenshot 2020-08-25 at 08 30 39
  1. 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.
Screenshot 2020-08-25 at 10 07 54
  1. 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.
Screenshot 2020-08-25 at 10 08 08
  1. 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.
Screenshot 2020-08-25 at 10 09 19 Screenshot 2020-08-25 at 10 09 53
  1. Copy the Application ID and the Secret in the corresponding form fields (Client ID resp. Client Secret) of your Gitpod installation.
Screenshot 2020-08-25 at 10 10 15
  1. Press Connect and go through the Auth flow the first time.
Screenshot 2020-08-25 at 10 10 41

Congrats you have setup the GitHub OAuth applicaton. 🎉

Next up you should install the browser extension and configure it with your Gitpod installation URL.

Still Have Questions?

Please reach out. We’re happy to answer them.