Project

General

Profile

RedmineInstall » History » Version 184

Etienne Massip, 2012-10-23 14:36

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 159 Jean-Philippe Lang
|current trunk|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.8|RubyGems <= 1.8|
19 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|
20 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|
21 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|
22
|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|
23 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|
24 1 Jean-Philippe Lang
25 164 Etienne Massip
h3. Supported database back-ends
26 92 Knight Samar
27 146 Etienne Massip
* MySQL 5.0 or higher (recommended)
28 35 Jean-Philippe Lang
29
 * 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
30 1 Jean-Philippe Lang
31 154 Etienne Massip
* PostgreSQL 8 or higher (8.2 or higher starting from Redmine version:2.0.0)
32 117 Etienne Massip
33 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";@
34 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
35 1 Jean-Philippe Lang
36
* SQLite 3
37
38
h3. Optional components
39
40
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
41 179 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to png image)
42 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.
43
44
h2. Redmine Version
45
46
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.
47
48 114 Etienne Massip
h2. Installation procedure
49 35 Jean-Philippe Lang
50 165 Etienne Massip
h3. Step 1 - Redmine application
51 26 Jean-Philippe Lang
52 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
53 1 Jean-Philippe Lang
54 174 Etienne Massip
See the [[Download|download page]] for details.
55 165 Etienne Massip
56
h3. Step 2 - Dependencies installation
57
58 175 Etienne Massip
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
59 165 Etienne Massip
60
You need to install Bundler first:
61
62 147 Jean-Philippe Lang
  gem install bundler
63
64
Then you can install all the gems required by Redmine using the following command:
65
66
  bundle install --without development test
67
68 168 Etienne Massip
h4. Optional dependencies
69
70 180 Etienne Massip
h5. RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
71 172 Etienne Massip
72 183 Etienne Massip
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
73 1 Jean-Philippe Lang
74 183 Etienne Massip
 @bundle install --without development test rmagick@
75
76
77 172 Etienne Massip
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
78 1 Jean-Philippe Lang
79
h5. Useless database adapters
80 172 Etienne Massip
81 1 Jean-Philippe Lang
You can also skip the installation of the database adapters you're not using.
82
83 183 Etienne Massip
For example, if you're using MySQL, you can skip the installation of the postgresql and sqlite gems using:
84
85
 @bundle install --without development test postgresql sqlite@
86 172 Etienne Massip
87 168 Etienne Massip
h4. Additional dependencies (@Gemfile.local@)
88 1 Jean-Philippe Lang
89 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@.
90 149 Jean-Philippe Lang
91 176 Etienne Massip
Example:
92 158 Etienne Massip
<pre>
93 149 Jean-Philippe Lang
# Gemfile.local
94 1 Jean-Philippe Lang
gem 'puma'
95
</pre>
96 147 Jean-Philippe Lang
97 165 Etienne Massip
h3. Step 3 - Create an empty database and accompanying user
98 1 Jean-Philippe Lang
99 165 Etienne Massip
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
100 1 Jean-Philippe Lang
101 166 Etienne Massip
h4. MySQL
102 165 Etienne Massip
103 39 Yclept Nemo
<pre>
104
create database redmine character set utf8;
105
create user 'redmine'@'localhost' identified by 'my_password';
106 1 Jean-Philippe Lang
grant all privileges on redmine.* to 'redmine'@'localhost';
107 88 Sean Farrell
</pre>
108
109 1 Jean-Philippe Lang
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
110 88 Sean Farrell
<pre>
111 1 Jean-Philippe Lang
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
112
</pre>
113
114 166 Etienne Massip
h4. PostgreSQL
115 1 Jean-Philippe Lang
116
<pre>
117
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
118
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
119
</pre>
120 166 Etienne Massip
121 169 Etienne Massip
h3. Step 4 - Database connection configuration
122 1 Jean-Philippe Lang
123 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.
124
125 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.8 or jruby:
126 88 Sean Farrell
127 63 Thanos Kyritsis
<pre>
128
production:
129
  adapter: mysql
130
  database: redmine
131 64 Thanos Kyritsis
  host: localhost
132 63 Thanos Kyritsis
  username: redmine
133 3 Jean-Philippe Lang
  password: my_password
134 1 Jean-Philippe Lang
</pre>
135 14 Jean-Philippe Lang
136 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.9 (adapter must be set to @mysql2@):
137
138
<pre>
139
production:
140
  adapter: mysql2
141
  database: redmine
142
  host: localhost
143
  username: redmine
144
  password: my_password
145
</pre>
146
147 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
148
149
<pre>
150 1 Jean-Philippe Lang
production:
151 54 Barbara Post
  adapter: mysql
152
  database: redmine
153 1 Jean-Philippe Lang
  host: localhost
154 54 Barbara Post
  port: 3307
155
  username: redmine
156
  password: my_password
