https://github.com/zulip/zulip-redmine-plugin
Redmine plugin for Zulip notifications on issue tracker changes
https://github.com/zulip/zulip-redmine-plugin
Last synced: 3 months ago
JSON representation
Redmine plugin for Zulip notifications on issue tracker changes
- Host: GitHub
- URL: https://github.com/zulip/zulip-redmine-plugin
- Owner: zulip
- License: apache-2.0
- Created: 2013-09-24T15:41:30.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T17:39:14.000Z (about 1 year ago)
- Last Synced: 2025-01-13T07:35:25.470Z (3 months ago)
- Language: Ruby
- Size: 50.8 KB
- Stars: 12
- Watchers: 20
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
0. Please navigate to your Redmine instance's root directory by running:
```sh
cd /path/to/redmine
```
1. Clone the **Redmine Zulip Plugin** into `plugins` directory
```sh
git clone https://github.com/zulip/zulip-redmine-plugin.git plugins/redmine_zulip
```
2. **Restart** your Redmine instance
3. Update the Redmine database by running:
```sh
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.