How To Scan Confluence On-Premises

This section covers the following topics:

• Overview
• Licensing
• Requirements
• Set Up and Scan a Confluence On-Premises Target
  • Add Confluence On-Premises as a New Target
  • Scan a Confluence On-Premises Target
• Edit Confluence On-Premises Target Path
• Confluence API Limits
• Remediate Matches in Confluence On-Premises

Overview

When Confluence On-Premises is added as a scan Target, ER Cloud returns all spaces, blog posts, and pages that are accessible to the Confluence user account.

When the Target is probed, you can select specific spaces, blog posts, and/or pages (along with the associated comments and attachments) when setting up the scan schedule.

Example of Confluence On-Premises structure: Confluence On-Premises [host name: my-confluence-server] +- Confluence on target MY-CONFLUENCE-SERVER +- Space Engineering +- Blog Post +- Blog Post A +- Blog Post B +- Space Product +- Page Features +- Page Feature A +- Page Feature B +- Page Release +- Page Release Q1 +- Page Release Q2

To set up and scan Confluence On-Premises as a Target:

1. Check the Requirements.
2. Set Up and Scan a Confluence On-Premises Target.
   1. Add Confluence On-Premises as a New Target.
   2. Scan a Confluence On-Premises Target.

To scan specific paths in a Confluence On-Premises Target, refer to the Edit Confluence On-Premises Target Path section.

Licensing

For Sitewide Licenses, all scanned Confluence On-Premises Targets consume data from the Sitewide License data allowance limit.

For Non-Sitewide Licenses, Confluence On-Premises Targets require one Server & DB License per host machine, and consume data from the Server & DB License data allowance limit.

See Target Licenses for more information.

Requirements

Set Up and Scan a Confluence On-Premises Target

Add Confluence On-Premises as a New Target

1. From the New Scan page, add Targets. Refer to the Add Targets section.
2. In the Select Target Type dialog box, select Server.
3. In the Enter New Target Hostname field, enter the host name of the Confluence server.
4. Click Test. If ER Cloud can connect to the Target, the button changes to a Commit button.
5. Click Commit to add the Target.
6. In the Select Types dialogbox, click Server Applications > Confluence.

7. In the next window, fill in the following details:

   

   Section	Description
   Path details	In the Path field, enter the path to scan. If the field is left blank, all Confluence spaces (on the default connector port) the user or user's Confluence group(s) has "View" permissions to are added. Refer to the Path Syntax table for more information on the path syntax to use.
   Credential Details	If you have stored the credentials, select from Stored Credentials. If not, fill in the following fields: New Credential Label: Enter a descriptive label for the credential set. New Username: Enter the Confluence account user name. New Password: Enter the Confluence account password. "View" space permission is required. Use credentials of either an individual user with "View" space permission, or a user that belongs to a Confluence group with "View" space permission.
   Proxy Details	Select a suitable Agent. Refer to the Requirements - Proxy Agent section.

8. Click Test. If ER Cloud can connect to the Target, the button changes to a Commit button.
9. Click Commit to add the Target.

Scan a Confluence On-Premises Target

1. (Optional) On the Select Locations page, probe the Target to browse and select specific Target locations to scan. Refer to Probe Targets in the Start a Scan section.

   Comments and attachments associated with the selected location(s) are also scanned.
2. Click Next.
3. On the Select Data Types page, select the data type profile to be included in your scan (refer to the Use Data Type Profile section) and click Next.
4. On the Set Schedule page, configure the parameters for your scan. For more information, refer to Set Schedule in the Start a Scan section.
5. Click Next.
6. On the Confirm Details page, review the details of the scan schedule, and click Start Scan to start the scan. Otherwise, click Back to modify the scan schedule settings.

Edit Confluence On-Premises Target Path

To scan a specific path in Confluence On-Premises:

1. Set Up and Scan a Confluence On-Premises Target.
2. In the Select Locations section, select your Confluence On-Premises Target location and click Edit.

3. In the Edit Confluence dialog box, enter the path to scan using the following syntax:

   Location to Scan	Path Syntax
   All spaces	Syntax: [:<port>] If connection to the Confluence server uses a port other than 443, the [:<port>] value must be defined in the Path field. Example: Leave the Path field blank or :9999
   All pages in a specific space	Syntax: [:<port>/]<Space Name> Example: Engineering
   All blog posts in a specific space	Syntax: [:<port>/]<Space Name>/$b Example: Engineering/$b
   A specific blog post in a specific space	Syntax: [:<port>/]<Space Name>/$b/<Blog Post Name> Example: Engineering/$b/New Feature
   All subpages under a specific page	Syntax: [:<port>/]<Space Name>/<Page Name> Example: Engineering/Features
   A specific subpage under a specific page	Syntax: [:<port>/]<Space Name>/<Page Name>/<Page Name> Example: Engineering/Features/Versioning

   Comments and attachments associated with the selected location(s) are also scanned.
4. Click Test and then Commit to save the path to the Target location.

Confluence API Limits

ER Cloud uses REST API to query and retrieve data from Confluence. The number and frequency of REST API requests that users can make can be configured using the rate limiting feature.

When rate limiting is enabled and the Limit requests option is selected, we recommend setting the Requests allowed per node to a value not lower than 1000 requests per minute per user to allow ER Cloud to properly execute scans.

If an organization reaches the configured request limits, the following scan issues may be encountered:

• The scan speed will substantially decrease, and
• The scan schedule will take too long to complete and will be stuck in "Scanning" state.

For more information, refer to Confluence - Rate Limiting.

Remediate Matches in Confluence On-Premises

The following remediation actions are supported for Confluence On-Premises Targets:

• Mark Locations for Compliance Report
• PRO Delegated Remediation

To remediate matches in Confluence On-Premises, refer to the Perform Remedial Actions section.

For more information on the supported remedial actions, refer to the Remedial Actions in ER Cloud section.

PRO This feature is only available in Enterprise Recon Cloud PRO Edition. To find out more about upgrading your ER Cloud license, please contact Ground Labs Licensing. See Subscription License for more information.