Configuration guide

GitLab

Index repositories and issues from GitLab

Before you begin

Availability depends on your school's enabled tools, provider setup, and account permissions. These settings are managed in the web workspace. A class policy may restrict a feature described here.

How it works#

The GitLab Connector picks up all of the Merge Requests and Issues in a specified repository.

It will index both Open and Closed MRs. This includes the Title and Summary.
It will index Issues (and Incidents) including comments both Open and Closed.
Includes certain other metadata such as the URL, creator, etc.

Setting up#

Authorization#

Use GitLab Access Token#

This Connector uses a GitLab Access Token.

Create personal access token#

Set token details#

Enter a name and expiry date for the token.

The token expires on that date at midnight UTC.
If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
By default, this date can be a maximum of 365 days later than the current date.

Select scopes and create#

Select the desired scopes, further details here. Then select Create personal access token.

Indexing#

Open GitLab connector#

Navigate to the Admin Panel and select the GitLab Connector

Confirm GitLab URL#

If you're using GitLab Cloud and not self-hosting, keep the GitLab URL as the default

Configure project#

For a project with a url such as "https://gitlab.com/onyx-ai/onyx", configure it as below:

Before using this source with students#

Start with approved course material. Check which documents the connector can retrieve and how it maps source permissions. Test with a student account and a teacher account before widening access. A successful sync does not prove that the intended class boundary is correct.

Use source troubleshooting when a document is missing or visible to the wrong audience.