Project

General

Profile

RedmineInstall » History » Version 189

Mischa The Evil, 2013-01-13 04:43
Fixed and completed "Ruby interpreter"-section, added spacing in table for ease of editing and added collapsed cleanup-TODO.

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