GitLab
Our GitLab integration collects metadata about your organization’s activity across repositories, pull requests, and deployments. We never read, transmit, or store source code. Sensitive data, such as branch names and pull request titles, are always encrypted.
Permissions
We request only the necessary permissions to analyze Git metadata. Below is a description of the scopes requested when connecting to GitLab:
- api: Read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
Due to limitations in GitLab’s scopes, our platform requires api, not read_api, in order to install webhooks on each project. Please note that we never read, transmit, or store source code. We also do not edit or modify code or files.
You can learn more about scopes for authorized applications in GitLab’s documentation.
Connecting Self-Managed GitLab
Our platform supports both GitLab Cloud (your user account is on gitlab.com) and GitLab Self-Managed (your organization administers and maintains its own GitLab instance).
Before you begin:
- Please verify that you are an owner of the GitLab group you wish to connect to Software.com. If you’re not an owner, invite one to help set up your account.
- If you have IP restrictions enforced, please contact us at support@software.com.
To connect a self-managed GitLab instance, select GitLab from our available integrations. You can add GitLab from your organization’s settings by navigating to the Settings view in the Software.com app and selecting the Connected Apps tab.
You will be asked to choose the type of GitLab instance your organization is running. Select Self-Managed.
We authenticate to your GitLab organization using an OAuth connection. All groups to which you have access will be synced. If you don’t have access to all of your organization’s groups, invite an admin to set up the application on your behalf.
Follow the steps below to connect GitLab:
- Select a Group. You can install Software.com on any group.
Select Settings, then Applications in the left sidebar.
Click Add New Application.
- Enter the information below to create the new Group application:
- Name: Software.com
- Redirect URI: https://app.software.com/gitlab_onboarding/create
- Confidential: checked
Scopes: api
Due to limitations in GitLab’s scopes, our platform requires api , not read_api , in order to install webhooks on each project. Please note that we never read, transmit, or store source code. We also do not edit or modify code or files.
- Click Save Application to generate application credentials.
- Copy the Application ID and Secret. Store these credentials securely, as they can not be accessed again later. Only select Continue once you have these copied and stored securely.
Navigate back to Software.com and paste the Application ID and Secret. Click Save.
- Activate your GitLab App. You will be redirected to authorize Software.com to access your account.
After connecting, you can manage your GitLab integration from the Applications page.
