stayhomer.png

Treat without the trick!

Be brave and face your Redmine fears Horribly awesome discounts wait for you!

Halloween special offer has begun!

Upgrading plugin in Redmine 7 Docker Compose on MacOS

Updating a plugin in Redmine 7 running via Docker on macOS involves replacing the old plugin files with the new version and ensuring any required database migrations are run.

Assuming you are using Docker Compose (the standard way to run Redmine on macOS with a mounted host plugins directory), follow these steps:

Step 1: Back up Your Data

Before updating any plugin, it is always wise to back up your database and files:

docker compose exec postgres pg_dump -U redmine redmine > redmine_backup.sql

Step 2: Replace the Plugin Files

1. Navigate to your local Redmine project directory on your Mac where your Docker configuration is stored.

2. Locate your plugins folder (typically mapped to ./plugins or managed via a Docker volume).

3. Delete the old version of the plugin folder or overwrite it with the extracted files of the new version.

Make sure the folder name inside plugins/ remains correct and matches the plugin's internal requirements (e.g., plugins/your_plugin_name).

Step 3: Check for New Gem Dependencies

Some plugins require additional Ruby gems or updates.

If your plugin came with a Gemfile update or instructions to run bundle install, you will need to rebuild your Docker image (if you use a custom Dockerfile) or install the gems inside the running container:

docker compose exec redmine bundle install

Step 4: Run Database Migrations

If the updated plugin includes database changes, you need to run Redmine's plugin migration task:

  • Option A (Manual execution via CLI):
docker compose exec redmine bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  • Option B (Automatic execution via environment variable):If you added REDMINE_PLUGINS_MIGRATE=1 to your docker-compose.yml environment settings, migrations run automatically on container startup.

Step 5: Restart the Redmine Container

Restart your container to clear the cache and load the updated plugin:

docker compose restart redmine

Step 6: Verify

Log into your Redmine instance as an administrator, navigate to Administration > Plugins, and confirm that the version number for the updated plugin reflects the new release.

Was this article helpful? Yes  No