bitrise.io

Connecting self-hosted GitLab instances

Last updated at 2021-07-23

For Workspaces, Bitrise supports connecting to self-hosted GitLab instances. Connecting is simple, and once it’s done, you can add apps to Bitrise from privately hosted repositories in the usual way. All functions that you got used to with publicly hosted repositories will be available!

Setting up an app that is in a self-hosted GitLab repository is very simple: Bitrise needs to be authorized as an application for the entire GitLab instance and then the Application Id and the Secret value belonging to the Bitrise OAuth application must be added to the Workspace on bitrise.io.

Connect a self-hosted GitLab instance with Bitrise

Workspaces only!

Only Workspaces can use privately hosted GitLab instances on Bitrise. If you are not on a Workspace plan, you should not follow this guide.

Public address of the instance

Your self-hosted GitLab instance must have a publicly resolvable IP address, otherwise Bitrise won’t be able to connect to it.

  1. Log in to your GitLab instance with root privileges. If you connect to Bitrise without root privileges, your Workspace’s other team members will not have access to the repository on the GitLab instance.
  2. Go to the admin area by clicking the little wrench icon on the top menu bar.
  3. On the left menu bar, select Applications, then click New Application.

    New Application

  4. In the Name field, enter a name that clearly identifies the application. For the sake of simplicity, we recommend Bitrise.
  5. In the Redirect URI field, enter https://app.bitrise.io/users/auth/gitlab/callback.
  6. In the Scopes menu, check api.

    New Application settings

  7. Click Submit. On the next page, you should see an Application Id and a Secret. You’ll need both to connect to your GitLab instance on bitrise.io.

    Connecting self-hosted GitLab instances

  8. Go to your Workspace’s profile page on bitrise.io.
  9. Select the Connected Accounts option on the left menu bar.
  10. Add your self-hosted GitLab credentials:
    • App ID
    • Secret
    • Self-hosted URL

You are done! Now you are able to access your privately hosted repositories with Bitrise.

Add a new app from a self-hosted GitLab repository

Before you start, make sure you created an OAuth application in your self-hosted GitLab instance.

  1. Log in to bitrise.io and click the + symbol on the top menu bar and select Add app from the options.
  2. Choose a Workspace account.
  3. When prompted to select your Git provider, select GitLab. Select the Self-hosted option.
  4. If you haven’t provided your self-hosted GitLab credentials to the Workspace before, you can do it at this stage.
  5. Click Connect.

Once connected, proceed as usual to setting up your project configuration.