Versions Compared

Key

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


Warning
titleDeprecation notice (applicable for Markdown from a URL macro)Removal notice:

Please note that

the 

the URL user

 and 

and URL

password parameters are deprecated and will be removed on March 31, 2022. We recommend using 

user password parameters were removed in 3.8.2 (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access

your

external data

from remote locations

.

This article illustrates the process of adding a GitHub profile to the Markdown from a URL macro.

...

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


  4. Select GitHub from the options in Profile type.

    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 GitHub in the URL text box. Example: https://api.github.com/repos.

    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 User and Password credentials required to access the given URL, or enter the access token for your GitHub 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.


  7. Click Save profile to create the profile.

Addition links