RedmineUpgrade » History » Version 82

Go MAEDA, 2018-10-20 02:43
The rake task tmp:sessions:clear was removed in Rails 5 (Redmine 4). https://github.com/rails/rails/pull/18314

1 1 Jean-Philippe Lang
h1. Upgrading
2 1 Jean-Philippe Lang
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 15 Eric Davis
11 15 Eric Davis
h2. Step 2 - Backup
12 15 Eric Davis
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 81 Go MAEDA
To understand how to back up your Redmine, please read [[RedmineBackupAndRestore|Backing up and restoring Redmine]].
16 15 Eric Davis
17 15 Eric Davis
h2. Step 3 - Perform the upgrade
18 15 Eric Davis
19 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.
20 1 Jean-Philippe Lang
21 70 Jean-Philippe Lang
h3. Option 1 - Download a stable release
22 15 Eric Davis
23 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.
24 15 Eric Davis
25 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.
26 74 Go MAEDA
Also, remember to add write permissions to the @files@, @log@ and @tmp@ directory.
27 72 Toshi MARUYAMA
28 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`.
29 15 Eric Davis
30 48 Etienne Massip
3a. Copy your base configuration settings-file @config/configuration.yml@ into the new @config@ directory.
31 48 Etienne Massip
32 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.
33 15 Eric Davis
34 67 Jean-Philippe Lang
4. Copy the @files@ directory content into your new installation (this directory contains all your uploaded files).
35 15 Eric Davis
36 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.
37 1 Jean-Philippe Lang
38 68 Toshi MARUYAMA
6. Install the required gems by running:
39 1 Jean-Philippe Lang
40 68 Toshi MARUYAMA
  bundle install --without development test
41 68 Toshi MARUYAMA
42 70 Jean-Philippe Lang
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
43 68 Toshi MARUYAMA
44 70 Jean-Philippe Lang
  bundle install --without development test rmagick
45 68 Toshi MARUYAMA
46 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.
47 68 Toshi MARUYAMA
48 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`.
49 68 Toshi MARUYAMA
50 1 Jean-Philippe Lang
7. Run the following command from your new Redmine root directory:
51 68 Toshi MARUYAMA
52 75 Toshi MARUYAMA
If you're upgrading from Redmine 2.x or below, remove the following file if it exists:
53 75 Toshi MARUYAMA
* config/initializers/secret_token.rb
54 1 Jean-Philippe Lang
55 75 Toshi MARUYAMA
Then generate a new secret by running the following command under the application directory:
56 75 Toshi MARUYAMA
57 75 Toshi MARUYAMA
     bundle exec rake generate_secret_token
58 75 Toshi MARUYAMA
59 75 Toshi MARUYAMA
Alternatively, you can store this secret in config/secrets.yml:
60 75 Toshi MARUYAMA
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
61 1 Jean-Philippe Lang
62 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.
63 68 Toshi MARUYAMA
64 26 salt racer
VERY IMPORTANT: do NOT overwrite @config/settings.yml@ with the old one.
65 1 Jean-Philippe Lang
66 65 Jean-Philippe Lang
h3. Option 2 - Upgrading from a SVN checkout
67 1 Jean-Philippe Lang
68 1 Jean-Philippe Lang
1. Go to the Redmine root directory and run the following command:
69 1 Jean-Philippe Lang
<pre>
70 1 Jean-Philippe Lang
svn update
71 69 Toshi MARUYAMA
</pre>
72 69 Toshi MARUYAMA
73 70 Jean-Philippe Lang
2. Install the required gems by running the following command:
74 15 Eric Davis
75 15 Eric Davis
  bundle update
76 15 Eric Davis
77 1 Jean-Philippe Lang
h2. Step 4 - Update the database
78 28 rafael mascayano
79 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:
80 1 Jean-Philippe Lang
81 78 Toshi MARUYAMA
<pre>
82 78 Toshi MARUYAMA
bundle exec rake db:migrate RAILS_ENV=production 
83 78 Toshi MARUYAMA
</pre>
84 78 Toshi MARUYAMA
85 1 Jean-Philippe Lang
If you have installed any plugins, you should also run their database migrations:
86 78 Toshi MARUYAMA
87 78 Toshi MARUYAMA
<pre>
88 78 Toshi MARUYAMA
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
89 78 Toshi MARUYAMA
</pre>
90 1 Jean-Philippe Lang
91 15 Eric Davis
h2. Step 5 - Clean up
92 1 Jean-Philippe Lang
93 82 Go MAEDA
1. Clear the cache:
94 10 Azamat Hackimov
95 82 Go MAEDA
  bundle exec rake tmp:cache:clear RAILS_ENV=production
96 71 Jean-Philippe Lang
97 62 Etienne Massip
2. Restart the application server (e.g. puma, thin, passenger)
98 12 Mischa The Evil
99 15 Eric Davis
3. Finally go to _"Admin -> Roles & permissions"_ to check/set permissions for the new features, if any.
100 1 Jean-Philippe Lang
101 15 Eric Davis
h2. Common issues
102 10 Azamat Hackimov
103 30 Zach Gardner
h3. Errors with repository management
104 33 Cyber Sprocket
105 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.
106 33 Cyber Sprocket
107 33 Cyber Sprocket
h3. Generating a new @secret_token.rb@
108 33 Cyber Sprocket
109 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.
110 33 Cyber Sprocket
111 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:
112 35 Cyber Sprocket
113 71 Jean-Philippe Lang
  bundle exec rake generate_secret_token
114 32 Szymon Połom
115 32 Szymon Połom
_Note: The code repository for Redmine does not contain the config/initializers/secret_token.rb file, it is created by the above rake command._
116 35 Cyber Sprocket
117 35 Cyber Sprocket
h3. Related Resources 
118 35 Cyber Sprocket
119 35 Cyber Sprocket
These resources may help you with your Redmine upgrade:
120 35 Cyber Sprocket
121 66 Jean-Philippe Lang
* Error while browsing the wiki history after upgrading from Redmine 1.x with SQLite: see #12501
122 45 Jean-Philippe Lang
* "mod_fcgid for Apache2":http://httpd.apache.org/mod_fcgid/ helped us get Rails running on Apache 2
123 35 Cyber Sprocket
* "Running Redmine on Apache":http://www.redmine.org/wiki/redmine/HowTo_configure_Apache_to_run_Redmine
124 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)
125 76 Mischa The Evil
* "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)