Project

General

Profile

RedmineInstall » History » Version 207

Etienne Massip, 2013-03-20 10:00

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