RedmineX Statistics Plugin

The RedmineX Statistics Plugin turns raw project data into actionable intelligence through a suite of pre-made graphs and visual charts. Designed to provide instant clarity, it allows teams to monitor project health, track performance trends, and visualize key metrics without manual data exporting. By centralizing insights directly within Redmine, it empowers managers to make data-driven decisions quickly and keep every project on a clear path toward success.

1. Install Base Statistics

Unzip the archive and upload the folder redmine_x_statistics to redmine_root/plugins or upload the archive in the same location and perform the unzip command in the console. Do NOT change the plugin folder name.

2. Install Gems

From redmine_root run bundle install. No need for any migration (rake).

If the gems were installed correctly, this is roughly what you should see.

3. Migrate

When installing RedmineX Statistics plugin, you need to run the migration command bundle exec rake redmine:plugins:migrate RAILS_ENV=production.

If the migration went well, this is roughly what you should see.

4. Load Default Data (1.1.2 and below only)

If you have a version 1.1.3+, you can skip this step. When installing Redmine X Statistics plugin, you need to run bundle exec rake redmine:redmine_x_statistics:load_default_charts RAILS_ENV=production.

If the default data were loaded correctly, this is roughly what you should see.

5. Install Statistic Addons

If you are installing additional graphs into the Statistics plugin, then unzip the archive and upload the folder redmine_x_statistics to redmine_root/plugins. If your transfer client is set right, the additional graph folder will get uploaded into /plugins/redmine_x_statistics/lib/redmine_x_statistics/providers/data.

If you get asked whether to override or merge, always choose merge. If you are not sure how your client behaves, go to the path/plugins/redmine_x_statistics/lib/redmine_x_statistics/providers/data and upload just the graph folder, e.g.crm or helpdesk.

6. Restart

Restart Redmine. Based on your hosting provider / web server, you will need to run the following commands. Puma: sudo systemctl restart redmine.yourcompany.com.service or Passenger: touch tmp/restart.txt.

7. For Redmine 6.x+ Only

If you are using Redmine 6+, make sure the theme is present in redmine_root/themes/redminex_theme/.

Then:

1. Ensure correct permissions: chmod -R 755 redmine_root/themes/redminex_theme

2. Clear cache: rm -rf tmp/cache

3. Precompile assets (if you're in production mode): bundle exec rake assets:precompile RAILS_ENV=production

4. Restart Redmine

8. Allow Statistics For Specific Roles

Go to ~/roles and for each role, select the permissions for the project and global Statistics.

9. Add code

From Redmine 5.0.3, there is a security issue so you will need to add 1 line of code into the Redmine config file. Locate config/applicaiton.rb and line 38 which says ActionController::Parameters. Add 1 line under this line saying ActiveSupport::Duration so the code looks like this:

1. Go To /plugins

Remove the redmine_x_statistics folder and upload the unziped folder of the new version. Alternatively, you can copy the archive in the same location and perform the unzip command in the console.

2. Install Gems

From redmine_root run bundle install.

3. Load Default Data (1.1.2 and below only)

If you have a version 1.1.3+, you can skip this step. When updating Redmine X Statistics plugin, you need to run bundle exec rake redmine:redmine_x_statistics:load_default_charts RAILS_ENV=production.

4. Restart

Restart Redmine. Based on your hosting provider / web server, you will need to run the following commands. Puma: sudo systemctl restart redmine.yourcompany.com.service or Passenger: touch tmp/restart.txt.