zulip/templates/zerver/integrations/redmine.md

1.7 KiB

Get information on new or updated Redmine issues right in Zulip with our Zulip Redmine plugin!

Note: this setup must be done by a Redmine Administrator.

Installing

Follow the Redmine plugin installation guide. Start by changing to the Redmine instance root directory: cd /path/to/redmine/instance

  1. Clone the Zulip Redmine plugin repository into the plugins subdirectory of your Redmine instance. git clone https://github.com/zulip/zulip-redmine-plugin plugins/redmine_zulip

  2. Update the Redmine database by running (for Rake 2.X, see the guide for instructions for older versions): rake redmine:plugins:migrate RAILS_ENV=production

  3. Restart your Redmine instance.

The Zulip plugin is now registered with Redmine!

Global settings

On your {{ settings_html|safe }}, create a new Redmine bot.

To configure Zulip notification global settings, in Redmine click the Administration link in the top left, then click the Plugins link on the Administration page, and click the Configure link to the right of the Zulip plugin description. Fill out the settings:

  • Zulip URL ({{ zulip_url }})
  • Bot's email address
  • Bot's API key

Project settings

Create the stream you'd like to use for the project's notifications.

Visit the project's Settings page in Redmine, and fill out the Zulip tab:

  • Stream name
  • Get notified on assignments (enable/disable)
  • Get notified on issue updates (enable/disable)
  • Get notified on milestone progress (enable/disable)

{!congrats.md!}