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.io 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.

What Do You Need for the Setup and How it Works?

Here’s what you need to do for integrating your self hosted project:

1. Set up a new OAuth application in GitLab

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

We've covered the steps for it.

How to Set Up a New OAuth Application in GitLab (for Self-Hosted instance): Step-by-Step

1

Login to GitLab

Login to your GitLab self hosted instance.

2

Create a New Application

Create a new application in GitLab with the following steps:

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.

How to Integrate BetterBugs Project with GitLab (for Self-Hosted Instances): Step-by-Step

PREREQUISITES for BetterBugs.io + GitLab Self-Hosted Integration

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

• Your GitLab Base URL (self-hosted)

Here, we've covered the steps to integrate a single BetterBugs project (within your BetterBugs Workspace) with GitLab. You can also integrate the complete BetterBugs Workspace in one go (that includes all the projects within your Workspace) to GitLab or any other project tool. Check out the steps for Workspace Integration.

1

Open Workspace Settings > Integrations

Click on BetterBugs Workspace name at the top left side of app screen. Now, click the gear icon to open Workspace Settings > Integrations.

2

Search GitLab

In the Integrations tab, search for GitLab and click to open the GitLab card.

3

Turn off workspace-wide integration

Toggle off the "All Projects" option and hit "Continue". You should see the "Manage per project" option now.

By default, its turned on for workspace level integration. For project-wise integration, you need to disable "All Projects".

4

Select a BetterBugs project to integrate and hit "Connect"

Select a project from the projects name list (that's within your Workspace). From the "Actions" column, hit "Connect" for that project.

5

Select GitLab Version for Integration: Self-hosted Version

You've two versions for it:

• Cloud Version -> Enables you to connect BetterBugs with gitlab.com with OAuth.

• Self-hosted -> Enables you to connect your self hosted GitLab project with your Personal Access Token.

Select the "Self-hosted" Version of GitLab.

6

Enter GitLab application credentials

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/

7

Authorize BetterBugs.io for GitLab

Authorize BetterBugs.io for your GitLab account.

IMPORTANT NOTE

If you're on a free plan, Steps 6 and 7 are NOT REQUIRED. You can just SKIP to "How to Raise an Issue on GitLab using BetterBugs" section.

FOR PAID PLANS (Teams and Enterprise)

Steps 6 and 7 enables you to explicitly choose between:

• Manual Issue Creation (Default): This means for sharing a bug report to GitLab, you'd need to manually populate fields for your GitLab Repo. (Project, Assignees, Labels, and others). Its a FREE FEATURE.

• Automatic Issue Creation: This means for sharing a bug report to GitLab Repo, you can configure BetterBugs to auto-populate fields for GitLab (Project, Assignees, Labels, and others). Its a PAID FEATURE.

8

Optional: Choose your preferred method for creating tickets: Manually or Automatically

From the "Forward Bug Reports" dropdown, select your preferred method for creating tickets in your project tool:

• Manually: Enables you to raise issues manually. Here, we've selected the manual method to showcase project integration steps.

• Automatically: Enables you to raise issues with automation.

9

Optional: Select "Manually" and Connect

Finally, select "Manually" from the "Forward Bug Reports" dropdown and hit "Connect".

Okay! You're good to go with the Project level integration for GitLab Self-hosted version. Now, you can create detailed reports and share them as GitLab issues directly from your browser with a few clicks.