GitLab self-hosted setup

Create a GitLab self-hosted integration with Flow using OAuth or an access token.

Permissions

Flow only requires read access to your repositories. This permission is needed to process the metadata used to generate our reports. When integrating with Flow, the service account must be a maintainer or owner at both the project and repository levels to utilize all services and webhooks. If you don't want to enable webhooks, then the minimum permission required in GitLab is reporter at both the project and repo levels.

You must have a GitLab self-managed version 9.0 or newer to integrate successfully with Flow.

Create your integration

To create your GitLab self-hosted integration:

1. Click Settings in the top navigation.

2. In the left navigation under Integrations, click Integrations.

3. Click Add integration.

4. Click GitLab Self-Hosted in the Integration Provider list.

5. Optional: If you see the Direct Connection or Hybrid Connection, select one.

6. Next, select your integration method and authenticate with GitLab: Access token or OAuth. In most situations, we recommend OAuth-based integrations.

OAuth

Before continuing in Flow, create a new OAuth application in GitLab. Use the following information when configuring the app:

• Name: Flow

• Redirect URI: https://<workspace>.appfireflow.com/accounts/complete/gitlab-enterprise

• Scopes:

  • api

  • read_user

  • read_repository

Once you've created your app, copy the Client ID and Client Secret, then return to Flow.

1. In the Add credentials tab, enter your Client ID, Client Secret, and Base URL.

Open

2. Click Connect with OAuth.

3. If you're already logged in to your GitLab account, a dialog will prompt you to confirm access. If you're not already logged in, you'll be prompted to log in before authorizing the connection.

4. If your connection was successful, you'll see a success message. If your connection isn't successful, verify your Client ID and Secret, Base URL, and the Redirect URI you provided when creating the OAuth application in GitLab.

Access token

1. In GitLab, create a new Personal access token (external site, opens in new tab). Use the following information:

   • Name: Give the access token an identifiable name so you know it's used for Flow.

   • Expiry date: Note this date so you can update the token again before it expires. If your access token expires before you update it in Flow, Flow can't continue to ingest and process your data. Alternatively, create a service account access token without an expiry date (external site, opens in new tab).

   • Scopes: The minimum required scopes for Flow to ingest data are:

     • api

     • read_user

     • read_repository

2. Copy your access token into the Personal Access Token field in Flow.

3. Input your Base URL.

Open

4. Click Test connection. Once your connection is successfully verified, you'll receive a success message. If you receive an error, verify your access token and base URL, then try again.

Once your authentication is successful, click Next to finish setting up your integration.

Finish your integration setup

Once you've authenticated successfully:

1. Toggle the Repos, Tickets, and Pull requests services on or off to determine which data types Flow will ingest for this integration. After you've made your selections, click Next.

2. Name your integration. This is the name Flow will display for the integration. Choose a name that will help you identify the integration in the future.

3. Once you've completed all sections, click Create.

You've successfully created a GitLab Self-Hosted integration. Next, Flow directs you to the details page for this integration to complete additional setup steps. At this point, choose whether to enable auto-import for your repos and set up repo exclusions.

To learn more about managing your new integration settings, see Managing integrations.