In some projects there are tasks that need to be assigned on a schedule. Such as check the ssl registration once per year or run security checks every 3 months
After you installed the plugin you can add it as a module to a project that already exists or activate it as default module for new projects. On each project it will add a new tab named "Periodic Task" - just go there to add your tasks.
Support for old redmine versions has been dropped. If you are using an old version, you can use the corresponding branch according to the following table. If you cannot migrate to a newer version and still need support, you can hire me to do it. Just contact me with the details.
| git branch | redmine version support | ||||
| 1.x | 2.x | 3.x | 4.x | 5.x | |
| main | ? | ? | ? | ? | ✅ |
| redmine4 | ? | ? | ✅ | ✅ | 🚫 |
| redmine2 | ✅ | ✅ | 🚫 | 🚫 | 🚫 |
To use redmine2 branch, when cloning use -b redmine2 like this git clone -b redmine2 http://github.com:/jperelli/Redmine-Periodic-Task.git plugins/periodictask
cd /usr/local/share/redmine
git clone http://github.com:/jperelli/Redmine-Periodic-Task.git plugins/periodictask
bundle install
bundle exec rake redmine:plugins:migrate NAME=periodictask RAILS_ENV=production
apache2ctl graceful
cd /usr/local/share/redmine/plugins/periodictask
git pull
bundle install
bundle exec rake redmine:plugins:migrate NAME=periodictask RAILS_ENV=production
apache2ctl graceful
cd /usr/local/share/redmine
bundle exec rake redmine:plugins:migrate NAME=periodictask VERSION=0 RAILS_ENV=production
rm -rf plugins/periodictask
apache2ctl graceful
Go to your console and run which bundle. In my case, that command returned /usr/local/rvm/gems/ruby-2.1.0/bin/bundle. Use that to configure cron like this
As root do crontab -e and add this to the last line
0 1 * * * cd /var/www/<redminedir>; /usr/local/rvm/gems/ruby-2.1.0/bin/bundle exec rake redmine:check_periodictasks RAILS_ENV="production"
You can also make it run once per hour
0 * * * * cd /var/www/<redminedir>; /usr/local/rvm/gems/ruby-2.1.0/bin/bundle exec rake redmine:check_periodictasks RAILS_ENV="production"
Or even every 10 minutes
*/10 * * * * cd /var/www/<redminedir>; /usr/local/rvm/gems/ruby-2.1.0/bin/bundle exec rake redmine:check_periodictasks RAILS_ENV="production"
If you want to substitute variables **DAY**, **WEEK**, **MONTH**, **MONTHNAME**, **YEAR**, **PREVIOUS_MONTHNAME**, **PREVIOUS_MONTH** with a localized version in your laguage please add LOCALE="de" (available are de, en, ja, tr, ru, tr, zh) to cronjob like this
0 * * * * cd /var/www/<redminedir>; /usr/local/rvm/gems/ruby-2.1.0/bin/bundle exec rake redmine:check_periodictasks RAILS_ENV="production" LOCALE="de"
redmine-periodictask supports redminecrm checklist PRO to be used when creating a periodic task.
Start with docker compose up --build and wait until it finishes.
In other console do ./provision.sh, this will install initial data for it to be easier to develop.
Then go to http://127.0.0.1:3000/ and login with
user: admin
pass: admin
You should have a project named project1 with periodictask installed
In order to run the "cron checker": docker compose exec redmine bundle exec rake redmine:check_periodictasks RAILS_ENV=development
- Julian Perelli (Current Maintainer)
- Tanguy de Courson (Original Author)
MIT