Project

General

Profile

RedmineInstall » History » Version 215

Etienne Massip, 2013-04-11 17:55

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