Confluence Plugin

To use the Confluence plugin, Venue.sh requires an API token to communicate with Confluence APIs. This document outlines the process of creating the API token and configuring the plugin.

Generating an API Token

Confluence Cloud

To generate a personal access token for Confluence Cloud, follow these steps:

1. Log in to your Atlassian account:

   • Go to Atlassian Cloud.

2. Navigate to the API Tokens page:

   • Once logged in, click on your profile picture or avatar at the bottom left corner.
   • Select Account settings from the dropdown menu.
   • In the left-hand sidebar, click on Security.
   • Under API tokens, click on Create API token.

3. Create a new API token:

   • Click the Create API token button.
   • Enter a label for your token, such as Venue.sh Token.
   • Click Create.

4. Copy your API token:

   • Click Copy to clipboard to save the token.
   • Important: Save this token in a secure place. You won't be able to see it again!

Confluence Data Center (DC)

To generate a personal access token for Confluence Data Center, follow these steps:

1. Log in to Confluence Data Center:

   • Open your Confluence DC instance and log in with your account.

2. Navigate to Personal Access Tokens:

   • Click on your profile picture or avatar at the top right corner.
   • Select Settings from the dropdown menu.
   • In the left-hand sidebar, find and click on Personal Access Tokens.

3. Generate a new token:

   • Click on Create a personal access token.
   • Fill in the details for the token:
   • Name: Give your token a descriptive name, such as Venue.sh Token.
   • Expiry Date: Optionally, set an expiry date for your token.
   • Permissions: Choose the appropriate permissions required for the token.
   • Click Create.

4. Copy your personal access token:

   • Your new token will be displayed. Click Copy to clipboard to save the token.
   • Important: Save this token in a secure place. You won't be able to see it again!

Configuration

To enable and configure the Confluence plugin, you need to provide several key details. Follow the instructions below to complete the setup.

1. Confluence URL

   • For Confluence Cloud: <atlassian-site-url> /wiki
     • e.g. https://<yourcompany>.atlassian.net/wiki
   • For Confluence Data Center (DC): <confluence-url>
     • e.g. https://confluence.yourcompany.com

2. Space Keys:

   • Provide the keys for the Confluence spaces you want to access. Space keys are unique identifiers for Confluence spaces.
     • e.g.
       • Development
       • Marketing
   • Add one space key per line, using the add button if more items are needed.

3. Instance Type:

   • Select the type of Confluence instance you are using.
     • Confluence Cloud
       • Enter the email address associated with the Confluence user account.
       • Enter the API token generated in the previous step.
     • Confluence Data Center (DC)
       • Enter the API token generated in the previous step.

Following these steps will ensure that the plugin is correctly configured to interact with your Confluence instance. Make sure to keep your API token secure and do not share it publicly.

References

Looking for more information? Check out the following resource:

• Atlassian docs for creating API tokens