Configuration - Cloud

After migrating or installing Markdown for Confluence, navigate to the Configuration screen:

  1. Log in with the System Administrator global permission.
  2. Navigate to  > Settings > Atlassian Marketplace on the sidebar.
  3. Click Markdown Configuration to manage the app configuration.

The app configuration consists of the following tabs:

Global configuration

Use the toggle to enable or disable the Global Configuration settings.

ParameterDescription
Restrict URL accessThe Restrict URL access parameter controls whether or not URLs conform to the allowlisted URLs. Administrators can turn on the allowlist to restrict access to URLs configured in the Whitelist settings

Allow JavaScript

This option controls JavaScript usage in the Markdown macros. Enabling this option allows you to execute JavaScript within the macros.

Help us improve the product

Enabling this option reports usage data that helps us improve the app continually. The app does not send any private user data or personally identifiable information. To learn more about what is being sent, refer to Analytics data.

Whitelist

Manage the URLs that the app can access from this page. If the Restrict URL access option is enabled, the app is restricted to allow the specified URLs only. 

ParameterDescription
ExpressionEnter a URL or an expression here.
Type

Select a type from the following list:

  • Domain name - allows URLs of a specific domain. Example: https://www.example.com/.
  • Exact match - allows only the specified URL. Example: https://www.example.com/thispage.
  • Wildcard expression - allows all matching URLs. Use * as a wildcard character to replace one or more characters. Example: https://*example.com.
  • Regular expression - allows all URLs matching the specified regular expression. Example: http(s)?://www\.example\.com. 
    Refer to this link for more information about regular expressions.

You can perform the following actions on this page:

  • Add the URL after specifying the Expression and Type.
  • Update after modifying the details. Select the Expression to enable editing of the URL.
  • Delete to remove the URL.
  • Save after adding or modifying any URL in the list.

Profiles

Profiles consist of a common set of parameters that allow users to choose a profile in the macros. Some advantages of using profiles are:

  • Profiles allow user authentication required by some URLs to be hidden from page viewers and editors. Only Confluence administrators have access to this information.
  • Enables macro editors to quickly configure the macro by reusing a shared definition for URL access. 
  • Relative addressing can be used making the page content less likely to require changes when base URLs are relocated. 
    • Macro configured URL (that is not a full URL) is appended to the profile provided URL.

The page displays a list of profiles available for the macros. Click Add Profile to open a pop-up window as:

ParameterDescription
Profile nameEnter a name for the profile.
Profile typeSpecify whether this is a URL, GitLab, or GitHub profile.
URLEnter the URL to be accessed. If the Profile type is either GitLab or GitHub, a default URL is displayed here that is editable.
User; PasswordEnter the username and password to access the specified URL.
Access tokenApplicable for GitLab and GitHub URLs. Administrators must generate the access tokens from either the GitLab or GitHub applications and enter that here.
URL parametersMention any extra parameters that must be appended to the URL here. 
Request headersDisplays the request headers created as per the given information.

You can perform the following actions on this page:

  • Click  to edit the profile details.
  • Click  to remove the profile.
  • Click Save profile to create the profile.