Project

General

Profile

RedmineInstall » History » Version 198

Mischa The Evil, 2013-03-19 04:33
Update to include Redmine 2.2.2 in Rails version matrix

1 1 Jean-Philippe Lang
h1. Installing Redmine
2
3
{{>TOC}}
4 73 Liraz Siri
5 147 Jean-Philippe Lang
This is the installation documentation for Redmine 1.4.0 and higher. You can still read the document for 1.3.x "here":/projects/redmine/wiki/RedmineInstall?version=146.
6
7 1 Jean-Philippe Lang
h2. Requirements
8
9 25 Jean-Philippe Lang
h3. Operating system
10 1 Jean-Philippe Lang
11 161 Etienne Massip
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|Mac]], [[RedmineInstallOSXServer|Mac Server]] and [[RedmineInstall#Notes-on-Windows-installation|Windows]] systems as long as Ruby is available on this platform.  See specific installation HowTos [[HowTos|here]].
12 25 Jean-Philippe Lang
13 163 Etienne Massip
h3. Ruby interpreter
14 25 Jean-Philippe Lang
15 163 Etienne Massip
The required Ruby versions for a given Redmine version is:
16 1 Jean-Philippe Lang
17 189 Mischa The Evil
|_. Redmine version|_. Supported Ruby versions           |_. Rails version used|_. Supported RubyGems versions|
18 197 Mischa The Evil
|current trunk     |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.13         |RubyGems <= 1.8|
19 196 Jean-Philippe Lang
|2.2.3             |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.12         |RubyGems <= 1.8|
20 198 Mischa The Evil
|2.2.[1-2]         |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.11         |RubyGems <= 1.8|
21 189 Mischa The Evil
|2.2.0             |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.9          |RubyGems <= 1.8|
22
|2.1.6             |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.11         |RubyGems <= 1.8|
23
|2.1.[0-5]         |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.8          |RubyGems <= 1.8|
24
|2.0.[3-4]         |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.6          |RubyGems <= 1.8|
25
|2.0.2             |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.5          |RubyGems <= 1.8|
26
|2.0.[0-1]         |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.3          |RubyGems <= 1.8|
27
|1.4.6             |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 2.3.15         |RubyGems <= 1.8|
28
|1.4.[0-5]         |ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 2.3.14         |RubyGems <= 1.8|
29
30
{{collapse(TODO; probably needs cleanup...)
31
What should be kept? Only supported branches (1.4.x, 2.1.x and 2.2.x)? What about 2.0.x? It isn't on http://www.redmine.org/builds/ any more, so it might be no longer supported.
32
Maybe even cut the whole list by just sticking to only the latest point releases of the supported branches (just like in [[Sidebar]]), but including _current trunk_?
33
}}
34 1 Jean-Philippe Lang
35 164 Etienne Massip
h3. Supported database back-ends
36 92 Knight Samar
37 146 Etienne Massip
* MySQL 5.0 or higher (recommended)
38 35 Jean-Philippe Lang
39 195 Mischa The Evil
 * make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running @gem install mysql2@.
40 1 Jean-Philippe Lang
41 191 Etienne Massip
* PostgreSQL 8.2 or higher
42 117 Etienne Massip
43 1 Jean-Philippe Lang
 * make sure your database datestyle is set to ISO (Postgresql default setting). You can set it using: @ALTER DATABASE "redmine_db" SET datestyle="ISO,MDY";@
44 146 Etienne Massip
 * some bugs in PostgreSQL 8.4.0 and 8.4.1 affect Redmine behavior (#4259, #4314), they are fixed in PostgreSQL 8.4.2
45 1 Jean-Philippe Lang
46
* Microsoft SQL Server *<notextile>*new*</notextile>*
47 194 Mischa The Evil
** support is planned for version#60 release (but is already available on trunk for early adopters)
48 192 Etienne Massip
49
* SQLite 3 (not for multi-user production use!)
50 190 Etienne Massip
51 1 Jean-Philippe Lang
h3. Optional components
52
53
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
54 193 Mischa The Evil
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to png image).
55
      * "Ruby OpenID Library":http://openidenabled.com/ruby-openid/ (to enable OpenID support). Version 2 or greater is required.
56 1 Jean-Philippe Lang
57
h2. Redmine Version
58
59
It is recommended that the majority of users install the proper point releases of redmine. Redmine currently releases a new version every 6 months, and these releases are considered very usable and stable. It is *not* recommended to install redmine from trunk, unless you are deeply familiar with Ruby on Rails and keep up with the changes - Trunk _does_ break from time-to-time.
60
61 114 Etienne Massip
h2. Installation procedure
62 35 Jean-Philippe Lang
63 165 Etienne Massip
h3. Step 1 - Redmine application
64 26 Jean-Philippe Lang
65 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
66 1 Jean-Philippe Lang
67 174 Etienne Massip
See the [[Download|download page]] for details.
68 165 Etienne Massip
69
h3. Step 2 - Dependencies installation
70
71 175 Etienne Massip
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
72 165 Etienne Massip
73
You need to install Bundler first:
74
75 147 Jean-Philippe Lang
  gem install bundler
76
77
Then you can install all the gems required by Redmine using the following command:
78
79
  bundle install --without development test
80
81 168 Etienne Massip
h4. Optional dependencies
82
83 180 Etienne Massip
h5. RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
84 172 Etienne Massip
85 183 Etienne Massip
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
86 1 Jean-Philippe Lang
87 183 Etienne Massip
 @bundle install --without development test rmagick@
88
89
90 172 Etienne Massip
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
91 1 Jean-Philippe Lang
92
h5. Useless database adapters
93 172 Etienne Massip
94 1 Jean-Philippe Lang
You can also skip the installation of the database adapters you're not using.
95
96 183 Etienne Massip
For example, if you're using MySQL, you can skip the installation of the postgresql and sqlite gems using:
97
98
 @bundle install --without development test postgresql sqlite@
99 172 Etienne Massip
100 168 Etienne Massip
h4. Additional dependencies (@Gemfile.local@)
101 1 Jean-Philippe Lang
102 177 Etienne Massip
If you need to load gems that are not required by Redmine core (eg. Puma, fcgi), create a file named @Gemfile.local@ at the root of your redmine directory. It will be loaded automatically when running @bundle install@.
103 149 Jean-Philippe Lang
104 176 Etienne Massip
Example:
105 158 Etienne Massip
<pre>
106 149 Jean-Philippe Lang
# Gemfile.local
107 1 Jean-Philippe Lang
gem 'puma'
108
</pre>
109 147 Jean-Philippe Lang
110 165 Etienne Massip
h3. Step 3 - Create an empty database and accompanying user
111 1 Jean-Philippe Lang
112 165 Etienne Massip
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
113 1 Jean-Philippe Lang
114 166 Etienne Massip
h4. MySQL
115 165 Etienne Massip
116 39 Yclept Nemo
<pre>
117
create database redmine character set utf8;
118
create user 'redmine'@'localhost' identified by 'my_password';
119 1 Jean-Philippe Lang
grant all privileges on redmine.* to 'redmine'@'localhost';
120 88 Sean Farrell
</pre>
121
122 1 Jean-Philippe Lang
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
123 88 Sean Farrell
<pre>
124 1 Jean-Philippe Lang
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
125
</pre>
126
127 166 Etienne Massip
h4. PostgreSQL
128 1 Jean-Philippe Lang
129
<pre>
130
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
131
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
132
</pre>
133 166 Etienne Massip
134 169 Etienne Massip
h3. Step 4 - Database connection configuration
135 1 Jean-Philippe Lang
136 165 Etienne Massip
Copy @config/database.yml.example@ to @config/database.yml@ and edit this file in order to configure your database settings for "production" environment.
137
138 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.8 or jruby:
139 88 Sean Farrell
140 63 Thanos Kyritsis
<pre>
141
production:
142
  adapter: mysql
143
  database: redmine
144 64 Thanos Kyritsis
  host: localhost
145 63 Thanos Kyritsis
  username: redmine
146 3 Jean-Philippe Lang
  password: my_password
147 1 Jean-Philippe Lang
</pre>
148 14 Jean-Philippe Lang
149 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.9 (adapter must be set to @mysql2@):
150
151
<pre>
152
production:
153
  adapter: mysql2
154
  database: redmine
155
  host: localhost
156
  username: redmine
157
  password: my_password
158
</pre>
159
160 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
161
162
<pre>
163 1 Jean-Philippe Lang
production:
164 54 Barbara Post
  adapter: mysql
165
  database: redmine
166 1 Jean-Philippe Lang
  host: localhost
167 54 Barbara Post
  port: 3307
168
  username: redmine
169
  password: my_password
170
</pre>
171 44 Alexey Lustin
172
173
Example for a PostgreSQL database (default port):
174
175
<pre>
176
production:
177
  adapter: postgresql
178 46 Istvan DEMETER
  database: <your_database_name>
179 1 Jean-Philippe Lang
  host: <postgres_host>
180
  username: <postgres_user>
181
  password: <postgres_user_password>
182
  encoding: utf8
183
  schema_search_path: <database_schema> (default - public)
184
</pre>
185
186 165 Etienne Massip
h3. Step 5 - Session store secret generation
187 1 Jean-Philippe Lang
188 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
189
Generating a new secret token invalidates all existing sessions after restart.
190
191 151 Jean-Philippe Lang
* with Redmine 1.4.x:
192
193
<pre>
194
rake generate_session_store
195 1 Jean-Philippe Lang
</pre>
196 151 Jean-Philippe Lang
197 1 Jean-Philippe Lang
* with Redmine 2.x:
198
199 151 Jean-Philippe Lang
<pre>
200 1 Jean-Philippe Lang
rake generate_secret_token
201
</pre>
202 90 Jiongliang Zhang
203 165 Etienne Massip
h3. Step 6 - Database schema objects creation
204 90 Jiongliang Zhang
205 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
206
207 1 Jean-Philippe Lang
  RAILS_ENV=production rake db:migrate
208
209 184 Etienne Massip
Windows syntax:
210 1 Jean-Philippe Lang
211 184 Etienne Massip
 set RAILS_ENV=production
212
rake db:migrate
213
214
It will create tables by running all migrations one by one then create the set of the permissions and the application administrator account, named @admin@.
215
216
+Ubuntu troubleshooting:+
217 1 Jean-Philippe Lang
218 165 Etienne Massip
If you get this error with Ubuntu:
219 90 Jiongliang Zhang
<pre>
220 114 Etienne Massip
Rake aborted!
221 1 Jean-Philippe Lang
no such file to load -- net/https
222
</pre>
223
224 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
225 1 Jean-Philippe Lang
226 165 Etienne Massip
h3. Step 7 - Database default data set
227 1 Jean-Philippe Lang
228 165 Etienne Massip
Insert default configuration data in database, by running the following command:
229
230 1 Jean-Philippe Lang
  RAILS_ENV=production rake redmine:load_default_data
231 62 Vladimir L
232 171 Etienne Massip
Redmine will prompt you for the data set language that should be loaded; you can also define the @REDMINE_LANG@ environment variable before running the command to a value which will be automatically and silently picked up by the task.
233
234
E.g.:
235
236
Unices:
237
238
  RAILS_ENV=production REDMINE_LANG=fr rake redmine:load_default_data
239
240
Windows:
241
<pre>
242
set RAILS_ENV=production
243
set REDMINE_LANG=fr
244
rake redmine:load_default_data
245
</pre>
246 32 Jean-Philippe Lang
247 167 Etienne Massip
h3. Step 8 - File system permissions
248 32 Jean-Philippe Lang
249 165 Etienne Massip
NB: _Windows users can skip this section._
250 14 Jean-Philippe Lang
251 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
252 1 Jean-Philippe Lang
253 165 Etienne Massip
# @files@ (storage of attachments)
254
# @log@ (application log file @production.log@)
255 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
256 1 Jean-Philippe Lang
257 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
258 165 Etienne Massip
259 1 Jean-Philippe Lang
<pre>
260 167 Etienne Massip
mkdir tmp tmp/pdf public/plugin_assets
261 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
262
sudo chmod -R 755 files log tmp public/plugin_assets
263
</pre>
264
265 165 Etienne Massip
h3. Step 9 - Test the installation
266 1 Jean-Philippe Lang
267 165 Etienne Massip
Test the installation by running WEBrick web server:
268
269 1 Jean-Philippe Lang
* with Redmine 1.4.x:
270
271 151 Jean-Philippe Lang
<pre>
272
ruby script/server webrick -e production
273 1 Jean-Philippe Lang
</pre>
274
275 151 Jean-Philippe Lang
* with Redmine 2.x:
276
277
<pre>
278
ruby script/rails server webrick -e production
279
</pre>
280
281
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
282
283 165 Etienne Massip
> Note: Webrick is *not* suitable for production use, please only use webrick for testing that the installation up to this point is functional. Use one of the many other guides in this wiki to setup redmine to use either Passenger (aka @mod_rails@), FCGI or a Rack server (Unicorn, Thin, Puma, hellip;) to serve up your redmine.
284 14 Jean-Philippe Lang
285 165 Etienne Massip
h3. Step 10 - Logging into the application
286 158 Etienne Massip
287 165 Etienne Massip
Use default administrator account to log in:
288
289 1 Jean-Philippe Lang
    * login: admin
290
    * password: admin
291 14 Jean-Philippe Lang
292 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
293
294 130 Etienne Massip
h2. Configuration
295 1 Jean-Philippe Lang
296 185 Etienne Massip
Redmine settings are defined in a file named @config/configuration.yml@.
297 1 Jean-Philippe Lang
298 185 Etienne Massip
If you need to override default application settings, simply copy @config/configuration.yml.example@ to @config/configuration.yml@ and edit the new file; the file is well commented by itself, so you should have a look at it.
299 1 Jean-Philippe Lang
300 185 Etienne Massip
These settings may be defined per Rails environment (@production@/@development@/@test@).
301 131 Etienne Massip
302
+Important+ : don't forget to restart the application after any change.
303
304 130 Etienne Massip
h3. Email / SMTP server settings
305
306 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
307 1 Jean-Philippe Lang
308
h3. SCM settings
309
310 133 Etienne Massip
This configuration section allows you to:
311 131 Etienne Massip
* override default commands names if the SCM binaries present in the @PATH@ variable doesn't use the standard name (Windows .bat/.cmd names won't work)
312
* specify the full path to the binary
313
314 133 Etienne Massip
Examples (with Subversion):
315 131 Etienne Massip
316 133 Etienne Massip
Command name override:
317 131 Etienne Massip
318
 scm_subversion_command: "svn_replacement.exe"
319
320 133 Etienne Massip
Absolute path:
321 1 Jean-Philippe Lang
322
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
323
324
h3. Attachment storage settings
325
326 133 Etienne Massip
You can set a path where Redmine attachments will be stored which is different from the default 'files' directory of your Redmine instance using the @attachments_storage_path@ setting.
327
328
Examples:
329
330
 attachments_storage_path: /var/redmine/files
331
332
 attachments_storage_path: D:/redmine/files
333 130 Etienne Massip
334
h2. Logging configuration
335
336 101 T. Hauptman
Redmine defaults to a log level of :info, writing to the @log@ subdirectory. Depending on site usage, this can be a lot of data so to avoid the contents of the logfile growing without bound, consider rotating them, either through a system utility like @logrotate@ or via the @config/additional_environment.rb@ file.
337 21 Jean-Philippe Lang
338
To use the latter, copy @config/additional_environment.rb.example@ to @config/additional_environment.rb@ and add the following lines. Note that the new logger defaults to a high log level and hence has to be explicitly set to @info@.
339 123 Jean-Philippe Lang
<pre><code class="ruby">
340 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
341 162 Jean-Philippe Lang
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
342 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
343
</code></pre>
344
345
h2. Backups
346
347
Redmine backups should include:
348
* data (stored in your redmine database)
349
* attachments (stored in the @files@ directory of your Redmine install)
350
351
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
352
353
<pre>
354
# Database
355 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
356 11 Jean-Philippe Lang
357
# Attachments
358 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
359
</pre>
360 69 Giuliano Simoncelli
361
h2. Notes on Windows installation
362
363 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
364
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
365 1 Jean-Philippe Lang
366 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
367 69 Giuliano Simoncelli
368 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
369 1 Jean-Philippe Lang
370 156 Etienne Massip
I.e. commands with the following syntaxes:
371 69 Giuliano Simoncelli
372 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
373 69 Giuliano Simoncelli
374 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
375 1 Jean-Philippe Lang
376 156 Etienne Massip
have to be turned into 2 subsequent commands:
377 69 Giuliano Simoncelli
378 156 Etienne Massip
<pre>set RAILS_ENV=production
379
<any commmand></pre>
380
381
+MySQL gem installation issue:+
382
383
You may need to manually install the mysql gem using the following command:
384
385 69 Giuliano Simoncelli
<pre>
386
gem install mysql
387
</pre>
388 1 Jean-Philippe Lang
389 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
390
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll.
391
392 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
393
On Win7 and later, @localhost@ is commented out in the hosts file[1] and IPV6 is the default[2]. As the mysql2 gem does no support IPV6 addresses[3], a connection can't be established and you get the error "@Can't connect to MySQL server on 'localhost' (10061)@".
394
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
395
396
+Workaround:+
397
Replace @localhost@ with @127.0.0.1@ in database.yml.
398
399
fn1. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
400
401
fn2. http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx
402
403
fn3. https://github.com/brianmario/mysql2/issues/279
404
405 80 Jean-Philippe Lang
406
h2. Alternative to manual installation
407
408
Some users may prefer to skip manual installation by using one of the [[Download#Third-party-Redmine-bundles|third-party Redmine bundles]] on the download page.