Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 4.07 KB

admin-guide.md

File metadata and controls

61 lines (39 loc) · 4.07 KB
Raw

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

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

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

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

  3. 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.

  4. 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.

  5. Press Upload app.

    image

  6. Upload the OBR file you downloaded earlier.

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

  8. 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.

  9. Press Save to finish the setup.

  10. Go to Settings > Apps > Manage Apps.

  11. 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.

    image

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

  13. 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.

    image

  4. Press Upload App button.

    image

  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.