Skip to main content
Skip table of contents

Get Started

GitLab for Confluence merges development and documentation by embedding Gitlab issues, merge requests and other relevant information directly within Confluence pages, allowing for better collaboration and enhancing team productivity.

Installation

Install Gitlab for Confluence Data Center

  1. Log in to Confluence as an Administrator.

  2. From your Confluence administration, select Find new apps.

  3. Search for ‘GitLab for Confluence’.

  4. Click on Free trial and follow the steps in MyAtlassian to avail of a trial license.

  5. Once installed, you can proceed with the configuration.

image-20250616-232439.png

Gitlab connection configuration

Gitlab for Confluence Data Center supports both Gitlab On-Premise and http://gitlab.com.

  1. From your Confluence administration, select GitLab.

  2. Click on the +Add configuration button.

  3. Populate the relevant information to “Add configuration”:

    1. Title: Provide a suitable name for the configuration

    2. URL of the Gitlab Server: Provide the Gitlab Server URL or enter https://gitlab.com for Gitlab Cloud.

    3. Private Gitlab API Key or Access Token: provide the private API Key from the GitLab Server or Personal Access Token from GitLab Cloud to set up the connection.

    4. Token type: Specify whether using a Private Key or Access Token.

    5. Gitlab server type: Choose the type of GitLab you are connecting to: Server or Cloud.

  4. Click Test Connection: if successful, a green bar will be displayed; a red bar with an error message will appear if unsuccessful.

  5. Save settings.

image-20250616-235954.png

A guide on creating Personal Access Tokens can be found here.

Configuration Settings

There are several configurable options available from the Settings tab.

image-20250620-004210.png
  1. Go to the Settings tab from the Configuration setup and specify:

    1. Request timeout: the duration in sections before a macro call times out. The default is 30 seconds.

    2. Allowed spaces: specific spaces where macros are allowed.

    3. Forbidden spaces: spaces where macros are prevented.

    4. Automatically convert GitLab links into the macros: if this option is unchecked, links will not be converted automatically when pasted into Confluence pages, and the macro will need to be triggered manually.

Next Check Out: How to access GitLab Macros in Confluence

Updated:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.