Project

General

Profile

RedmineInstall » History » Version 173

Etienne Massip, 2012-10-23 12:01

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