Notification

Introduction #

The Redmineflux Notification Plugin helps users manage important updates inside Redmine. It provides notifications for issue activity, supports real-time notification delivery through Faye, and allows users to review notification history from a dedicated notification page.

The plugin also includes Microsoft Teams and Slack integrations. Administrators can configure global Teams and Slack notification settings, while project managers can route notifications to project-specific Teams channels or Slack channels. A project-wise disable option is also available when notifications should be turned off for a specific project.

The plugin helps teams stay informed about important Redmine activity such as new issues, issue updates, notes, status changes, assignee changes, and priority changes.

Version Compatibility #

The Redmineflux Notification Plugin is compatible with the following Redmine versions:

Redmine Version	Supported
5.0.x	Yes
6.0.x	Yes

Make sure your Redmine version matches one of the supported versions for best results.

Installation #

To install the Redmineflux Notification Plugin, follow these steps.

1. Make sure you have a working Redmine installation.
2. Unzip the plugin archive.
3. Upload the plugin folder to the Redmine plugins directory.
4. Do not change the plugin folder name. The folder should remain:

   redmineflux_notification

5. Go to the Redmine root directory:

   cd /path/to/redmine

6. Install required dependencies:

   bundle install

7. Run the plugin migration.

   For production:

   RAILS_ENV=production bundle exec rails redmine:plugins:migrate

   For development:

   RAILS_ENV=development bundle exec rails redmine:plugins:migrate

8. Optional: start the Faye server for real-time notifications:

   rackup plugins/redmineflux_notification/faye.ru -E production

   This command starts a background service that listens for real-time notifications and sends them from the server to the browser.

9. Restart the Redmine server:

   rails s

For production environments, restart your configured application server, such as Puma, Passenger, or another Redmine deployment service.

Configuration #

To configure the plugin:

1. Log in to Redmine using administrator credentials.
2. Navigate to Administration from the top menu.
3. Click Plugins.
4. Locate Redmineflux Notifications plugin.
5. Click Configure.

The plugin configuration page contains three main tabs:

Tab	Purpose
Redmine Notifications	Configure notification events and Faye server address.
Teams Notifications	Configure global Microsoft Teams notification settings.
Slack Notifications	Configure global Slack notification settings.

Redmine Notification Configuration #

The Redmine Notifications tab controls notification events.

Select the desired notification events by checking the required boxes:

• Issue added
• Issue updated
• Issue note added
• Issue status updated
• Issue assigned
• Issue priority updated
• Issue target version updated

When a selected event occurs, the plugin creates notifications for notified users and watchers. The user who performs the action does not receive a notification for their own update.

Faye Server Address #

To enable real-time notifications, enter the Faye server address in:

Address of faye server (leave empty for turned off)

Example:

http://your_server_ip_or_domain:9292/faye

Leave this field empty if you do not want real-time browser updates. Notifications will still be stored and visible from the notification page.

Click Apply to save the settings.

Microsoft Teams Notification Configuration #

The plugin supports Microsoft Teams notifications using incoming webhook URLs.

Teams settings are available at:

Administration > Plugins > Redmineflux Notifications plugin > Configure > Teams Notifications

Global Teams Settings #

Use global Teams settings when all projects should send notifications to one Teams channel.

1. Open Microsoft Teams.
2. Go to the channel where Redmine notifications should be posted.
3. Create an Incoming Webhook.
4. Copy the webhook URL.
5. In Redmine, open the plugin configuration page.
6. Go to the Teams Notifications tab.
7. Enable Microsoft Teams notifications.
8. Paste the webhook URL into Global Teams Webhook URL.
9. Configure the notification options.
10. Click Apply.

Teams Notification Options #

Option	Description
Enable Microsoft Teams notifications	Turns Teams notification delivery on or off globally.
Global Teams Webhook URL	Default Teams webhook URL used by projects that do not have their own Teams webhook.
Display watchers in notifications	Includes issue watchers in Teams messages.
Post issue updates	Sends Teams notifications when existing issues are updated.

Teams Notification Behavior #

Teams notifications are sent for:

• New issue creation
• Issue updates, if Post issue updates is enabled
• Notes added to issues
• Field changes such as status, priority, assignee, category, target version, and custom fields

Teams messages include useful issue details such as:

• Project name
• Issue link
• Author or updater
• Status
• Priority
• Assignee
• Watchers, when enabled
• Notes and changed fields for issue updates

Private issues and private notes are not posted to Teams.

Slack Notification Configuration #

