UX Upgrade Plugin

RedmineX UX Upgrade is a premium plugin that transforms the Redmine user interface with a modern, intuitive design and enhanced user experience. The plugin includes a comprehensive theme and UX improvements that make Redmine more accessible and visually appealing.

Prerequisities

• Redmine installation (compatible with Redmine 6.x+)

• Access to Redmine root directory

• Bundle/gem installation capabilities

Installation Steps

1. Extract Plugin Files

Unzip the archive and upload the folder 000_redmine_x_ux_upgrade to redmine_root/plugins. Alternatively, upload the archive and unzip it in the console:

2. Install Dependencies

From the Redmine root directory, run:

3. Restart Redmine

Restart your Redmine instance based on your web server:

4. Setup Theme (Redmine 6.x+ Only)

1. Navigate to `~/settings/plugin/000_redmine_x_ux_upgrade` in your Redmine instance

2. Check "Show time log in menu"

3. SAVE the settings page

5. Activate Plugin Settings

If you are using Redmine 6+, ensure the theme is present in redmine_root/themes/redminex_theme/. Execute the following commands:

Update Process

1. Remove Old Version

Navigate to the plugins directory and remove the existing plugin folder:

Upload and unzip the new version in the same location.

2. Remove Leftover Files

Clean up old assets and theme files:

3. Reinstall Dependencies

From the Redmine root directory:

5. Update Theme (Redmine 6.x+ Only)

If using Redmine 6+, ensure the theme is present in redmine_root/themes/redminex_theme/. If missing, manually copy it:

Translation Support

The plugin automatically uses Redmine's existing language strings. Simply switch to your preferred language in Redmine settings, and all strings will be translated automatically.

Home Item Behavior

The plugin removes the "Home" menu item as part of the improved UX. After login, users are redirected to "My Page" for a more personalized experience.

Customizing Company Logo

Replace the default Redmine logo with your company's branding to personalize the interface.

1. Navigate to your-redmine.com/settings/plugin/000_redmine_x_ux_upgrade

2. Upload your company logo

3. Recommended proportions: similar to the original logo

Customizing Login Images

To change the login image, you will need to upload 2 images - for desktop and mobile. No need to restart Redmine, just remove your browser cache / website data, especially when using Chrome. These images get uploaded into the public/themes/redminex_theme/images folder so please make sure the default images are not cached.

• Desktop version: ~2000px width

• Mobile version: ~1000px width

Spent Time In The Menu

If you want to turn off the "Spent time" in the top menu, just go to your-redmine.com/settings/plugin/000_redmine_x_ux_upgrade and uncheck the checkbox.

1. Go to your-redmine.com/settings/plugin/000_redmine_x_ux_upgrade

2. Check/uncheck "Show time log in menu"

3. Save settings

Plugin Compatibility

The RedmineX UX Upgrade plugin modifies issue views and may conflict with other plugins that alter the same views. Compatible versions are available for:

• MEGA Calendar Plugin: Download compatible version

• CKEditor Plugin: Download compatible version

⚠️ Known Issues:

Some plugins may cause internal errors due to view conflicts. Use the compatible versions provided by RedmineX for seamless integration.

Redmine CK Editor's known issue described at https://github.com/a-ono/redmine_ckeditor/issues/331 or https://github.com/a-ono/redmine_ckeditor/issues/308. As you can see, we tried to contact the creator of this Redmine plugin but got no response. To avoid any issues with the CK Editor Redmine plugin (not the actual CK editor in fact), you can either carry out the adjustment described in the latter GitHUB link:

1. Locate the file at plugins/redmine_ckeditor/app/views/settings/_ckeditor.html.erb

2. Find the first line <%= ckeditor_javascripts %>

3. Replace it with <%= RedmineCkeditor::Helper.instance_method(:ckeditor_javascripts).bind(self).call %>

4. Restart & migrate