Versions Compared

Old Version 3

changes.mady.by.user Smita Nair

Saved on

compared with

New Version 4

changes.mady.by.user Smita Nair

Saved on

Key

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

The configuration settings affect the way certain parameters of the app's macros work, in general.

...

  1. Log in with the System Administrator global permission.
  2. Navigate to Image Removed > Settings > Atlassian Marketplace on the sidebar.
  3. Scroll to Select Image Added > Manage apps.
  4. Either search for HTML for Confluence or scroll to Bob Swift Configuration, and click HTML to view the  to view app configuration page.
Select Image Removed > Manage apps, either search for HTML for Confluence or scroll to 
Tip
titleTry this for newer older Confluence versions
!
  1. Navigate to Image Added > Settings > Atlassian Marketplace on the sidebar.
  2. Scroll to Bob Swift Configuration
,
  1. and click HTML
 to view app
  1.  to view the configuration page.


The following configuration tabs are available:

Anchor

...

visio_

...

svr_config_global

...

visio_

...

svr_config_global
Global configuration

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

...

ParameterDescription
Disable secure processingToggle Enable this option to allow/disallow let XSLT macros macro to use all XSLT features including external entity resolution. Hsubstituting XML entity references with their actual values. This helps to control secure XSL processing. Available since version 5.1.0.
Restrict URL access

Toggle Enable this option to control whether or not to restrict access to remote locations through the URL parameter on the HTML macro must . The specified URLs in the macro editors must conform to the Confluence Whitelist; provided, whitelisting is enabled. Available since version 5.3.0.

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. If enabled, the URL parameter for the HTML macro is also restricted to only URLs that are configured in the Whitelist settings for Confluence.

Allow JavaScript

Toggle Enable this option to control the usage of Javascript to use Javascript in the HTML macro. When enabled, the user can use Javascript in the HTML and vice versa. Available since version 5.4.0.

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.


Blacklist domains

Toggle Enable this option to control whether or not blacklist certain domains are blacklisted. By  By default, this option is disabled for backward compatibility. Available since version 5.6.0.

If enabled, and if a request from any of these sites is received, an error message is displayed. However, if users still need to access a blacklisted site, they must contact their administrator to disable this option. Click

Note

If this option is disabled, access to all domains is permitted!

Click the link named listed (in the description beneath the option) to view a pre-defined list of the most commonly blacklisted domains in a pop-up window. The following sites are blacklisted, by default:

  • 10.0.0.0/8
  • 100.64.0.0/10
  • 127.0.0.0/8
  • 169.254.0.0/16
  • 172.16.0.0/12
  • 192.168.0.0/16
  • 192.0.0.0/24
  • 198.18.0.0/15
  • 255.255.255.255/32
  • 0.0.0.0/32
  • 192.88.99.0/24
  • 198.51.100.0/24
  • 203.0.113.0/24
  • 224.0.0.0/4
  • 240.0.0.0/4
Help Us Improve the ProductEnable this option to 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. Available since version 5.4.0.

Anchor

...

visio_

...

svr_config_profiles

...

visio_

...

svr_config_profiles
Profiles

Profiles are a common set of parameters used to access content from external locations. Available since 5.7.0. 

...

  • Allow user authentication as required by some URLs to be hidden from page viewers and editors. Only Confluence administrators have access to this information.
  • Enable macro editors to quickly configure the macro by reusing a shared definition for URL access. 
  • Make lesser changes to page contents when base URLs are relocated as relative addressing is used in profiles. 

  • Macro configured URL (that is not a full URL) is appended to the profile provided URL. This absolute URL then points to the actual location of the content to be rendered.

    Note

    The base URL of the remote location to be accessed must be given in profiles, and the raw URL must be entered in the Location of HTML data or Location of XML data fields in the respective macros' editors <parameter here> fields in the macro editor. 

    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.


...

ParameterDescription
Profile name

Enter a name for the profile. Profile names given here are populated in the Profile field in the macro editorseditor.

Note

This name must be unique; else, the details specified overwrites the details of the existing profile. This may cause errors in pages where the profile is used.


Profile typeSpecify whether this is a URL, GitLab, or GitHub address.

The default option for this parameter is URL. 

Info

Currently, only URLs are supported for use in profiles. In the upcoming releases, the support will be extended to access Visio files in other applications such as GitLab and GitHub.


URL

Enter the URL of the remote location to be accessed. It is recommended to provide the base URL here. 

Note

A raw URL must be provided in Location of HTML data and Location of XML datain <parameter here> in the respective macros' editors.

If the Profile type is either GitLab or GitHub, a default URL is displayed here that is editable.


User; Password

Enter the username and password, if required, to access the specified URL. 

Note

Specify either the User and Password parameters or the Access token, as an access token is also a means of user authentication. It is recommended to use either of the user authentication methods but not both.


Access token

Enter an access token or an API token for the application or service to be connected with. 

Note

If this parameter is specified, ensure that the User and Password parameters are left empty. It is recommended to use either of the user authentication methods but not both.

Each application has its own method of generating tokens. Access tokens or API tokens are a means of user authentication; so, if mentioned, this token is used for authentication instead of using user credentials.

  • Tokens are generated for a user after the application or service to be connected verifies the user's credentials. 
  • Enter the generated token here for a seamless connection between the app's macros and the application or service.

Here are some of the links associated with GitLab and GitLab applications to generate a personal access token:

GitLab: Use 

For example, refer to this article to generate

an access token from https://gitlab.com/profile/personal_access_tokens.GitHub: Use this article to generate an access token from https://github.com/settings/tokens. 

a personal access token for Bitbucket.

URL parametersMention any extra parameters (for the query string) that must be appended to the specified URL here. 
Request headersDisplays the request headers created as per the given information. Request headers are name or value pairs that are added to the request. For example, GitHub requires the following request headers be specified: Authorization: token $accessToken, Accept:application/vnd.github.v3.raw

This field is automatically populated with a comma-separated list of name or value pairs using the provided information. If required, enter additional name or value pairs separated with commas.

Click Save profile to create the profile.