The plugin supports Slack notifications using the Slack Web API and a Slack bot token.

Slack settings are available at:

Administration > Plugins > Redmineflux Notifications plugin > Configure > Slack Notifications

Global Slack Settings #

Use global Slack settings when all projects should send notifications to one default Slack channel.

1. Create a Slack app in your Slack workspace.
2. Add the required bot token scopes.
3. Install the Slack app to your workspace.
4. Copy the Bot User OAuth Token. It usually starts with xoxb-.
5. In Redmine, open the plugin configuration page.
6. Go to the Slack Notifications tab.
7. Enable Slack Notifications.
8. Paste the token into Slack Bot Token.
9. Enter the Slack Signing Secret, if required by your Slack app setup.
10. Enter the Default Slack Channel.
11. Keep Verify SSL enabled unless your environment requires SSL verification to be disabled.
12. Configure the notification options.
13. Click Apply.

Recommended Slack Bot Scopes #

Your Slack app should have permission to post messages to the channels used by Redmine.

Common scopes include:

• chat:write
• channels:read
• groups:read, if posting to private channels

Invite the Slack bot to any channel where Redmine notifications should be posted.

Slack Notification Options #

Option	Description
Slack Notifications	Turns Slack notification delivery on or off globally.
Slack Bot Token	Bot User OAuth Token used to call Slack’s chat.postMessage API.
Slack Signing Secret	Signing secret from the Slack app configuration.
Default Slack Channel	Default channel used when a project does not have its own Slack channel.
Verify SSL	Verifies SSL certificates for Slack API calls.
Display watchers in notifications	Includes issue watchers in Slack messages.
Post issue updates	Sends Slack notifications when existing issues are updated.

Slack Notification Behavior #

Slack notifications are sent for:

• New issue creation
• Issue updates, if Post issue updates is enabled
• Notes added to issues
• Field changes such as status, priority, assignee, category, target version, and custom fields

Slack messages include useful issue details such as:

• Project link
• Issue link
• Author or updater
• Status
• Priority
• Assignee
• Watchers, when enabled
• Notes and changed fields for issue updates

Project-Wise Notification Settings #

The plugin includes project-specific notification controls.

Disable Notifications for a Project #

Project notifications can be disabled from the project settings page.

When this option is enabled, the plugin skips email and notifications for that project.

This is useful for:

• Archived projects
• Imported projects
• Test projects
• Projects where notification noise should be avoided

Project-Wise Microsoft Teams Settings #

If Teams notifications are enabled globally, each project can use:

• The global Teams webhook URL
• A dedicated project-specific Teams webhook URL

This allows every project to send notifications to its own Teams channel.

Project-Wise Slack Settings #

If Slack notifications are enabled globally, each project can use:

• The global default Slack channel
• A dedicated project-specific Slack channel

This allows every project to send notifications to its own Slack channel.

How To #

This section explains common plugin workflows.

How to View Notification Plugin #

To enable and receive notifications:

1. Go to My Account.
2. Open Preferences.
3. Find the checkbox labeled Notifications.
4. Select the checkbox.
5. Click Save.

After notifications are enabled, a notification icon appears in the top-right area of Redmine near the username.

When a new notification is received, a red dot appears next to the notification icon. The dot disappears after the notifications are viewed.

How to Test Notification Settings #

After configuring notifications:

1. Make sure the required event is enabled in plugin settings.
2. Make sure the receiving user has enabled Notifications in My Account > Preferences.
3. Create a test issue or update an existing issue.
4. Confirm that the notification appears for the target user.
5. If real-time notifications are enabled, confirm that the browser notification count updates automatically.

For Teams and Slack testing:

1. Confirm Teams or Slack is enabled globally.
2. Confirm the webhook, token, or channel configuration is correct.
3. Create or update a test issue.
4. Confirm the message appears in the configured Teams or Slack channel.

How to View Notification History #

To view notification history:

1. Click the notification icon in the Redmine top menu.
2. Click See All Notifications.
3. Use the filter options to view:
   • New Notifications
   • Viewed Notifications
4. Click Filter.
5. Use Mark all as seen to mark all unread notifications as viewed.

Opening an individual notification marks it as viewed and redirects the user to the related issue.

How to Enable Real-Time Notifications #

Real-time notifications require the Faye server.

1. Start the Faye server:

   rackup plugins/redmineflux_notification/faye.ru -E production

