Project

General

Profile

RedmineInstall » History » Version 187

Jan Niggemann (redmine.org team member), 2013-01-04 21:09
added 2.2.0, changed rails version for trunk

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