Gitpod works with public, private, or internal repositories on your own instance of GitHub Enterprise (GHE). Setting this up requires 2 steps.
- A one-time registration of the GHE server with Gitpod.
- Each Gitpod user connects their account to GHE the first time they start a workspace.
Registering a GitHub Enterprise Server
The GHE Admin can register the GHE server in their own Gitpod account settings.
Start by creating a New Integration and entering the Provider Host Name of GHE server.
Copy the Redirect URL from the form above.
Create a new OAuth application in your GHE developer settings, and fill in the Authorization callback URL with the copied value.
Populate the remaining fields and register the application in GHE. This opens a settings page where you can copy the OAuth Client ID and a Client Secret.
Copy the Client ID and Secret into the corresponding fields in Gitpod and activate the integration.
Connecting Gitpod accounts to GHE
GHE users connect their Gitpod account to their GHE account by starting a workspace.
To start a workspace, paste the URL of a GHE repository into the New Workspace popup ( CtrlCmd + O ) in Gitpod, or prefix the repository URL as described in Getting started.
The first time you do this, you will be prompted to authorize with your GHE instance.
The GHE OAuth window will appear, showing the name of the registered Gitpod OAuth app.
If you are trying to open a private or internal repository in GHE, you will be prompted to grant additional authorization before the workspace starts.
Validating your GHE connection with Gitpod
You should see the connection to your GHE instance, with your GHE account ID, in your Gitpod integration settings
If necessary, you can modify your GHE OAuth permissions to allow private repository access using the context menu on the right.
Creating a project in Gitpod
To create a new project with a GHE repository in Gitpod, select the your GHE instance from the list of git providers.
You should see your own repositories and those for all organizations to which you have access. Use the dropdown to switch between your personal account and other organization accounts. No additional GitHub app installation is required for each organization.
Selecting the repository will install a webhook and enable automatic prebuilds for the project.