2. Log in to Redmine as an administrator.
3. Go to Administration > Plugins.
4. Locate Redmineflux Notifications plugin.
5. Click Configure.
6. Go to the Redmine Notifications tab.
7. Enter the Faye server URL in Address of faye server.

   Example:

   http://your_server_ip_or_domain:9292/faye

8. Click Apply.

After this, perform an action that triggers a notification, such as creating or updating an issue. The notification should appear in real time for the receiving user.

How to Enable Browser Desktop Notifications #

To enable browser desktop notifications:

1. Go to My Account.
2. Open Preferences.
3. Enable Notifications.
4. Enable Use desktop notifications if my browser supports it.
5. Click Save.

Also make sure your operating system and browser allow notifications.

Windows #

1. Go to Settings > System > Notifications.
2. Make sure notifications are enabled.
3. Make sure your browser is allowed to send notifications.

macOS #

1. Go to System Settings > Notifications.
2. Select your browser.
3. Allow notifications for that browser.

Chrome or Edge #

1. Open Redmine in the browser.
2. Click the lock icon in the address bar.
3. Set Notifications to Allow.

Firefox #

1. Open Redmine in Firefox.
2. Click the site information icon near the address bar.
3. Open permissions.
4. Allow notifications for the site.

How to Configure Project-Wise Microsoft Teams Notifications #

Before configuring project-specific Teams notifications, Teams must be enabled globally.

Step 1: Enable Teams Globally #

1. Go to Administration > Plugins.
2. Open Redmineflux Notifications plugin > Configure.
3. Go to Teams Notifications.
4. Enable Microsoft Teams notifications.
5. Add the global Teams webhook URL.
6. Click Apply.

Step 2: Enable Project Module #

1. Open the project.
2. Go to Settings > Modules.
3. Enable Teams Notifications.
4. Save the project.

Step 3: Configure Project Teams Settings #

1. Open the project.
2. Go to Settings > Teams Notifications.
3. Enable project-specific Teams notifications.
4. Enter the project Teams webhook URL.
5. Select whether watchers should be displayed.
6. Select whether issue updates should be posted.
7. Click Save.

Teams Routing Rules #

Project Configuration	Result
Project-specific Teams enabled with webhook	Notifications are sent to the project Teams channel.
Project-specific Teams disabled	Notifications use the parent project or global Teams webhook.
No project or global webhook configured	Teams notifications are not sent.

How to Configure Project-Wise Slack Notifications #

Before configuring project-specific Slack notifications, Slack must be enabled globally.

Step 1: Enable Slack Globally #

1. Go to Administration > Plugins.
2. Open Redmineflux Notifications plugin > Configure.
3. Go to Slack Notifications.
4. Enable Slack Notifications.
5. Enter the Slack bot token.
6. Enter the default Slack channel.
7. Click Apply.

Step 2: Enable Project Module #

1. Open the project.
2. Go to Settings > Modules.
3. Enable Slack Notifications.
4. Save the project.

Step 3: Configure Project Slack Settings #

1. Invite the Slack bot to the project Slack channel.
2. Open the project in Redmine.
3. Go to Settings > Slack Notifications.
4. Enable project-specific Slack notifications.
5. Enter the project Slack channel.
6. Select whether watchers should be displayed.
7. Select whether issue updates should be posted.
8. Click Save.

Slack Routing Rules #

Project Configuration	Result
Project-specific Slack enabled with channel	Notifications are sent to the project Slack channel.
Project-specific Slack disabled	Notifications are sent to the global default Slack channel.
No project or global channel configured	Slack notifications are not sent.

How to Disable Notifications for a Project #

To disable notifications for a specific project:

1. Open the project.
2. Go to Settings.
3. Find the Notifications section.
4. Enable Disable notifications.
5. Save the project.

When enabled, email and notifications are skipped for that project.

Troubleshooting #

Notifications Are Not Showing #

• Confirm the notification event is enabled in plugin settings.
• Confirm the receiving user enabled Notifications in My Account > Preferences.
• Confirm the receiving user is a notified user or watcher for the issue.
• Confirm Disable notifications is not enabled for the project.
• Remember that the author of an issue update does not receive a notification for their own change.
• Clear Redmine cache and restart the application if configuration was recently changed.

Real-Time Notifications Are Not Working #

• Confirm the Faye server is running.
• Confirm the Faye server address is correct in plugin settings.
• Confirm the Redmine server can reach the Faye endpoint.
• Confirm the browser is not blocking the Faye request.
• Check Redmine logs for connection errors.

Browser Desktop Notifications Are Not Working #

