Versions Compared

Old Version 13

changes.mady.by.user Saumya Sunder (Inactive) (Deactivated)

Saved on

compared with

New Version 14

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 Markdown macrofrom a URL macro.

Info

Before you begin:

To add a profile, you will need the following:

Global Configuration settings:

  • Whitelist the URL for GitLabinformation 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 Markdown for Confluence Configuration is enabled.

  • 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 can process the file and its contents.


Steps

  1. Navigate to CONFLUENCE ADMINISTRATION > General Configuration > BOB SWIFT CONFIGURATION > Markdown > Profiles.

  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 add enter a profile name that already exists, Markdown will replace the existing profile gets replaced with the given information.


  4. Select GitLab

    Select GitLab from the options in Profile type.

     You will notice that the Header parameters are auto-filled.
    Image Removed

    Enter the API URL for
    Image Added 

    Note

    The Request headers parameter is auto-filled 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

    To know more about URLs, refer to Create a profile with a URL.

    Enter the Personal access token for your GitLab profile in the Access token text box. 

    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 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. 

    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.

    In this example, an access token is used to connect and access the GitLab repositories.

  7. Click Save profile to create a Profile.profile.

Addition links