Getting started

Requirements

• Redmine 6.0 or newer
• Redmine 6.1 as the recommended baseline
• Redmine 7.0.0 with Rails 8.1 is validated

Installation

1. Extract the archive so the final folder is plugins/redmine_ux_toolkit.
2. Run the plugin migration from the Redmine root.
3. Restart Redmine.
4. Open Administration → Plugins → Redmine UX Toolkit → Configure.

bundle exec rake redmine:plugins:migrate RAILS_ENV=production

First-time setup checklist

1. Open Administration → Plugins → Redmine UX Toolkit → Configure and use the Overview search to find enabled features with incomplete settings.
2. In Appearance, choose the landing-page behavior, visible navigation links, My Work defaults, and whether Modern UI should be enabled.
3. In Projects, keep every project module globally available unless your organization deliberately wants to block it everywhere.
4. For each participating project, open Project settings → Modules and enable Redmine UX Toolkit. Then grant the required role permissions under Administration → Roles and permissions.
5. If you use reminders, recurring tickets, repository refresh, attachment cleanup, or Helpdesk retrieval, install the central scheduler described in the Scheduler guide.
6. Sign in with a normal project account and verify the intended menus and actions. Administrator visibility alone does not prove that project roles are configured.

Updating an existing installation

Replace the plugin files without changing the final directory name, run the same migration command, restart every Redmine application process, and review the settings Overview for newly introduced or incomplete options. Existing plugin data and project-module selections are retained by migrations.

Configuration and permissions

Global settings control feature switches and defaults. Project settings enable the UX Toolkit module. Roles can receive View/Edit checklists, View team workload, View project health, and Manage recurring tickets permissions.

If a feature is not visible

• Confirm the global feature switch and global project-module availability.
• Confirm that the project module is enabled for the current project.
• Confirm the user's role permission and the normal Redmine visibility or workflow rules.
• For scheduled features, confirm that the central runner has a recent successful completion.