• Confirm Use desktop notifications if my browser supports it is enabled in My Account > Preferences.
• Confirm browser notifications are allowed for your Redmine site.
• Confirm operating system notifications are enabled.
• Try disabling browser extensions that may block notifications.

Microsoft Teams Notifications Are Not Working #

• Confirm Microsoft Teams notifications is enabled globally.
• Confirm the Teams webhook URL is valid.
• Confirm the project-specific webhook is valid, if used.
• Confirm the issue is not private.
• Confirm Post issue updates is enabled when testing issue updates.
• Check production.log for Teams notification error.

Slack Notifications Are Not Working #

• Confirm Slack Notifications is enabled globally.
• Confirm the Slack bot token is valid.
• Confirm the bot has been invited to the target Slack channel.
• Confirm the default or project-specific channel is correct.
• Confirm Post issue updates is enabled when testing issue updates.
• Check production.log for [SLACK] errors.

Plugin Conflict or UI Issues #

• Confirm the plugin version is compatible with your Redmine version.
• Clear Redmine cache and restart Redmine.
• Temporarily disable other plugins that customize issue notifications, issue hooks, or project settings.
• Re-enable plugins one by one to identify conflicts.

Frequently Asked Questions #

Q1. What is the Redmineflux Notification Plugin?

The Redmineflux Notification Plugin helps manage notifications in Redmine. It lets users receive notifications for issue activity, review notification history, and optionally receive browser desktop notifications. It also supports Microsoft Teams and Slack notifications.

Q2. Which Redmine versions are compatible with the plugin?

The plugin is compatible with:

• Redmine 5.0.x
• Redmine 6.0.x

Q3. How do I install the plugin?

Upload the redmineflux_notification folder to the Redmine plugins directory, run bundle install, run the plugin migrations, optionally start Faye for real-time notifications, and restart Redmine.

Q4. How do I configure notifications?

Go to Administration > Plugins > Redmineflux Notifications plugin > Configure > Redmine Notifications. Select the issue events that should generate notifications and click Apply.

Q5. How do I test notification settings?

Create or update a test issue after enabling the desired notification event. Make sure the receiving user has enabled notifications in My Account > Preferences.

Q6. Why did the issue author not receive a notification?

The plugin does not send a notification to the user who performed the action. Notifications are sent to other notified users and watchers.

Q7. How do I enable real-time notifications?

Start the Faye server and enter the Faye URL in the plugin setting Address of faye server.

Example:

http://your_server_ip_or_domain:9292/faye

Q8. How do I configure Microsoft Teams notifications?

Go to Administration > Plugins > Redmineflux Notifications plugin > Configure > Teams Notifications. Enable Teams notifications, enter the global Teams webhook URL, configure options, and save.

Q9. Can each project use a different Teams channel?

Yes. Enable the Teams Notifications module in the project, then configure a project-specific Teams webhook from Project > Settings > Teams Notifications.

Q10. How do I configure Slack notifications?

Go to Administration > Plugins > Redmineflux Notifications plugin > Configure > Slack Notifications. Enable Slack notifications, enter the Slack bot token, set the default Slack channel, configure options, and save.

Q11. Can each project use a different Slack channel?

Yes. Enable the Slack Notifications module in the project, then configure a project-specific Slack channel from Project > Settings > Slack Notifications.

Q12. Can I disable notifications for one project only?

Yes. Open the project settings and enable Disable notifications in the Notifications section. This skips email and notifications for that project.

Q13. Why are Slack messages not appearing?

Check that Slack is enabled globally, the bot token is valid, the bot is invited to the channel, and the channel name is configured correctly.

Q14. Why are Teams messages not appearing?

Check that Teams is enabled globally, the webhook URL is valid, and the issue is not private.

Uninstallation #

To uninstall the Redmineflux Notification Plugin:

1. Go to the Redmine root directory.
2. Roll back the plugin migrations. Make a database backup before running this command.

   RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=redmineflux_notification VERSION=0

3. Remove the plugin directory:

   rm -rf plugins/redmineflux_notification

4. Restart the Redmine server.

This removes the Redmineflux Notification Plugin from your Redmine installation.

Conclusion #

The Redmineflux Notification Plugin provides an easy way to manage Redmine notifications from one place. Users can receive in-app and desktop notifications, administrators can configure notification events, and teams can route issue activity to Microsoft Teams or Slack.

With project-wise controls, teams can decide whether each project should use global notification settings, dedicated Teams and Slack channels, or disable notifications when needed.

For further assistance, refer to the Redmineflux documentation or contact the Redmineflux support team.