Project

General

Profile

RedmineUpgrade » History » Version 28

rafael mascayano, 2010-01-15 16:05

1 1 Jean-Philippe Lang
h1. Upgrading
2
3 15 Eric Davis
{{>toc}}
4 1 Jean-Philippe Lang
5 15 Eric Davis
h2. Step 1 - Check requirements
6 1 Jean-Philippe Lang
7 15 Eric Davis
The first step to upgrading Redmine is to check that you meet the [[RedmineInstall#Requirements|requirements]] for the version you're about to install.
8
9
h2. Step 2 - Backup
10
11
It is recommended that you backup your database and file uploads.  Most upgrades are safe but it never hurts to have a backup just in case.
12
13
h3. Backing up the files
14
15
All file uploads are stored to the @files/@ directory.  You can copy the contents of this directory to a another location to easily back it up.
16
17
h3. MySQL database
18
19
The @mysqldump@ command can be used to backup the contents of your MySQL database to a text file.
20
21
h3. SQLite database
22
23
SQLite databases are all contained in a single file, so you can back them up by copying the file to another location.
24
25
h3. PostgreSQL
26
27
The @pg_dump@ command can be used to backup the contents of a PostgreSQL database to a text file.
28
29
h2. Step 3 - Perform the upgrade
30
31 16 Eric Davis
Now it's time to perform the actual upgrade.  This process if different depending on how you downloaded Redmine.  You only need to perform *one* of the following options.
32 15 Eric Davis
33 16 Eric Davis
h3. Option 1 - Downloaded release (tar.gz or zip file)
34 15 Eric Davis
35
1. Uncompress the new program archive in a new directory.
36
37
2. Copy your database settings-file @config/database.yml@ into the new @config@ directory.
38
39 19 Jean-Philippe Lang
3. Copy your email settings-file @config/email.yml@ into the new @config@ directory.
40 15 Eric Davis
41
4. Copy the @RAILS_ROOT/files@ directory content into your new installation.
42
43 1 Jean-Philippe Lang
5. Copy the folders of your installed plugins into new installation directory
44 19 Jean-Philippe Lang
45 24 Mischa The Evil
6. If upgrading to 0.8.7+ or 0.9+, run "rake config/initializers/session_store.rb"
46 22 Brad Langhorst
47 26 salt racer
7. Check for any themes that you may have installed in the "public/themes" directory. You can copy them over but checking for updated version is ideal.
48
49 19 Jean-Philippe Lang
VERY IMPORTANT: do NOT overwrite @config/settings.yml@ with the old one.
50 17 Erick Pérez Castellanos
51 16 Eric Davis
h3. Option 2 - Upgrading from a SVN [[CheckingoutRedmine|checkout]]
52 15 Eric Davis
53 2 Jean-Philippe Lang
1. Go to the Redmine root directory and run the following command:
54 1 Jean-Philippe Lang
<pre>
55
svn update
56
</pre>
57
58 25 Mischa The Evil
2. If you are upgrading from an older version to 0.8.7+ or from the trunk version of Redmine to r2493 or above, you must generate a secret for cookie store.  See the note at the bottom about generating a @session_store@.
59 15 Eric Davis
60
h2. Step 4 - Update the database
61
62
This step is the one that could change the contents of your database. Go to your new redmine directory, then migrate your database:
63
64 1 Jean-Philippe Lang
<pre>
65 28 rafael mascayano
rake db:migrate RAILS_ENV=production 
66 1 Jean-Philippe Lang
</pre>
67
68 18 Ethan Fremen
If you have installed any plugins, you should also run their database migrations. If you are upgrading to Rails 2.2.2 as part of this migration, you need to upgrade the plugin migrations first:
69
70 1 Jean-Philippe Lang
<pre>
71 28 rafael mascayano
rake db:migrate:upgrade_plugin_migrations RAILS_ENV=production 
72 18 Ethan Fremen
</pre>
73
74
<pre>
75 28 rafael mascayano
rake db:migrate_plugins RAILS_ENV=production 
76 1 Jean-Philippe Lang
</pre>
77
78 15 Eric Davis
h2. Step 5 - Clean up
79 1 Jean-Philippe Lang
80 15 Eric Davis
1. You should clear the cache and the existing sessions:
81 1 Jean-Philippe Lang
<pre>
82
rake tmp:cache:clear
83 10 Azamat Hackimov
rake tmp:sessions:clear
84 3 Jean-Philippe Lang
</pre>
85 12 Mischa The Evil
86 15 Eric Davis
2. Restart the application server (e.g. mongrel, thin, passenger)
87 12 Mischa The Evil
88 15 Eric Davis
3. Finally go to _"Admin -> Roles & permissions"_ to check/set permissions for the new features, if any.
89 1 Jean-Philippe Lang
90 15 Eric Davis
h2. Common issues
91 10 Azamat Hackimov
92 15 Eric Davis
h3. Generating a session_store.rb
93 1 Jean-Philippe Lang
94 15 Eric Davis
An unique @session_store.rb@ file needs to be generated for Redmine for the new cookie based sessions to work.  This is required on the trunk version of Redmine at r2493 or above.  Just run the following command and Redmine will create one for you:
95 10 Azamat Hackimov
<pre>
96
rake config/initializers/session_store.rb
97
</pre>
98
99 15 Eric Davis
100
h3. Errors about a missing session_store.rb
101
102
If you see any errors about a missing @session_store.rb@ file, run the command above to create a new one.
103 1 Jean-Philippe Lang
104
h3. Error about the Rails version
105
106 27 Ikawe Saeem
Also remember that the trunk version of Redmine after r2886 uses Rails 2.3.5, so you will need to upgrade your Ruby on Rails gem:
107 15 Eric Davis
<pre>
108 27 Ikawe Saeem
gem install rails -v=2.3.5
109 15 Eric Davis
</pre>