157
</pre>
158 44 Alexey Lustin
159
160
Example for a PostgreSQL database (default port):
161
162
<pre>
163
production:
164
  adapter: postgresql
165 46 Istvan DEMETER
  database: <your_database_name>
166 1 Jean-Philippe Lang
  host: <postgres_host>
167
  username: <postgres_user>
168
  password: <postgres_user_password>
169
  encoding: utf8
170
  schema_search_path: <database_schema> (default - public)
171
</pre>
172
173 165 Etienne Massip
h3. Step 5 - Session store secret generation
174 1 Jean-Philippe Lang
175 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
176
Generating a new secret token invalidates all existing sessions after restart.
177
178 151 Jean-Philippe Lang
* with Redmine 1.4.x:
179
180
<pre>
181
rake generate_session_store
182 1 Jean-Philippe Lang
</pre>
183 151 Jean-Philippe Lang
184 1 Jean-Philippe Lang
* with Redmine 2.x:
185
186 151 Jean-Philippe Lang
<pre>
187 1 Jean-Philippe Lang
rake generate_secret_token
188
</pre>
189 90 Jiongliang Zhang
190 165 Etienne Massip
h3. Step 6 - Database schema objects creation
191 90 Jiongliang Zhang
192 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
193
194 1 Jean-Philippe Lang
  RAILS_ENV=production rake db:migrate
195
196 184 Etienne Massip
Windows syntax:
197 1 Jean-Philippe Lang
198 184 Etienne Massip
 set RAILS_ENV=production
199
rake db:migrate
200
201
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@.
202
203
+Ubuntu troubleshooting:+
204 1 Jean-Philippe Lang
205 165 Etienne Massip
If you get this error with Ubuntu:
206 90 Jiongliang Zhang
<pre>
207 114 Etienne Massip
Rake aborted!
208 1 Jean-Philippe Lang
no such file to load -- net/https
209
</pre>
210
211 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
212 1 Jean-Philippe Lang
213 165 Etienne Massip
h3. Step 7 - Database default data set
214 1 Jean-Philippe Lang
215 165 Etienne Massip
Insert default configuration data in database, by running the following command:
216
217 1 Jean-Philippe Lang
  RAILS_ENV=production rake redmine:load_default_data
218 62 Vladimir L
219 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.
220
221
E.g.:
222
223
Unices:
224
225
  RAILS_ENV=production REDMINE_LANG=fr rake redmine:load_default_data
226
227
Windows:
228
<pre>
229
set RAILS_ENV=production
230
set REDMINE_LANG=fr
231
rake redmine:load_default_data
232
</pre>
233 32 Jean-Philippe Lang
234 167 Etienne Massip
h3. Step 8 - File system permissions
235 32 Jean-Philippe Lang
236 165 Etienne Massip
NB: _Windows users can skip this section._
237 14 Jean-Philippe Lang
238 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
239 1 Jean-Philippe Lang
240 165 Etienne Massip
# @files@ (storage of attachments)
241
# @log@ (application log file @production.log@)
242 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
243 1 Jean-Philippe Lang
244 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
245 165 Etienne Massip
246 1 Jean-Philippe Lang
<pre>
247 167 Etienne Massip
mkdir tmp tmp/pdf public/plugin_assets
248 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
249
sudo chmod -R 755 files log tmp public/plugin_assets
250
</pre>
251
252 165 Etienne Massip
h3. Step 9 - Test the installation
253 1 Jean-Philippe Lang
254 165 Etienne Massip
Test the installation by running WEBrick web server:
255
256 1 Jean-Philippe Lang
* with Redmine 1.4.x:
257
258 151 Jean-Philippe Lang
<pre>
259
ruby script/server webrick -e production
260 1 Jean-Philippe Lang
</pre>
261
262 151 Jean-Philippe Lang
* with Redmine 2.x:
263
264
<pre>
265
ruby script/rails server webrick -e production
266
</pre>
267
268
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
269
270 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.
271 14 Jean-Philippe Lang
272 165 Etienne Massip
h3. Step 10 - Logging into the application
273 158 Etienne Massip
274 165 Etienne Massip
Use default administrator account to log in:
275
276 1 Jean-Philippe Lang
    * login: admin
277
    * password: admin
278 14 Jean-Philippe Lang
279 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
280
281 1 Jean-Philippe Lang
282 130 Etienne Massip
h2. Configuration
283 1 Jean-Philippe Lang
284 131 Etienne Massip
Since of version:1.2.0, Redmine settings are defined in a file named @config/configuration.yml@.
285 130 Etienne Massip
286 133 Etienne Massip
If you need to override default application settings, simply copy @config/configuration.yml.example@ to @config/configuration.yml@ then 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 131 Etienne Massip
This settings may be defined per Rails environment (@production@/@development@/@test@).
289
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 80 Jean-Philippe Lang
381
h2. Alternative to manual installation
382
383
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.