admin-guide.md

Admin guide

Prerequisites

For Confluence Plugin, Mattermost server v5.19+ is required. Confluence Server version 7.x+ is supported. Confluence Data Center is not certified.

Installation

To get started, a plugin that is installed on the Mattermost Server is needed to receive messages from the Confluence server. The notifications route it to the correct channel based on subscriptions that are configured.

Manual installation

1. Go to the releases page of this GitHub repositiory, and download the latest release for your Mattermost Server.
2. Upload this file in the Mattermost System Console > Plugins > Management page to install the plugin.
3. Configure the Plugin from System Console > Plugins > Confluence.

Install on Confluence

Now, you'll need to configure your Confluence server to communicate with the plugin on the Mattermost Server. The instructions are different for Cloud vs Server/Data Center.

Set up Confluence Server for server versions less than 9

To get started, type in /confluence install server in a Mattermost chat window.

1. Provide the Confluence base URL in the first step of the installation

2. Select No in the Confluence server version greater than or equal to 9 question in second step of the flow manager

3. Download the Mattermost for Confluence OBR file from the "Releases" tab in the Mattermost-Confluence plugin repository. Each release has a .JAR and an .OBR file. Download it to your local computer. You will upload it to your Confluence server later in this process

4. Log in as an Administrator on Confluence to configure the plugin

5. Create a new app in your Confluence Server by going to Settings > Apps > Manage Apps. For older versions of Confluence, go to Administration > Applications > Add-ons > Manage add-ons

6. Choose Settings at the bottom of the page, enable development mode, and apply the changes. Development mode allows you to install apps from outside of the Atlassian Marketplace

7. Press Upload app

   

8. Upload the OBR file you downloaded earlier

9. Once the app is installed, press Configure to open the configuration page

10. In the Webhook URL field, enter the URL that is displayed after you typed /confluence install server - it is unique to your server. You'll need to copy/paste it from Mattermost into the From this URL field in Confluence

11. Press Save to finish the setup

12. Go to Settings > Apps > Manage Apps

13. Choose Settings at the bottom of the page, enable development mode, and apply the change. Development mode allows you to install apps from outside of the Atlassian Marketplace

    

14. Once installed, you will see the "Installed and ready to go!" message in Confluence

15. You can now go to Mattermost and type /confluence subscribe in the channel you want to get notified by Confluence

Set up Confluence Server for server version greater than or equal to 9

To get started, type in /confluence install server in a Mattermost chat window.

1. Provide the Confluence base URL in the first step of the installation

2. Select No in the Confluence server version greater than or equal to 9 question in installation

3. Log in as an Administrator on Confluence to configure the plugin

4. Create a new application link in your Confluence server by going to Settings > Applications > Application Links

   

5. Select Create link

6. On the Create Link screen, select External Application and Incoming as Application type and Direction respectively. Select Continue

7. On the Link Applications screen, set the values as given in third step of the installation

8. Provide the ClientID and Client Secret in the modal visible at fourth step of the installation

9. Connect your account using the link provided in the fifth step of the installation

10. Create a webhook by following the instructions provided in the sixth step of the installation

11. Once installed, you will see the "You successfully installed Confluence." message in Confluence

12. You can now go to Mattermost and type /confluence subscribe in the channel you want to get notified by Confluence

Set up Confluence Cloud

To get started, type in /confluence install cloud in a Mattermost chat window.

1. Log in as an Administrator on Confluence.

2. Go to Settings > Apps > Manage Apps.

3. Choose Settings at the bottom of the page, enable development mode, and apply the change. Development mode allows you to install apps from outside of the Atlassian Marketplace.

   

4. Press Upload App button.

   

5. In From this URL, enter the URL that is displayed after you typed /confluence install cloud - it is unique to your server. You'll need to copy/paste it from Mattermost into the From this URL field in Confluence.

6. Once installed, you will see the "Installed and ready to go!" message in Confluence.

7. You can now go to Mattermost and type /confluence subscribe in the channel you want to get notified by Confluence.