Skip to content

Confluence plugin

Pieter van Ginkel edited this page Nov 25, 2023 · 3 revisions

The Confluence plugin provides access to Confluence spaces, users, attachments, pages and blog posts. Basically it provides the same functionality as the global search feature in Confluence.

Configuration

Use the configuration screen to setup Confluence environments.

You can setup connections to multiple environments if you have access to more than one, e.g. your company and your personal Confluence environment.

Click Add to add a new connection.

A connection to a Confluence environment requires the following fields to be entered:

  • Name of the environment. The name is used to disambiguate multiple environments. It'll be appended to the search category, e.g. "Confluence Search (pvginkel)". This is only done if you have access to more than one environment.
  • URL is the URL to your Confluence environment. This should be something similar to https://yourcompany.atlassian.net/wiki.
  • User name & password.

Confluence supports three ways to authenticate, depending on the type of Confluence environment you're connecting to:

  • If you're using Confluence Cloud, you should create an API key to authenticate. You're using Confluence Cloud if your domain name ends in "atlassian.net" like in the example. The documentation page Manage API tokens for your Atlassian account describes how to create one. When using an API token, enter your email address into the User name field and the API token into the Password field.

  • If you're using self hosted Confluence, you have two options to authenticate TQL:

    • You can try using your own password. To do this, enter your user name (likely your email address) into the User name field, and enter your password into the Password field.

    • You can create a PAT token. The documentation page Using Personal Access Tokens describes how to create one. Leave the User name field empty and enter the PAT token into the password field.

Clone this wiki locally