Project

General

Profile

RedmineInstall » History » Version 231

Toshi MARUYAMA, 2015-01-25 19:47
Redmine 2.x does not support Ruby 2.2. Redmine 3.0 will support Ruby 2.2

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