Atlassian Confluence Configuration

Setup Confluence Plugin

Plugin Installation

To manually install the Confluence Plugin on the Confluence instance, the following steps have to be executed:

From the Atlassian Marketplace

Login to the Admin Console
In the Atlassian Marketplace find the Enterprise Search Plugin for Confluence:
Select Install, make yourself familiar with the terms and Accept them:
The plugin is installed successfully:

By uploading the plugin JAR

Login to the Admin Console
Select Manage apps:
Select User-installed:
Click Upload app:
Select the Plugin file:
Once the plugin is uploaded, it will be displayed in the list of installed apps:

Plugin Update

If the Enterprise Search Plugin for Confluence is already installed, make sure you are using the latest version:

Update through the Atlassian Marketplace

If you installed the plugin through the Marketplace, check if a more recent version is available:

Login to the Admin Console
In the Atlassian Marketplace go to Manage apps
Select Update for the Enterprise Search Plugin for Confluence

Update by manual JAR upload

If you installed the plugin by manually uploading its JAR file, and you have a JAR file with a newer version available:

Login to the Admin Console
Select Manage apps
Select User-installed
First, make sure to Uninstall the current plugin:
Then, upload the new JAR as described above

Plugin Configuration

The plugin must be configured after it has been installed. The configuration is persistent and does not need to be re-entered if the instance is shut down or restarted. If you upgrade the plugin to a newer version, the existing configuration will be retained.

To enter the configuration screen for the plugin, open the plugin manager view and select the plugin:

Click on the Configure button to open the configuration screen.

The configuration screen has fields for all editable configuration elements:

To secure the connection, the connector and the Confluence plugin use HTTPS for their communication. Additionally, the plugin can be accessed by an authorized user only which has to be configured in the plugin.

Configuration elements

The plugin contains the following configuration elements:

Authorized Confluence User: The Confluence user which the connector uses to communicate with the plugin. It is the only user which will have access to the plugin’s API.

Setup Personal Access Token (PAT)

Using a personal access token (PAT) for authentication requires Confluence 7.9 or higher.

The initial personal access token that is created here is used by the connector exactly once, to acquire and manage its own PAT.

Please make sure that the total number of PATs created for your user stays below the configured maximum in your Confluence server instance, if needed by revoking unneeded tokens manually in the Confluence user settings. Otherwise the connector will not be able to create its token and run into errors. The default limit is set to 10, but can be adjusted through the system property atlassian.pats.max.tokens.per.user.

The following steps are required to create an initial PAT:

Login to Confluence with the crawl user (the same one that is configured in the Confluence plugin).
Go to account settings:
Select "Personal Access Tokens" in the left bar.
Click on the "Create token" button on the right.
Choose a "Token Name" and click the "Create" button.
Copy the password - this is the only time it is ever shown. If the password is lost, the PAT must be revoked and recreated.
The connector uses the token exactly once to create a token with the settings from the connector. As soon as the connector-owned PAT shows up in the list of PATs, the initial PAT can be safely revoked.