Project

General

Profile

RedmineUpgrade » History » Version 79

Toshi MARUYAMA, 2017-07-09 18:30

1 1 Jean-Philippe Lang
h1. Upgrading
2
3 70 Jean-Philippe Lang
The documentation below is based on upgrading to Redmine 2.x and higher. You can view a previous version for upgrading to Redmine 1.x "here":/projects/redmine/wiki/RedmineUpgrade?version=53.
4 56 Etienne Massip
5 15 Eric Davis
{{>toc}}
6 1 Jean-Philippe Lang
7 15 Eric Davis
h2. Step 1 - Check requirements
8 1 Jean-Philippe Lang
9 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.
10
11
h2. Step 2 - Backup
12
13 77 Toshi MARUYAMA
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.
14 15 Eric Davis
15
h3. Backing up the files
16
17 77 Toshi MARUYAMA
All file uploads are stored to the @files/@ directory. You can copy the contents of this directory to another location to easily back it up.
18 1 Jean-Philippe Lang
19 77 Toshi MARUYAMA
h3. Database
20 15 Eric Davis
21 77 Toshi MARUYAMA
h4. MySQL database
22
23 38 T. Hauptman
The @mysqldump@ command can be used to backup the contents of your MySQL database to a text file. For example:
24
<pre>
25 1 Jean-Philippe Lang
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
26
</pre>
27 15 Eric Davis
28 77 Toshi MARUYAMA
h4. SQLite database
29 15 Eric Davis
30
SQLite databases are all contained in a single file, so you can back them up by copying the file to another location.
31
32 77 Toshi MARUYAMA
h4. PostgreSQL
33 15 Eric Davis
34 39 Anonymous
The @pg_dump@ command can be used to backup the contents of a PostgreSQL database to a text file. Here is an example:
35
<pre>
36
/usr/bin/pg_dump -U <username> -Fc --file=redmine.sqlc <redmine_database>
37
</pre>
38 64 Jean-Philippe Lang
39 15 Eric Davis
40
h2. Step 3 - Perform the upgrade
41
42 1 Jean-Philippe Lang
Now it's time to perform the actual upgrade.  This process is different depending on how you downloaded Redmine.  You only need to perform *one* of the following options.
43
44 70 Jean-Philippe Lang
h3. Option 1 - Download a stable release
45 15 Eric Davis
46 70 Jean-Philippe Lang
1. [[Download]] the release in either tar.gz or zip format and uncompress the new program archive in a new directory.
47 15 Eric Davis
48 72 Toshi MARUYAMA
Make sure the newly extracted and copied files and directories have the correct owner and group set, so that the user/group running your application server can actually access the files.
49 74 Go MAEDA
Also, remember to add write permissions to the @files@, @log@ and @tmp@ directory.
50 72 Toshi MARUYAMA
51 51 Jean-Philippe Lang
2. Copy your database settings-file @config/database.yml@ into the new @config@ directory. If you're running Redmine >= 1.4 with mysql and ruby1.9, change the database adapter to `mysql2`.
52 15 Eric Davis
53 48 Etienne Massip
3a. Copy your base configuration settings-file @config/configuration.yml@ into the new @config@ directory.
54
55 1 Jean-Philippe Lang
3b. Or, *if upgrading from version older than 1.2.0*, copy your email settings from your @config/email.yml@ into the new @config/configuration.yml@ file that can be created by copying the available @configuration.yml.example@ file.
56 15 Eric Davis
57 67 Jean-Philippe Lang
4. Copy the @files@ directory content into your new installation (this directory contains all your uploaded files).
58 15 Eric Davis
59 70 Jean-Philippe Lang
5. Copy the folders of your *custom* plugins from your @plugins@ directory (or @vendor/plugins@ directory if upgrading from a 1.x version) into new installation @plugins@ directory. Make sure that you copy only plugins that are were not initially bundled with your previous Redmine setup.
60 1 Jean-Philippe Lang
61 68 Toshi MARUYAMA
6. Install the required gems by running:
62 1 Jean-Philippe Lang
63 68 Toshi MARUYAMA
  bundle install --without development test
64
65 70 Jean-Philippe Lang
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
66 68 Toshi MARUYAMA
67 70 Jean-Philippe Lang
  bundle install --without development test rmagick
68 68 Toshi MARUYAMA
69 70 Jean-Philippe Lang
Only the gems that are needed by the adapters you've specified in your database configuration file are actually installed (eg. if your config/database.yml uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't forget to re-run `bundle install` when you change config/database.yml for using other database adapters.
70 68 Toshi MARUYAMA
71 70 Jean-Philippe Lang
If you need to load some gems that are not required by Redmine core (eg. fcgi), you can create a file named Gemfile.local at the root of your redmine directory. It will be loaded automatically when running `bundle install`.
72 68 Toshi MARUYAMA
73 1 Jean-Philippe Lang
7. Run the following command from your new Redmine root directory:
74 68 Toshi MARUYAMA
75 75 Toshi MARUYAMA
If you're upgrading from Redmine 2.x or below, remove the following file if it exists:
76
* config/initializers/secret_token.rb
77 1 Jean-Philippe Lang
78 75 Toshi MARUYAMA
Then generate a new secret by running the following command under the application directory:
79
80
     bundle exec rake generate_secret_token
