This article will teach you in detail how to update (upgrade) a plugin in Docker Compose Redmine 7 at Windows OS.
Note: Please keep in mind that the steps in this guide are applicable for any Redmine plugin (not only our RedmineUP plugins).
The difference between update and upgrade of RedmineUP plugin is as follows (the steps in this article are correct for any of the below scenarios):
- Updating is a process of replacing older light to newer light version or older PRO to newer PRO version
- Upgrading is process of replacing light with PRO version of a plugin
- Check for a newer version
- Delete old plugin version
- Copy new plugin version
- Gems install and Database migration
- Precompile
- Cache clear
- Restart
- Video demonstration
Check for a newer version
Firstly, you need to check if there is a newer version in order to make an update (upgrade) procedure. It can be easily done in Administration > Plugins > Check for updates (button is located at the bottom of the plugins list). If there is a green sign near the plugin version, it means that it is up-to-date. But if there is a red (or orange) exclamation mark, it means that there is a newer version available. If you hover the mouse over the current plugin version, there will pop-up a new small windows showing the latest version number.
In case of a new version, please download it on your local Windows files system (normally "Downloads" folder).
Delete old plugin version
Now you need to navigate your PowerShell directory to be:
cd C:\docker\redmine\
Afterward please open the Docker Redmine 7 inner terminal via this command:
docker compose exec redmine bash
Your currently installed plugin version is now old one. You need to delete it via this command:
rm -rf plugins/your_plugin_name
Here you need to replace:
- your_plugin_name with your real plugin name
The plugin name will be replaced with our Checklists plugin just as an example plugin.
So, the command with our example will look like this:
rm -rf plugins/redmine_checklists
Copy new plugin version
Please exit the Docker Redmine terminal with this command:
exit
Now you need to open your Downloads folder where you downloaded your zip file of the very latest plugin version.
Here, please unzip it via just right-click and "extract all".
Afterward, in your PowerShell navigate to the Downloads folder and execute the below command to copy the file in your Docker Compose Redmine 7 (the folder to be copied will be in our example redmine_checklists and not containing some version number in the folder name).
docker cp .\your_plugin_name\ your_container_name:/usr/src/redmine/plugins
Plugin name we already now but the your_container_name could be checked via the command:
docker ps
In our example (could be checked in the video demonstration at the end of the article), the name of the container is redmine_app.
So, the command will look like as follows:
docker cp .\redmine_checklists\ redmine_app:/usr/src/redmine/plugins
Gems install and Database migration
For this purpose we need to go again in the Docker Redmine inner terminal (command line/shell):
cd C:\docker\redmine\
And then:
docker compose exec redmine bash
Afterward, please install the needed gems in this way:
bundle install
And do the migration of your database in relation to the plugin you are trying to install via this command:
bundle exec rake redmine:plugins NAME=your_plugin_name RAILS_ENV=production
In our example with replaced name of the plugin:
bundle exec rake redmine:plugins NAME=redmine_checklists RAILS_ENV=production
Precompile
Just copying the assets statically in Redmine 7 and Rails 8.1 is not enough to be processed fully. That's why we need to explicitly execute them via the precompile command.
bundle exec rake assets:precompile RAILS_ENV=production
Cache clear
Also, please clear the cache in this way:
bundle exec rake tmp:cache:clear RAILS_ENV=production
Restart
Last thing that needs to be done is just restarting your Docker Redmine.
Again exit the Docker Redmine terminal with this command:
exit
And then run:
docker restart redmine_app
Now please open your Redmine in the browser to double-check if all is updated (upgraded) correctly. If no additional settings are done, it should be located in localhost:8080/admin/info and check the Check for updates button in localhost:8080/admin/plugins
Video demonstration
To see the updating (upgrading) process in action, please check the video below: