Redmine Plugin Installation and Update Guide

Plugins are often the biggest source of unexpected Redmine incidents. Use a controlled plugin workflow to keep production stable while extending functionality.

1. Validate Compatibility Before Installing Any Plugin

Check compatibility against your exact Redmine and Ruby versions, not just plugin popularity.

  • Review the plugin repository release notes and supported Redmine versions.
  • Verify required gems and external services.
  • Check whether migrations are required.
  • Confirm maintenance activity and issue response in the repository.
Installing an unmaintained plugin directly in production can break login, issue views, or background jobs after upgrades.

2. Use a Staging-First Deployment Flow

Step 1: Clone production state Create a staging environment with the same Redmine version and plugin set.
Step 2: Install plugin in staging Run bundle install and plugin migrations, then restart the app stack.
Step 3: Execute smoke tests Validate login, project navigation, issue CRUD, search, and email notifications.
Step 4: Promote with rollback plan Apply to production only when rollback steps are documented and tested.

3. Define a Rollback Strategy

Every plugin deployment should include a rollback path:

  • Pre-change database backup.
  • Snapshot of current plugin directory state.
  • Documented command sequence to disable or remove the plugin.
  • Owner assignment for go/no-go decisions.

Fast rollback is more valuable than perfect deployment confidence.

4. Plugin Lifecycle Management

Patch cadence

Review plugin updates regularly and schedule controlled upgrade windows.

Audit trail

Track installed plugin versions and last update date in an operations runbook.

Decommissioning

Remove plugins that are no longer used to reduce attack surface and upgrade friction.