Skip to content

Configuring the GitLab Enterprise Integration

planteater edited this page Oct 3, 2019 · 4 revisions

CodeStream can integrate with GitLab Enterprise using GitLab’s published REST API. To enable CodeStream to integrate with your GitLab Enterprise installation, you will need to set up a CodeStream application within your installation. This application serves as a conduit for users to authenticate against their GitLab Enterprise account without ever having to enter their credentials in CodeStream.

GitLab Enterprise uses the OAuth standard (version 2.0) for client authorization. To set up the application, log in to GitLab Enterprise as an administrator and go to Settings. On the left, click “Applications”. This should take you to a page where you can set up a new application.

New Application

Set the application name to “CodeStream” or whatever name works best for you to identify the application. Enter “https://api.codestream.com/no-auth/provider-token/gitlab_enterprise” for the redirect URI. Select "api" for scopes. Then click "Save application".

Once you create the application, you’ll see an application ID and a secret.

The first user to set up the integration will need three pieces of information:

  • the URL used to access your GitLab Enterprise installation as known to your internal network, in the form http(s)://host:port
  • the application ID associated with your CodeStream application, which they'll use when asked for the client ID
  • the secret associated with your CodeStream application, which they'll use when asked for the client secret

If all goes well, the user will be taken to a page in their browser where they can authenticate against GitLab Enterprise, if needed, and then approve CodeStream’s access to make API calls to GitLab Enterprise on their behalf. Once complete, the integration with your GitLab Enterprise installation will become available to all users on the team. Other users will NOT have to enter the URL, client ID, and client secret; they will only need to go through the final authentication process to authorize the application on their behalf.

You can’t perform that action at this time.