The Redmineflux In-App Notification Plugin is designed to help users manage notifications within the Redmine application. It allows you to receive updates on specific events, set up notification rules, and review notification history for better tracking and management. This plugin aims to improve the user experience by ensuring that all important changes and updates are communicated effectively.
Version Compatibility
The Redmineflux In-App Notification Plugin is compatible with the following
Redmine Versions:
4.0.x, 4.1.x, 4.2.x
5.0.x
6.0.x(coming soon)
Ensure that your Redmine version matches one of the above for optimal functionality.
Installation
To install Redmineflux In-App Notification Plugin follow these steps: –
Make sure you have a working installation of Redmine.
Unzip the archive and upload the RedminefluxApp Notificationplugin folder to Redmine/plugins and do not change the folder name.
Run the following commands to install the require dependencies bundle install
Run migrate command for database migration 1. In Production
Run the following command to enable real-time notifications. This will establish a connection to the Faye server: rackup faye.ru -E production This command starts a background service that listens for notifications in real-time and enables them to be sent from the server.
Restart Redmine server to load the plugin Rails s
Configuration
Log in to your Redmine instance using administrative credentials
Navigate to Administrator tab from top menu.
Click on “Plugins” and locate the Redmineflux In-App Notification Plugin.
Click on the “Configuration” link for the Redmineflux In-App Notification Plugin.
Select the desired notification settings by checking the appropriate boxes for events like:
Issue added
Issue updated
Note added
Status updated
Assignee updated
Priority updated
Target Version updated
Run the following command to enable real-time notifications. This will establish a connection to the Faye server: rackup faye.ru -E production This command starts a background service that listens for notifications in real-time and enables them to be sent from the server.
Once the Faye server is running, go to the Redmine admin panel and navigate to the plugin configuration settings.
In the settings page, you will see an input field labeled Address of Faye server (leave empty for turned off). To enable real-time notifications, provide the address of your Faye server in this field. Example: http://your_server_ip_or_domain:9292/faye
Click on the “Apply” button to save the changes.
Note: Make sure that the “Notification” checkbox is selected for the events you want to trigger notifications.
How to
How to View Notification Plugin?
To enable and receive notifications, follow these steps:
Go to “My Account” Settings Click on your profile icon, usually located in the top-right corner, to access My Account settings.
Enable In-App Notifications Scroll down to the right side of the page, and find the checkbox labeled In-App Notification. Ensure this checkbox is selected.
After enabling notifications, click the Save button to apply your changes.
Once notifications are enabled, a bell icon will appear on the top-right side of the screen, next to the “Username”.
A red dot will appear next to the notification bell icon when a new notification is received, indicating unread notifications. The dot disappears once the notifications are viewed.
How to Test Notification Settings?
After configuring the notifications, create a test issue or update an existing issue to verify if the notifications are being sent as expected.
Ensure that notifications setting is enabled for the user. Only then will the user receive notifications for the selected events.
How to View Notification History?
Inside the notification modal, click on the See All Notifications link to access the full notification list.
On the See All Notifications page, use the Filter button to view notifications based on your preferences.
At the bottom of the notification list, click on the Mark All as Seen button to mark all unread notifications as seen.
How to enable Real-Time Notifications in the Redmineflux In-App Notification Plugin
Navigate to the Administrator tab from the top menu.
Click on “Plugins” and locate the Redmineflux In-App Notification Plugin.
Click on the “Configuration” link for the Redmineflux In-App Notification Plugin.
In the settings page, you will see an input field labeled Address of Faye server (leave empty for turned off). To enable real-time notifications, provide the address of your Faye server in this field. Example: http://your_server_ip_or_domain:9292/faye
Click on the “Apply” button to save the changes.
How to enable browser desktop notification if my browser supports it
Go to “My Account” Settings Click on your profile icon, usually located in the top-right corner, to access My Account settings.
Enable In-App Notifications Scroll down to the right side of the page, and find the checkbox labeled Use desktop Notifications if my browser supports it. Ensure this checkbox is selected.
Click the Save button to apply your changes.
Troubleshooting
Check plugin compatibility: Ensure that the plugin version is compatible with your Redmine installation. Refer to the plugin documentation, redmineflux.com website, or the official Redmine plugins repository for compatibility information.
Clear cache: If you made any changes to the plugin or Redmine configuration, clear the Redmine cache and restart the application.
Check for conflicts: Disable any other plugins that modify the same fields or interfere with the inline editing feature. Test if the issue persists without those plugins.
Frequently Asked Questions (FAQ’s)
1. What is the Redmineflux In-App Notification Plugin?
The Redmineflux In-App Notification Plugin helps manage notifications in Redmine. It lets users receive updates for specific events, set notification rules, and view notification history for better tracking. The plugin ensures important updates are communicated efficiently.
2. Which Redmine versions are compatible with the Redmineflux In-App Notification Plugin?
The plugin is compatible with the following Redmine versions:
4.0.x,
4.1.x
4.2.x
5.0.x
6.0.x(coming soon)
3. How do I install the Redmineflux In-App Notification Plugin?
To install Redmineflux In-App Notification Plugin follow these steps: –
Make sure you have a working installation of Redmine.
Unzip the archive and upload the Redmineflux In-App Notification plugin folder to Redmine/plugins and do not change the folder name.
Run the following commands to install the require dependencies
bundle install
Run migrate command for database migration 1. In Production
Run the following command to enable real-time notifications. This will establish a connection to the Faye server: rackup faye.ru -E production This command starts a background service that listens for notifications in real-time and enables them to be sent from the server.
Restart Redmine server to load the plugin Rails s
4. How do I configure the Notification Plugin?
Log in to Redmine with administrative credentials.
Navigate to the Administrator tab, click on Plugins, and find the Redmineflux In-App Notification Plugin.
Click on the Configuration link.
Select events for which you want notifications (e.g., Issue added, Issue updated, etc.).
Click Apply to save the settings.
5. How can I test if my notification settings are working?
After configuring your notifications, create or update a test issue in Redmine to check if notifications are being sent according to the selected preferences. A red dot will appear next to the notification bell icon when a new notification is received, indicating unread notifications. The dot disappears once the notifications are viewed.
6. How to enable Real-Time Notifications in the Redmineflux In-App Notification Plugin
Once the Faye server is configured, perform an action in Redmine (e.g., create an issue, update an issue, or change its status) that would trigger a notification.
Check if you receive the real-time notification as expected on your desktop inbottom right corner.
7. If the desktop notification is not working after enabling in the app
To enable setting:
Windows: Go to Settings → System → Notifications & Actions → Ensure that Get notifications from apps and other senders is toggled ON.
macOS: Go to System Preferences → Notifications → Select your browser (e.g., Chrome, Firefox) and make sure notifications are allowed.
Ensure that your browser is allowed to send notifications: Chrome/Edge: Click on the lock icon in the browser’s address bar, then check if Notifications are allowed for the website. Firefox: Click the site info icon (lock icon), then check Permissions and make sure notifications are enabled for the site.
Go to Redmineflux In-App Notification plugins directory in Redmine.
Delete the entire Redmineflux In-App Notification plugin directory from Redmine/plugins directory. This step removes the plugin files from your Redmine installation.
If the plugin required a migration, run the following command to downgrade your database (make a db backup before):
Bundle exec rake redmine:plugins:migrate Name=plugin name VERSION=0 RAILS_ENV=production
The Redmineflux In-App Notification Plugin provides an easy way to manage notifications within your Redmine environment. By following this guide, you should be able to install, configure, and troubleshoot the plugin to suit your needs. For further assistance, please refer to the support documentation or contact the development team.
