Rake tasks¶

WIP

• Table of contents
• Rake tasks
  • Batch job tasks
    • rake redmine:attachments:prune
    • rake redmine:email:read
    • rake redmine:email:receive_imap
    • rake redmine:email:receive_pop3
    • rake redmine:fetch_changesets
    • rake redmine:send_reminders
    • rake redmine:tokens:prune
    • rake redmine:watchers:prune
  • Other maintenance tasks
    • rake generate_secret_token
    • rake db:encrypt and rake db:decrypt
    • rake redmine:attachments:move_to_subdirectories
    • rake redmine:email:test[login]
    • rake redmine:permissions
    • rake redmine:plugins
    • rake redmine:plugins:assets
    • rake redmine:plugins:migrate
  • Migrating from another BTS
    • rake redmine:migrate_from_mantis
    • rake redmine:migrate_from_trac

Redmine defines a set of Rake tasks for use in maintenance operations.

Information about tasks defined by the Ruby on Rails framework are accessible on the dedicated page.

At any time you can get the full list of tasks using command rake -T.

When running a task don't forget to set RAILS_ENV variable to production!

E.g. (*nix style):

rake redmine:permissions RAILS_ENV=production

or (Windows style):

set RAILS_ENV=production
rake redmine:permissions

Batch job tasks¶

rake redmine:attachments:prune¶

Applicable starting from version 2.3.0.

When a user attaches a file to an issue, a wiki page, etc., the file is immediately uploaded and is attached later on after the form has been submitted.

This task removes uploaded files left unattached (meaning the form has never been submitted) after one day.

rake redmine:email:read¶

Read an email from standard input.

rake redmine:email:receive_imap¶

Read emails from an IMAP server.

rake redmine:email:receive_pop3¶

Read emails from an POP3 server.

rake redmine:fetch_changesets¶

Fetch changesets from the repositories

rake redmine:send_reminders¶

Send reminders about issues due in the next days.
See: RedmineReminderEmails

rake redmine:tokens:prune¶

Removes expired tokens.

rake redmine:watchers:prune¶

Removes watchers from what they can no longer view.
Available in versions 2.3.0

Other maintenance tasks¶

rake generate_secret_token¶

Generates a secret token for the application.

rake db:encrypt and rake db:decrypt¶

Encrypts or decrypts SCM and LDAP passwords stored in the database.

rake redmine:attachments:move_to_subdirectories¶

Moves attachments stored at the root of the file directory (ie.
Available in versions 2.3.0

rake redmine:email:test[login]¶

Send a test email to the user with the provided login name

rake redmine:permissions¶

List all permissions and the actions registered with them

rake redmine:plugins¶

Migrates and copies plugins assets.

rake redmine:plugins:assets¶

Copies plugins assets into the public directory.

rake redmine:plugins:migrate¶

Migrates installed plugins.

Migrating from another BTS¶

rake redmine:migrate_from_mantis¶

Mantis migration script

rake redmine:migrate_from_trac¶

Trac migration script