ToolJet/docs/versioned_docs/version-3.5.0-LTS/development-lifecycle/gitsync/connect-to-git-repo/gitlab-config.md
2025-05-15 13:31:42 +05:30

4.2 KiB
Raw Blame History

id title
gitlab-config GitLab Configuration
Icon Paid feature

The GitLab Configuration for GitSync introduces a more flexible way to connect your ToolJet instance to a Git repository. Compared to traditional SSH-based setups, it works over HTTPS, helping you avoid SSH port blocks, and lets you choose branches directly from the UI.

Role Required: Admin

1. Create a New Project

Create a new project in your GitLab account. You can choose to make it public or private. If youre using an existing repository, ensure its empty before proceeding.

2. Get the GitLab Project ID

To get the project ID, navigate to your project's settings and look for the *Project ID* field under the General section. This value represents the unique identifier assigned by GitLab to your project. Save this value for later use.

2. Generate a Personal Access Token

Follow these steps to generate a personal access token:

  • Go to your Project Settings and click on Access Tokens
  • Enter name for your token.
  • Select a role as Developer, Maintainer, or Owner
  • Select the required scopes. The mandatory scopes are: - api - read_api - read_repository - write_repository
  • Click the Create personal access token button.

Once generated, copy and store the token as it won't be displayed again. This token will be used later when configuring GitSync.

4. Configure GitLab in GitSync

Navigate to the Workspace settings page and click on the Configure git tab. Then, enter the required configuration values after selecting GitLab as your repository provider.

GitSync

The table below describes each configuration values:

Repository

Setting Description
Repo URL The URL of the Project you created to use with ToolJet. (e.g https://gitlab.com/<your-group>/<project-name>.git or https://gitlab.com/<username>/project-name.git)
Branch name Branch name of your project. By default, it uses the main branch.

Self-hosted GitLab (Optional)

Setting Description
GitLub enterprise URL The domain used to access your self-hosted GitLab instance. (e.g https://gitlab.corp.com) If you use GitLub Cloud, you can leave this blank.

Project Access Configuration

Setting Description
GitLab Project ID The GitLab project ID.
GitLab Project access token The GitLab project token.
Once you've entered the necessary configurations, click **Save Changes**. Your ToolJet instance will now be connected to your GitLab project.