Versions Compared

Old Version 4

changes.mady.by.user Smita Nair

Saved on

compared with

New Version 5

changes.mady.by.user Smita Nair

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

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

Info

Before you begin:

To add a profile, you need the following:

  • Personal access token for information about generating GitLab access token
  • GitLab access token URL for the actual URL to get the access token
  • Whitelist the GitLab URL in Confluence configuration settings

  • Raw URL of the file to be rendered 

    Info

    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.


    Tip
    titleHow to identify if a file is valid for the macro?

    Paste the file link into your browser's address bar. If the actual code is displayed in the browser, it is considered to be invalid or in an incorrect format. If the file downloads to your system, the macro(s) can process the file and its contents.


For this example, let's consider adding a GitLab profile to an HTML macro.

Steps

  1. Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > HTML > Profiles. 

    Tip
    titleTry this for newer Confluence versions

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


  2. Click Add Profile.

  3. Enter a unique profile name in the Profile name text box. 

    Info

    Ensure that you provide a unique profile name. If you enter a profile name that already exists, the existing profile gets replaced with the given information.


  4. Select GitLab from the options in Profile type. Note that the

    Image Added 

    Note

    The Request headers parameter is auto-filled

    .Image Removed

    and more information gets appended as other relevant parameters are filled.


  5. Enter the relevant URL for GitLab in the URL text box. For example,Example: https://gitlab.com/api/v4/projects. 

    Info

    It is recommended to provide only the base URL in this text box and let the users enter the relevant relative path to the actual file to be rendered through the macro. This method allows multiple users to access a profile across pages and instances of the macros.


  6. Enter the access token for User and Password credentials required to access the given URL, or enter the access token for your GitLab profile in the the Access token text box. Refer to the this personal access token article to know how to create your personal access token. 

    Note

    Access tokens or API tokens are a means of user authentication; so, if mentioned, this token is used for authentication instead of using the user credentials. Thus, provide either the user credentials or an access token, but not both.


  7. Click Save profile to create the profile.

...

Helpful resources

...