mattermost-community / mattermost-for-confluence

Publish Confluence Events to Mattermost.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Mattermost for Confluence

CircleCI branch

Publish Confluence Server events to Mattermost. Requires the Mattermost Plugin to be installed and configured on your Mattermost instance.

Developer Setup

  • Refer Instructions here to Install the Atlassian SDK on a (Windows) or (Linux or Mac) system.
  • Refer Instructions here to setup Confluence server locally OR alternatively, you may use the Docker image.
    docker run -v /data/your-confluence-home:/var/atlassian/application-data/confluence --name="confluence" -d -p 8090:8090 -p 8091:8091 atlassian/confluence-server
    

Development

Here are the SDK commands you'll use immediately:

  • atlas-version -- Displays version and runtime information for the Atlassian Plugin SDK. Useful to check if the SDK is installed.
  • atlas-clean -- Removes files generated during the build-time in a project's directory (runs mvn clean).
  • atlas-mvn package -- Packages the plugin artifacts.
  • atlas-mvn checkstyle:check -- Runs checkstyle against all packages.
  • atlas-help -- Prints description for all commands in the SDK.

Note: Full documentation is always available in the Docs.

Manual Installation

  1. Download the Mattermost Confluence Plugin OBR file from the download page.

  2. Open the Confluence administration menu and select Manage apps (must have Admin rights).

    Add-ons

  3. Log in with your Confluence Admin credentials.

  4. Select Upload app.

    UploadAddOn

  5. Browse your computer for the Mattermost Confluence Plugin OBR file you downloaded in Step 1 and click Upload.

  6. The plugin will be uploaded to the Confluence Server and will be automatically installed. Check the Manage apps screen to ensure that the plugin is available.

Configuration

  1. Make sure you have installed the plugin in your Confluence Instance.

  2. Click on Configure from the Manage apps page.

    ManageAddOns

  3. Set the webhook URL: https://SITEURL/plugins/com.mattermost.confluence/api/v1/server/webhook?secret=WEBHOOKSECRET.

    ConfigureAddOn

    • Replace SITEURL with the site URL of your Mattermost instance, and WEBHOOKSECRET with the secret generated in Mattermost via System Console > Plugins > Confluence.
    • Please note that the URL should start with https:// or http:// or it would fail to be saved.

About

Publish Confluence Events to Mattermost.

License:Apache License 2.0


Languages

Language:Java 100.0%