81
82
Alternatively, you can store this secret in config/secrets.yml:
83
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
84 1 Jean-Philippe Lang
85 22 Brad Langhorst
8. 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.
86 68 Toshi MARUYAMA
87 26 salt racer
VERY IMPORTANT: do NOT overwrite @config/settings.yml@ with the old one.
88 1 Jean-Philippe Lang
89 65 Jean-Philippe Lang
h3. Option 2 - Upgrading from a SVN checkout
90 1 Jean-Philippe Lang
91
1. Go to the Redmine root directory and run the following command:
92
<pre>
93
svn update
94 69 Toshi MARUYAMA
</pre>
95
96 70 Jean-Philippe Lang
2. Install the required gems by running the following command:
97 15 Eric Davis
98
  bundle update
99
100 1 Jean-Philippe Lang
h2. Step 4 - Update the database
101 28 rafael mascayano
102 1 Jean-Philippe Lang
This step is the one that could change the contents of your database. Go to your new redmine directory, then migrate your database:
103
104 79 Toshi MARUYAMA
Redmine 4:
105 1 Jean-Philippe Lang
106 78 Toshi MARUYAMA
<pre>
107
bundle exec rails db:migrate RAILS_ENV=production 
108
</pre>
109
110 79 Toshi MARUYAMA
Redmine 3:
111 78 Toshi MARUYAMA
112
<pre>
113
bundle exec rake db:migrate RAILS_ENV=production 
114
</pre>
115
116 1 Jean-Philippe Lang
If you have installed any plugins, you should also run their database migrations:
117
118 79 Toshi MARUYAMA
Redmine 4:
119 78 Toshi MARUYAMA
120
<pre>
121
bundle exec rails redmine:plugins:migrate RAILS_ENV=production
122
</pre>
123
124 79 Toshi MARUYAMA
Redmine 3:
125 78 Toshi MARUYAMA
126
<pre>
127
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
128
</pre>
129 1 Jean-Philippe Lang
130 15 Eric Davis
h2. Step 5 - Clean up
131 1 Jean-Philippe Lang
132 71 Jean-Philippe Lang
1. Clear the cache and the existing sessions:
133 10 Azamat Hackimov
134 73 Jean-Philippe Lang
  bundle exec rake tmp:cache:clear tmp:sessions:clear RAILS_ENV=production
135 71 Jean-Philippe Lang
136 62 Etienne Massip
2. Restart the application server (e.g. puma, thin, passenger)
137 12 Mischa The Evil
138 15 Eric Davis
3. Finally go to _"Admin -> Roles & permissions"_ to check/set permissions for the new features, if any.
139 1 Jean-Philippe Lang
140 15 Eric Davis
h2. Common issues
141 10 Azamat Hackimov
142 30 Zach Gardner
h3. Errors with repository management
143 33 Cyber Sprocket
144 1 Jean-Philippe Lang
There were several new features added to the reposman.rb file, make sure you have a group specified if you're having issues ( --group=groupnamehere).  Also, make sure you follow the instructions [[Repositories_access_control_with_apache_mod_dav_svn_and_mod_perl|here]] again if you only copied your Redmine.pm, and update your Apache configuration as the recommended configuration has changed.
145 33 Cyber Sprocket
146
h3. Generating a new @secret_token.rb@
147
148 34 Cyber Sprocket
Before version:2.0.0, a @session_store.rb@ file needed to be generated in Redmine's @config@ directory for the cookie based sessions to work.
149 33 Cyber Sprocket
150 32 Szymon Połom
Starting from version:2.0.0, the @session_store.rb@ file should not exist. Instead, the following command will generate the @secret_token.rb@ file:
151 35 Cyber Sprocket
152 71 Jean-Philippe Lang
  bundle exec rake generate_secret_token
153 32 Szymon Połom
154
_Note: The code repository for Redmine does not contain the config/initializers/secret_token.rb file, it is created by the above rake command._
155 35 Cyber Sprocket
156
h3. Related Resources 
157
158
These resources may help you with your Redmine upgrade:
159
160 66 Jean-Philippe Lang
* Error while browsing the wiki history after upgrading from Redmine 1.x with SQLite: see #12501
161 45 Jean-Philippe Lang
* "mod_fcgid for Apache2":http://httpd.apache.org/mod_fcgid/ helped us get Rails running on Apache 2
162 35 Cyber Sprocket
* "Running Redmine on Apache":http://www.redmine.org/wiki/redmine/HowTo_configure_Apache_to_run_Redmine
163 76 Mischa The Evil
* "Notes about our 0.8.6 to 0.9.3 upgrade issues and how to resolve them":http://web.archive.org/web/20111214022108/http://www.cybersprocket.com/2010/project-management/upgrading-redmine-from-8-6-to-9-3/ --cybersprocket (2010-04-25)
164
* "Notes about our 0.9.6 to 1.0(RC) upgrade process":http://web.archive.org/web/20120610010521/http://www.cybersprocket.com/2010/tips-tricks/upgrading-redmine-from-0-9-6-to-1-0-0/ --cybersprocket (2010-08-14)