Installation guide
Instructions for installing the plugin «Luxury Buttons»
Follow these steps to prepare your Redmine instance, install the plugin, and keep it up to date.
Compatibility
| Redmine | Ruby | Rails | Database | Browser | |
|---|---|---|---|---|---|
| Guaranteed | 5.1.8 | 3.2.8 | 6.1.7.10 | MySQL | Chrome, Firefox, Edge, Safari |
| Should work | >= 5, <= 6.1 | > 2.5, <=3.2 | x | PostgreSQL, MSSQL | Any modern browser |
Installation and Update
- Download the plugin version that matches your Redmine version.
- Remove old versions of plugins from Redmine, if they exist.
- Copy the new luxury_buttons plugin folder to redmine/plugins/.
- Copy the new a_common_libs plugin folder to redmine/plugins/.
- Run
bundle installto install missing gems in the Redmine root folder. - Run the migrations:
bundle exec rake redmine:plugins:migrate RAILS_ENV=production - Restart your web-server.
After installation
For the plugin to work properly, enable the module «Luxury Buttons» in settings of each project where you will use buttons.
We do not recommend using the permission settings of the status transition and rights of the fields visibility that are available in the standard «Redmine». Such settings may lead to conflicts that are difficult to track.
To disable these settings:
- Go to «Luxury Buttons» module settings.
- Enable options «Ignore limitation in «Transitions» settings section» and «Ignore limitation in «Field permissions» settings section». This eliminates the need to prescribe permission status-transitions in default Redmine settings. Exceptions work only for projects where the module Luxury Buttons is enabled.
Plugin «Luxury Buttons» sets restrictions on the creation of issues with a specific tracker by roles. Therefore, it is necessary to specify which roles can create issues with a specific tracker. Otherwise, your users will not be able to create an issue.
To perform these settings:
- Go to the menu item «Administration → Trackers».
- Choose a specific tracker.
- Select the roles who can create issues with this tracker.
- Repeat this procedure for all the trackers.