Self-Hosted GitLab

Share complete bug reports as issues directly to your GitLab self-hosted project’s issue boards.

BetterBugs integration with your self-hosted GitLab instance

You can integrate BetterBugs with your self-hosted instance on GitLab.

Whenever you face an issue in your app, you can instantly capture it using the BetterBugs extension and share it with your GitLab self-hosted instance as an issue.

With every issue raised (created as bug reports using BetterBugs) in your GitLab project, you get:

• The visual evidence captured as a screenshot, screen recording, or a 2-minute Rewind video session

• Issue description (added manually or AI-generated by the reporter)

• Device and environment info when the issue occurred.

• Console logs, network requests, and any other logs.

• Page navigation steps

• Metadata (Custom)

• App local and session storage

Your engineers get all this info as a bug report packed with visual evidence and technical details for debugging. You can access the complete bug report with the unique report link included within the GitLab task created as an issue on your self-hosted project.

How to integrate BetterBugs for GitLab’s self-hosted instance?

Here’s what you need to integrate your self hosted project:

1. Set up a new OAuth application in GitLab

2. Use the application (Application ID + Secret) credentials to integrate BetterBugs.

Follow the below steps for these.

Steps to set up a new OAuth application in GitLab (for Self hosted instance)

1

Login to GitLab

Login to your GitLab self hosted instance.

2

Create a new application

Next, create a new application in GitLab:

1. Click on your Profile picture in the top from the navigation pane.

2. Navigate to Preferences > Applications > Add new application

3

Add Name, Redirect URI, and select Scopes

Add details for the app:

• Name — Provide a unique name for your application, (e.g., BetterBugs Test App)

• Redirect URI — Here, add “https://app.betterbugs.io/connect/gitlab” as the Redirect URI. (Please use this exact address for any new app(s) you’d want to connect with BetterBugs.)

• Confidential — It should be ✅auto-checked by default.

• Scopes — Next, check ✅ only the “api” option in scopes. No other options are required.

4

Save

Hit the “Save application” button from below to save.

5

Copy the newly generated application credentials and hit Continue

Copy your application credentials and keep them handy. You’ll need these to integrate with Betterbugs.

• Application ID

• Secret

Now, hit “Continue” and you’re all set.

Steps to integrate BetterBugs with GitLab (for self-hosted instances)

The following steps would connect BetterBugs with the GitLab Self-Hosted Version.

BetterBugs Integration with GitLab Self-Hosted Version

However, if you integrate directly from the external session or with the Cloud Version option, both will connect using GitLab Cloud Version.

Simply put, integrating directly from an external session and selecting Cloud Version from within the BetterBugs app for integration are the SAME.

PREREQUISITES FOR SELF HOSTED INTEGRATION

• GItLab Application ID and Secret (as generated using the above steps)

• Your GitLab Base URL (self-hosted)

Follow the below steps to continue integration:

NOTE: This is a project level integration within BetterBugs. You can also integrate the entire BetterBugs Workspace with GitLab with the Workspace Level integration.

1

Open Project Settings for a BetterBugs Project

Login to your BetterBugs account. In your workspace, select a project and press the gear icon near the Project name at the top to open project settings.

2

Open Integrations tab, search for GitLab

From Project Settings, open the Integrations tab and search for the GitLab card.

3

Hit “Connect” and select GitLab Self-Hosted version for integration

In the GitLab card, hit the “Connect” button. Here, you’ll see two versions for integration:

• Cloud Version — This one does not require a self hosted GitLab instance. It integrates directly with your GitLab projects within your GitLab account. It's the same (default) as integrating from an external session.

• Self-Hosted — For self hosted instance. (as covered here)

Click the “Self-Hosted” version.

4

Enter GitLab application credentials

Now, enter details for the GitLab application + your GitLab Base URL:

• Client ID — Application ID

• Client Secret — Secret

• Base URL — GitLab Base URL

IMPORTANT: Make sure your GitLab Base URL (used during integration) does not end with a trailing slash.

For example: ✔️ https://gitlab.example.com

❌ https://gitlab.example.com/

5

Connect with GitLab

Next, click on "Connect" and authorize BetterBugs for GitLab.

This completes the integration.

Steps to create and send a bug report to GitLab

After integrating, here’s how to create a new bug report and share with your GitLab project.

1

Capture the bug

Open BetterBugs extension and take a screenshot, record a video, or hit Rewind (if it's enabled for the website).

2

Enter bug details

Add a title* (Required) and other bug details about the bug.

3

Select the BetterBugs workspace and project integrated with GitLab

From the top right dropdowns, select the BetterBugs Workspace and Project integrated with your GitLab self-hosted version.

• Dropdown 1: Workspace Name

• Dropdown 2: Project Name

4

Select GitLab issue and add details

Open the "+ Connect to your tools" dropdown from the bottom right of your screen.

Now, click "GitLab issue". This fetches the report template for "GitLab task info". Add details for Project, Assignees, Labels, Milestone, Due Date, and any others.

5

Send report

Hit the "Upload Bug Details" button from down below.

A new tab with the created GitLab issue opens up, creating the Task for the selected GitLab issue board. The task includes visual proof of the issue, description, issue repro steps, devtools details, and a link to the complete bug report. You can access the report on the BetterBugs dashboard by clicking the links in the GitLab issue.

You’re all set with the integration. Now, whenever you create a report, you can instantly send it to the connected GitLab board straight from your browser.

To check if the integration worked correctly and the report was shared with your GitLab project,

1. Open the report that you just shared (using the Issue report link from the GitLab task or your BetterBugs project).

2. Click on the Comments/Activities tab at the bottom right to check for a successful task creation message or any other activity on it. Make sure to enable the “Activities” with the toggle switch.

Steps to send an existing report to GitLab

1

Login to BetterBugs

Log in to your BetterBugs account.

2

Select project and open report

Select the project (within BetterBugs) that’s integrated with GitLab Self-Hosted instance. Open the report you want to share.

3

Enter details for GitLab issue

Click "+ Send to your tools" from the top and select "GitLab issue" from the dropdown. This fetches the report template for "GitLab task info". Add information for the fields (Project, Assignees, Labels, Milestone, and others).

4

Send to GitLab

Hit the "Create Task" button.

You’re good to go.

A new tab with the created GitLab task opens up, adding the task to the GitLab issue board with all the issue details and a link to the complete bug report with developer tools info.