Sitemap Generating User

Atlassian Confluence user, used to generate the sitemap. Default: admin

Sitemap Downloader Group

Only members of the given Atlassian Confluence group are allowed to download the sitemap. Default: confluence-users

ACL Encryption Password

A password used for encrypting the ACL elements. If this parameter is left empty, the ACL elements will not be encrypted.

Confluence Base URL

the base URL that should be used for generating the links in the sitemap.

Sitemap Cache Directory

A directory where the generated sitemap.xml is stored on the Atlassian Confluence Server.

Disable Parent Reference Metadata for Pages

If enabled, no reference metadata to the parent document is generated for Confluence pages. This reduces the number of database queries.

Add Performance Metrics to Sitemap

If enabled, the times required for sitemap generation tasks are entered as comments in the sitemap.

ACL Exempt Group Name (ex. confluence-administrators)

Group that has read-access to all Confluence Content regardless of the explicit rights.

Custom Content Property Key Pattern

With this option, custom content properties can be included in the sitemap. A regular expression is defined that matches the name of the custom content properties (without the prefix custprop_ ). Matching properties are included in the sitemap. Note: Custom Content Property values of type JSON Object, are flattened into one or more metadata. Furthermore, custom content properties are only supported for pages and not for attachments. Default value: not set. Example values: .* (includes all custom content properties) or myProp.* (includes all custom content properties that begin with myProp, e.g. myPropLikes). Note: This feature is only supported for Confluence Version 5.6+.

Delta Sitemap Containing Last Modified Sites Minutes

The delta sitemap contains all documents that have been changed in the last minutes. How many minutes this actually is can be configured with this option. If this option is not set, the delta sitemap will not contain any <url> elements.

Generate REST URLs

Instead of the normal Confluence Sitemap URLs, REST API URLs are generated which are set as document key in the Confluence crawler. This has the advantage, for example, that no temporary duplicates are created during a delta crawl run if the title of pages has been changed.

If you enable this option, please also make sure that the option "Use Rest API for Page Content" is active in the Atlassian Confluence Crawler.

Attention: If you have already indexed Confluence and want to enable or disable this option afterwards, you need an empty index before changing this option. This would otherwise lead to document duplicates, since the mes:key scheme changes in the process.

REST URL Base Path

If the REST API endpoint is not located directly on <your-confluence-url>/rest/api, the "REST URL Base Path" can be specified. For example, if it is located at <your-confluence-url>/mybasepath/rest/api, the "REST URL Base Path" value must be /mybasepath.

Include Labels

If active, label metadata ("labels") for sites, spaces and attachments are included in the sitemap.