Project

General

Profile

RedmineInstall » History » Version 205

Etienne Massip, 2013-03-20 09:54

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