Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 1.42 KB

README.md

File metadata and controls

61 lines (42 loc) · 1.42 KB
Raw

Redmine Zulip Plugin

Get Zulip notifications for your Redmine issues!

Compatibility

Redmine Zulip Plugin version Redmine version
1.x 3.x
2.x 3.x
3.x 4.x

Installing

  1. Please navigate to your Redmine instance's root directory by running:
cd /path/to/redmine
  1. Clone the Redmine Zulip Plugin into plugins directory
git clone https://github.com/zulip/zulip-redmine-plugin.git plugins/redmine_zulip

  1. Restart your Redmine instance

  2. Update the Redmine database by running:

rake redmine:plugins:migrate

Configuring plugin settings

Log into your Redmine instance, click on Administration in the top-left corner, then click on Plugins.

Find the Redmine Zulip plugin, and click Configure. You must now set the following:

  • Zulip URL (e.g https://yourZulipDomain.zulipchat.com/)
  • Zulip Bot E-mail
  • Zulip Bot API key
  • Stream name *
  • Issue updates subject *
  • Version updates subject *

* You may set dynamic values by using the following self-explanatory variables:

  • ${issue_id}
  • ${issue_subject}
  • ${project_name}
  • ${version_name}

Project settings

To override global settings project wise, go to your project's Settings page, and select the Zulip tab.