Add a GitLab profile

Removal notice:

Please note that the URL user and URL user password parameters were removed in 5.8.5 (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.

This article illustrates the process of adding a GitLab profile to be used with the HTML for Confluence macros.

Before you begin:

To add a profile, you need the following:

Personal access token for information about generating a GitLab access token. Refer to GitLab access token URL for the actual URL to generate the access token if you have a GitLab account.
Whitelist the required GitLab URL in Confluence configuration settings if Restrict URL access in HTML for Confluence Configuration is enabled.
Raw URL of the file to be rendered.

A raw URL is defined as the part of the URL following the domain information and includes the query string, if present. For example, in the URL string http://www.contoso.com/articles/recent.aspx, the raw URL is /articles/recent.aspx.

For this example, let's add a GitLab profile to an Html-bobswift macro.

Steps

Select > Manage apps, either search for HTML for Confluence or scroll to Bob Swift Configuration, and click HTML to view app configuration.

Click Add Profile.
Enter a unique profile name in the Profile name text box.
Select GitLab from the options in Profile type.

HTML Configuration > Profiles > Add profile
Enter the relevant URL for GitLab in the URL text box. Example: https://gitlab.com/api/v4/projects.
Enter User and Password credentials required to access the given URL, or enter the access token for your GitLab profile in the Access token text box. Refer to this personal access token article to know how to create your personal access token.
In this example, an access token is used to connect and access the GitLab repositories.
Click Save profile to create the profile.

Add a GitLab profile

Steps

Helpful resources