SW/redmine
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation update

Browse Source
This commit is contained in:
Alexander Meindl
2017-05-10 12:28:17 +02:00
parent 1a0a087477
commit 3116fa6953
1 changed files with 10 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -4,6 +4,16 @@ This plugin posts updates to issues in your Redmine installation to [Slack](http
Redmine Supported versions: 3.0.x.
## Screenshot
Mattermost output:
![screenshot](https://raw.githubusercontent.com/alphanodes/redmine_mattermost/assets/screenshot_mattermost.png)
Redmine configuration:
![screenshot](https://raw.githubusercontent.com/alphanodes/redmine_mattermost/assets/screenshot_redmine_settings.png)
## Installation
Install ``redmine_messenger`` plugin for `Redmine`_
@@ -30,29 +40,6 @@ from being sent for a project, set the custom channel to `-`.
For more information, see [https://www.redmine.org/projects/redmine/wiki/Plugins](https://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 Messenger (Administration > Integrations > Incoming WebHook).
![step1](https://raw.githubusercontent.com/alphanodes/redmine_messenger/assets/step1.png)
Step 2: Install this Redmine plugin for Messenger.
![step2](https://raw.githubusercontent.com/alphanodes/redmine_messenger/assets/step2.png)
Step 3: Configure this Redmine plugin for Messenger. For per-project customized routing, leave the `Messenger Channel` field empty and follow the next steps, otherwise all Redmine projects will post to the same Messenger channel. Be careful when filling the channel field, you need to input the channel's handle, not the display name visible to users. You can find each channel's handle by going inside the channel and click the down-arrow and selecting view info.
![step3](https://raw.githubusercontent.com/alphanodes/redmine_messenger/assets/step3.png)
Step 4: For per-project customized routing, first create the project custom field (Administration > Custom fields > New custom field > Projects).
![step4a](https://raw.githubusercontent.com/alphanodes/redmine_messenger/assets/step4a.png)
![step4b](https://raw.githubusercontent.com/alphanodes/redmine_messenger/assets/step4b.png)
Step 5: For per-project customized routing, configure the Messenger channel handle inside your Redmine project.
![step5](https://raw.githubusercontent.com/alphanodes/redmine_messenger/assets/step5.png)
## Credits
The source code is forked from [https://github.com/altsol/redmine_mattermost](https://github.com/altsol/redmine_mattermost) . Special thanks to the original author and contributors for making this awesome hook for Redmine. This fork is just refactored to use Messenger-namespaced configuration options in order to use all hooks (Rocket.Chat, Mattermost and Slack) in a Redmine installation.