GitLab self hosted setup

Overview

Below is a step-by-step guide on how to connect your self hosted GitLab account to Flow. If your repositories are behind a firewall, please whitelist our IPs on port 443 over HTTPS. You also need a public DNS record pointing to the IP address that is being exposed for Flow analysis. This DNS entry should match the TLS/SSL certificate that the server is utilizing.

Important: We strongly recommend you use a service account to create this Integration. Please see How to create a service account for instructions and information about why service accounts are important. The service account will need to be added to the GitLab groups with at least a "reporter" permission in order to import repos into Flow.

Permissions Requirements

To use all services (repos, PRs, tickets and Webhooks) when integrating with Flow, the service account will need to be a maintainer or owner at the project/repository level. If you prefer not to enable Webhooks, the minimum permission needed in GitLab is reporter at the project/repository level.

Version Requirement

GitLab 9.0 or higher

GitLab Enterprise configuration:

Step 1: In order to connect your GitLab Enterprise, you will need to first create a new integration. On your Flow home page, go to the top navigation bar and click Settings. Using the left navigation under Integrations, click Integrations.

Step 2: Select the Add Integration button in the top right hand corner of you integrations screen.

Step 3: On the following page select GitLab Self-Hosted from the Integration Provider list and click Next.

Step 4: In this next step you can choose to connect via an OAuth application or access token. Choose the connection that works best for you.

A.) OAuth

Step 1: On any page of your GitLab instance, click your user icon and then navigate to Settings and Applications.

Step 2: Fill in the following information under Add new application:

Name: Flow
Redirect URL: https://flow.pluralsight.com/accounts/complete/gitlab-enterprise
Scopes: api, read_user

Step 3: Fill in your Application ID, Client Secret and Base URL into the Flow integration screen.

Tip: Before proceeding to the next step, make sure you have pop-ups disabled on your browser. The following steps will include a pop-up that will finalize your connection to your GitLab account. If you have pop-ups blocked, you will have to start all over.

Step 4: Click Connect to GitLab Self-Hosted. If Flow is able to successfully access your instance you will see the message below.

If your connection is not successful, please double check your Client ID and Secret, Base URL and the callback URL you provided when creating the OAuth application in GitLab.

B.) Access Token

You can connect via an access token. On the tab input your access token and click Test connection. For more information on where to create an access token in GitLab see GitLab’s support document Personal access tokens.

If the connection was successful you will see the following message:

If you receive an error when trying to connect your GitLab account using an access token verify the access token and base URL and try again.

Step 5: Once you have successfully connected to your GitLab account, click Next.

Step 6: After clicking Next on your screen, you will be selecting the services you want turned on for this Integration. If you would like to import ticket and pull request data in addition to repo data, then leave all services on. You can turn services “on” and “off” at any time. Click Next.

Step 7: Name your integration so you can identify the account you connected with. Click Create.

Step 8: You have successfully created a new GitLab self hosted integration.

Step 9: You can begin to import your repos by going to your repo import page. Click the repo import page link. To learn more about managing your new integration settings, see Manage integrations.

If you need help, please email support@pluralsight.com for 24/7 assistance.