Project

General

Profile

RedmineInstall » History » Version 226

Toshi MARUYAMA, 2014-10-13 07:54
split 2.4/2.5, add Ruby 2.1

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