Project

General

Profile

RedmineInstall » History » Version 190

Etienne Massip, 2013-01-16 15:39
Added a MSSQL support note

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