Project

General

Profile

RedmineRake » History » Version 13

Go MAEDA, 2017-09-12 09:25
Updated the URL of builtin tasks of Rails

1 3 Etienne Massip
h1. Rake tasks
2 1 Etienne Massip
3
p{color:red}. WIP
4
5
{{>toc}}
6
7
Redmine defines a set of "Rake":http://rake.rubyforge.org tasks for use in maintenance operations.
8
9 13 Go MAEDA
Information about tasks defined by the Ruby on Rails framework are accessible on "the dedicated page":http://guides.rubyonrails.org/command_line.html#bin-rails.
10 1 Etienne Massip
11 12 Etienne Massip
At any time you can get the full list of tasks using command @rake -T@.
12
13
*When running a task* don't forget to set @RAILS_ENV@ variable to ??production??!
14
15
E.g. (*nix style):
16
17
 rake redmine:permissions RAILS_ENV=production
18
19
or (Windows style):
20
21
 set RAILS_ENV=production
22
rake redmine:permissions
23
24 7 Etienne Massip
h2. Batch job tasks
25
26
h3. @rake redmine:attachments:prune@
27
28 9 Etienne Massip
_Applicable starting from version version:2.3.0._
29 1 Etienne Massip
30 5 Trevor Jones
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.
31
32 1 Etienne Massip
This task removes uploaded files left unattached (meaning the form has never been submitted) after one day.
33 5 Trevor Jones
34 7 Etienne Massip
h3. @rake redmine:email:read@
35 5 Trevor Jones
36
Read an email from standard input.
37
38 7 Etienne Massip
h3. @rake redmine:email:receive_imap@
39 5 Trevor Jones
40
Read emails from an IMAP server.
41
42 7 Etienne Massip
h3. @rake redmine:email:receive_pop3@
43 5 Trevor Jones
44
Read emails from an POP3 server.
45
46 7 Etienne Massip
h3. @rake redmine:fetch_changesets@
47 5 Trevor Jones
48
Fetch changesets from the repositories
49
50 7 Etienne Massip
h3. @rake redmine:send_reminders@
51 5 Trevor Jones
52
Send reminders about issues due in the next days.
53
See: [[RedmineReminderEmails]]
54
55 7 Etienne Massip
h3. @rake redmine:tokens:prune@
56 5 Trevor Jones
57
Removes expired tokens.
58
59 7 Etienne Massip
h3. @rake redmine:watchers:prune@
60 5 Trevor Jones
61 1 Etienne Massip
Removes watchers from what they can no longer view.
62 5 Trevor Jones
Available in versions version:2.3.0
63
64 7 Etienne Massip
h2. Other maintenance tasks
65 5 Trevor Jones
66 8 Etienne Massip
h3. @rake generate_secret_token@
67 5 Trevor Jones
68 7 Etienne Massip
Generates a secret token for the application.
69 5 Trevor Jones
70 7 Etienne Massip
h3. @rake db:encrypt@ and @rake db:decrypt@
71 5 Trevor Jones
72 7 Etienne Massip
Encrypts or decrypts SCM and LDAP passwords stored in the database.
73 5 Trevor Jones
74 7 Etienne Massip
h3. @rake redmine:attachments:move_to_subdirectories@
75 5 Trevor Jones
76 7 Etienne Massip
Moves attachments stored at the root of the file directory (ie.
77 5 Trevor Jones
Available in versions version:2.3.0
78
79 7 Etienne Massip
h3. @rake redmine:email:test[login]@
80 5 Trevor Jones
81 7 Etienne Massip
Send a test email to the user with the provided login name
82 5 Trevor Jones
83 7 Etienne Massip
h3. @rake redmine:permissions@
84 5 Trevor Jones
85 7 Etienne Massip
List all permissions and the actions registered with them
86 5 Trevor Jones
87 7 Etienne Massip
h3. @rake redmine:plugins@
88 5 Trevor Jones
89 7 Etienne Massip
Migrates and copies plugins assets.
90 5 Trevor Jones
91 7 Etienne Massip
h3. @rake redmine:plugins:assets@
92 5 Trevor Jones
93 7 Etienne Massip
Copies plugins assets into the public directory.
94 5 Trevor Jones
95 7 Etienne Massip
h3. @rake redmine:plugins:migrate@
96 5 Trevor Jones
97 7 Etienne Massip
Migrates installed plugins.
98 5 Trevor Jones
99 7 Etienne Massip
h2. Migrating from another BTS
100 5 Trevor Jones
101 7 Etienne Massip
h3. @rake redmine:migrate_from_mantis@
102 5 Trevor Jones
103 7 Etienne Massip
Mantis migration script
104 5 Trevor Jones
105 7 Etienne Massip
h3. @rake redmine:migrate_from_trac@
106 5 Trevor Jones
107 7 Etienne Massip
Trac migration script