diff --git a/README.md b/README.md index bd41bc2..c2b91ac 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ This plugin posts updates to issues in your Redmine installation to a Mattermost channel. -Redmine Supported versions: 2.0.x - 3.1.x. +Redmine Supported versions: 2.0.x - 3.1.x (3.2.x is not yet tested but should work). ## Screenshot @@ -24,7 +24,7 @@ from the plugin directory. Restart Redmine, and you should see the plugin show up in the Plugins page. Under the configuration options, set the Mattermost API URL to the URL for an -Incoming WebHook integration in your Mattermost account. +Incoming WebHook integration in your Mattermost account (see also the next two sections). ## Customized Routing @@ -34,7 +34,30 @@ named `Mattermost Channel`. If no custom channel is defined for a project, the p project will be checked (or the default will be used). To prevent all notifications from being sent for a project, set the custom channel to `-`. -For more information, see http://www.redmine.org/projects/redmine/wiki/Plugins. +For more information, see http://www.redmine.org/projects/redmine/wiki/Plugins (see also next section for an easy configuration demonstration). + +## Screenshot Guided Configuration + +Step 1: Create an Incoming Webhook in Mattermost (Account Settings > Integrations > Incoming Webhooks). + +![step1](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step1.png) + +Step 2: Install this Redmine plugin for Mattermost. + +![step2](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step2.png) + +Step 3: Configure this Redmine plugin for Mattermost. For per-project customized routing, leave the `Mattermost Channel` field empty and follow the next steps, otherwise all Redmine projects will post to the same Mattermost channel. + +![step3](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step3.png) + +Step 4: For per-project customized routing, first create the project custom field (Administration > Custom fields > Project). + +![step4a](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step4a.png) +![step4b](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step4b.png) + +Step 5: For per-project customized routing, configure the Mattermost channel inside your Redmine project. + +![step5](https://raw.githubusercontent.com/altsol/redmine_mattermost/assets/step5.png) ## Credits