Versions Compared

Old Version 14

changes.mady.by.user Kathryn Sandin

Saved on

compared with

New Version Current

changes.mady.by.user Smita Nair

Saved on

Key

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

After upgrading or installing Graphviz for Confluence, navigate to the Global Configuration screen:

  1. Log in with the System Administrator Global Permission.
  2. Select Add-ons from the Image Removed cog icon at the top right corner of your screen.
  3. Scroll down to Bob Swift Configuration on the sidebar.
  4. Select Graphviz, to navigate to the 'Graphviz for Confluence Configuration' page to manage the app configuration.

Configuration Page

The configuration page provides the following tabs for admins:

Global Configuration

Image RemovedAfter installing or updating the app, you can configure the app settings in the Configuration screen. 

Note

The configuration option is available from version 3.2.

To navigate to the screen:

  1. Log in as an administrator and select Cog menu (Image Added) > Manage apps.
  2. Select Graphviz under the BOB SWIFT CONFIGURATION section in the sidebar to open the Graphviz for Confluence Configuration page.

The Configuration page provides the following tabs:

Anchor
gviz_330_globalConfig
gviz_330_globalConfig
Global configuration

Image Added

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

TabParameterDefaultDescription
Restrict URL accessOnOffWhen this option is enabled, the URL parameter in the app is restricted to only the URLs available in CONFLUENCE ADMINISTRATION > General Configuration > USERS & SECURITY > Whitelist.
Help Us Improve the Product OnWhen this option is enabled, it allows us to collect some usage data that will help us improve our product. To learn more about what is being sent, refer to Analytics Data.

Templates

...

This option controls if the macros can access or are restricted from accessing specified URLs. The specified URLs in the macro editors must conform to the Confluence Allowlist; provided, the allowlist is enabled. 

Confluence allows the administrator to turn on allowlist to restrict incoming and outgoing connections to only those connections that are configured in the Allowlist settings. If enabled, the URL to Graphviz file or URL to UML file parameters are also restricted to the URLs that are configured in the Allowlist settings for Confluence only.

Allow JavaScriptOn

This option controls Javascript usage in the Graphviz for Confluence app. Disable this option to restrict execution of JavaScript within the macros. Available since 3.3.

Note

You can also control JavaScript usage on pages that use the Graphviz for Confluence app. Refer to Macro Security Configuration to restrict the usage of JavaScript in the Graphviz macros from the Macro Security for Confluence Configuration page


Blacklist domainsOff

This option controls whether or not certain domains are blacklisted. By default, this option is disabled for backward compatibility. Available since 3.3.

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 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.0.2.0/24
  • 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

Anchor
gviz_330_templates
gviz_330_templates
Templates

Image Added

This tab lists all the default templates provided by Graphviz Diagrams for Confluence. These templates provide users provide users with a quick start to creating diagrams and the respective macro editors are are pre-configured with these templates.

Anchor
profiles
profiles
Profiles

Profiles are a set of basic parameters required to access relevant data from a remote location and render the required graphs on Confluence pages.

Use profiles to:

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

Image Added

The page displays a list of profiles available for the macros. You can perform the following actions on this page:

  • Click Image Added to edit the profile details.
  • Click Image Added to remove the profile.

To create a new profile, click Add Profile to open a pop-up window as:

Image Added

The following table provides further details about the profile settings:

ParameterDescription
Profile name

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

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.
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 the URL to Graphviz/Diagraph/Graph/PlantUML file parameter of the respective macro editor to provide an absolute path to the required file.


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 parameter, 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 GitHub applications to generate a personal access token:

URL parametersMention any extra parameters (for the query string) that must be appended to the specified URL here.
Request headers

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


Info

The Help us improve the product parameter was removed. We do not collect or transmit private user data or personally identifiable information. Refer to the Appfire Trust Center for EULA and other policies.


Additional references

Click any of the following links to learn more about creating profiles:

Child pages (Children Display)
pageTutorials - Server/DC