This article describes how to install the Planner plugin on Redmine, upgrade it and remove it. You need access to the server where Redmine runs and the permission to restart it.
Requirements
- Redmine 5.0 to 7.0
- Ruby 3.0.1 or newer
- The redmineup gem. It is installed together with the plugin by Bundler, you do not install it by hand.
- A database supported by your Redmine (MySQL, PostgreSQL, SQLite, SQL Server). Planner adds its own tables and changes none of the core ones.
Install the plugin
1. Unpack the plugin archive into the plugins directory of your Redmine, so that the folder is named redmineup_planner.
2. Install the gems from the Redmine root directory:
bundle install --without development test RAILS_ENV=production
3. Run the plugin migrations:
bundle exec rake redmine:plugins NAME=redmineup_planner RAILS_ENV=production
4. Restart Redmine (Passenger, Puma, Unicorn or your service manager).
5. Sign in as an administrator, select Administration, then Plugins. Redmine Planner plugin must be in the list with its version.
The migrations create three tables: the Draft table (planner_draft_changes) and two tables for baselines. Nothing is written to your issues until a user presses Apply in the plugin.
Next steps
Planner is switched on per project and per role, so the plugin is invisible until you do two things. Follow Enable Planner and set permissions, then read Getting started with Planner.
Light and PRO builds
Planner comes in two builds. The PRO build contains everything, the Light build keeps the core of editable planning. Both are installed in the same way, and you can move from Light to PRO later by replacing the plugin folder: no extra migration is needed because the tables are created by both builds. The feature table is in Getting started with Planner.
Upgrade
- Make a backup of the database and of the plugins directory.
- Replace the redmineup_planner folder with the new version.
- Run
bundle install --without development test RAILS_ENV=productionand the migrations command from the installation steps. - Restart Redmine.
Draft changes and baselines are kept in the database and survive the upgrade.
Uninstall
Remove the tables first, then the folder:
bundle exec rake redmine:plugins NAME=redmineup_planner VERSION=0 RAILS_ENV=production rm -r plugins/redmineup_planner
Restart Redmine afterwards. Unapplied Draft changes and all baselines are deleted together with the tables. Dates, estimates and dependencies that were already applied to issues stay as they are.