CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-21 21:32:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update redmine integration documentation.

Browse Source 
With some textual tweaks by tabbott.
This commit is contained in:
Lobster 2019-10-23 17:21:34 +02:00 committed by Tim Abbott
parent 87b23720f5
commit 7e4f8a42cf
1 changed files with 27 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
templates/zerver/integrations/redmine.md
View File

@ -5,45 +5,51 @@ _Note: this setup must be done by a Redmine Administrator._
### Installing
Follow the [Redmine plugin installation guide][1]. Start by changing
to the Redmine instance root directory: `cd /path/to/redmine/instance`
Following the [Redmine plugin installation guide][1]:
1. Start by changing to the Redmine instance root directory:
`cd /path/to/redmine/instance`
1. Clone the [Zulip Redmine plugin repository][2] 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
1. 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.
1. Restart your Redmine instance.
The Zulip plugin is now registered with Redmine!
### Global settings
On your {{ settings_html|safe }}, create a new Redmine bot.
1. 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:
2. Log into your Redmine instance, click on **Administration** in the top-left
corner, then click on **Plugins**.
* Zulip URL (`{{ zulip_url }}`)
* Bot's email address
* Bot's API key
3. Find the **Redmine Zulip** plugin, and click **Configure**. Fill
out the following fields:
* 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 can use the following variables in these fields:_
* ${issue_id}
* ${issue_subject}
* ${project_name}
* ${version_name}
### 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)
To override the global settings for a specific project, go to the
project's **Settings** page, and select the **Zulip** tab.
{!congrats.md!}