Versions Compared

Old Version 2

changes.mady.by.user Smita Nair

Saved on

compared with

New Version 3

changes.mady.by.user Smita Nair

Saved on

Key

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

...

Image Removed

...

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

  1. Log in with the System Administrator Global Permission.
  2. Navigate to Image Added > Settings > Manage apps on the sidebar.
  3. Expand the Bob Swift Atlassian Add-ons - Markdown app from the list of apps.
  4. Click Configure to open the HTML for Confluence page where you can manage the app configuration.

The HTML for Confluence Configuration settings are categorized into three tabs as:

  • Global configuration
  • Whitelist
  • Profiles

Anchor
HTML_Cld_GlobalConfig
HTML_Cld_GlobalConfig
Global configuration

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


ParameterDescription
Restrict URL access

This parameter controls whether or not the URL parameter on the HTML for Confluence macro must conform to the Confluence Whitelist provided whitelisting is enabled.

Confluence allows the administrator to turn on whitelisting to restrict incoming and outgoing connections to only those connections that are configured in the Whitelist settings. By enabling this option, the URL parameter for the macro is also restricted to only URLs that are configured in the Whitelist settings for Confluence.

Allow JavaScript
This parameter is available with version 5.4.0. Help Us Improve the ProductThis parameter is available with version 5.4.0. When enabled, this option allows us to collect some usage data that helps us improve our product. To learn more about what is being sent, refer to Analytics data

This option controls the usage of Javascript in the HTML macro. When enabled, the user can use Javascript in the HTML and vice versa.

Note

You can also control Javascript usage on pages that are using the HTML macro by enabling the html.allowJavascript macro in the Macro Security for Confluence Configuration page. To know how to enable this macro, refer to Macro Security Configuration.

Help Us Improve the ProductEnabling 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.

Anchor
HTML_Cld_Whitelist
HTML_Cld_Whitelist
Whitelist

Manage the URLs that the app can access from this page. 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.

Anchor
HTML_Cld_Profiles
HTML_Cld_Profiles
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:

Image Added

ParameterDescription
Profile nameEnter a name for the profile.
Profile typeDisplays URL as selected, by default. 
URLEnter the URL to be accessed.
User; PasswordEnter the user name and password to access the specified URL.
Access tokenEnter the access token to access the specified URL, if needed. Users must generate the access tokens from the required 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 Image Added to edit the profile details.
  • Click Image Added to remove the profile.
  • Click Save profile to create the profile.