Project

General

Profile

RedmineRake » History » Revision 12

Revision 11 (Toshi MARUYAMA, 2013-05-29 22:18) → Revision 12/13 (Etienne Massip, 2013-06-06 22:26)

h1. Rake tasks 

 p{color:red}. WIP 

 {{>toc}} 

 Redmine defines a set of "Rake":http://rake.rubyforge.org tasks for use in maintenance operations. 

 Information about tasks defined by the Ruby on Rails framework are accessible on "the dedicated page":http://guides.rubyonrails.org/command_line.html#rake. 

 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 

 h2. Batch job tasks 

 h3. @rake redmine:attachments:prune@ 

 _Applicable starting from version 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. 

 h3. @rake redmine:email:read@ 

 Read an email from standard input. 

 h3. @rake redmine:email:receive_imap@ 

 Read emails from an IMAP server. 

 h3. @rake redmine:email:receive_pop3@ 

 Read emails from an POP3 server. 

 h3. @rake redmine:fetch_changesets@ 

 Fetch changesets from the repositories 

 h3. @rake redmine:send_reminders@ 

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

 h3. @rake redmine:tokens:prune@ 

 Removes expired tokens. 

 h3. @rake redmine:watchers:prune@ 

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

 h2. Other maintenance tasks 

 h3. @rake generate_secret_token@ 

 Generates a secret token for the application. 

 h3. @rake db:encrypt@ and @rake db:decrypt@ 

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

 h3. @rake redmine:attachments:move_to_subdirectories@ 

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

 h3. @rake redmine:email:test[login]@ 

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

 h3. @rake redmine:permissions@ 

 List all permissions and the actions registered with them 

 h3. @rake redmine:plugins@ 

 Migrates and copies plugins assets. 

 h3. @rake redmine:plugins:assets@ 

 Copies plugins assets into the public directory. 

 h3. @rake redmine:plugins:migrate@ 

 Migrates installed plugins. 

 h2. Migrating from another BTS 

 h3. @rake redmine:migrate_from_mantis@ 

 Mantis migration script 

 h3. @rake redmine:migrate_from_trac@ 

 Trac migration script