Configure the authentication used by your Gitpod Self-Hosted installation
⚠️ Deprecated Content
The content of this page assumes you are using Helm, which is now deprecated. Please use the Installer instead.
Gitpod does not implement user authentication itself, but integrates with other auth provider using OAuth2. Usually your Git hosting solution (e.g. GitHub or GitLab) acts as the OAuth auth provider. This way we control access to Gitpod while at the same time making sure every user has proper access to their Git repository.
Gitpod supports the following authentication providers:
- github.com
- GitHub Enterprise in version 2.16.x and higher
- gitlab.com
- GitLab Community Edition in version 11.7.x and higher
- GitLab Enterprise Edition in version 11.7.x and higher
- Bitbucket — coming soon
- Custom Auth Provider – Inquiry TypeFox for a quote
GitHub
To authenticate your users with GitHub you need to create a GitHub OAuth App. Follow the guide linked above and:
set “Authentication callback URL” to after replacing example.com with your domain name:
copy the following values and configure them in
values.yaml
:clientId
clientSecret
GitLab
To authenticate your users with GitLab you need to create an GitLab OAuth application. Follow the guide linked above and:
set “Authentication callback URL” to:
https://
/auth/ /callback set “Scopes” to
api
,read_user
andread_repository
.copy the following values and configure them in
values.yaml
:clientId
is the “Application ID” from the GitLab OAuth applicationclientSecret
is the “Secret” from the GitLab OAuth application