Project

General

Profile

RedmineInstall » History » Version 155

Jean-Philippe Lang, 2012-06-24 20:58

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 105 Josh Galvez
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|Mac]], [[RedmineInstallOSXServer|Mac Server]] and Windows systems as long as Ruby is available on this platform.  See specific installation HowTos [[HowTos|here]].
12 25 Jean-Philippe Lang
13 91 Kedar Mhaswade
h3. Ruby & Ruby on Rails & Rack
14 25 Jean-Philippe Lang
15 1 Jean-Philippe Lang
The required Ruby and Ruby on Rails versions for a given Redmine version is:
16
17 147 Jean-Philippe Lang
|_. Redmine version|_. Supported Ruby versions|_. Required Rails version|_. Supported RubyGems versions|
18 155 Jean-Philippe Lang
|current trunk|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.6|RubyGems <= 1.8|
19
|2.0.3|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.6|RubyGems <= 1.8|
20 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|
21
|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|
22 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|
23 1 Jean-Philippe Lang
24 125 Etienne Massip
h3. Compatibility notes
25 140 Mischa The Evil
26
* *Mongrel* 1.1.5 needs a patch attached to #7688 to work fine with Rails 2.3.11. In case of upgrade, another issue may appear for some time after migration (#7857).
27 25 Jean-Philippe Lang
28 93 Muntek Singh
h3. Database
29 92 Knight Samar
30 146 Etienne Massip
* MySQL 5.0 or higher (recommended)
31 35 Jean-Philippe Lang
32
 * 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
33 1 Jean-Philippe Lang
34 154 Etienne Massip
* PostgreSQL 8 or higher (8.2 or higher starting from Redmine version:2.0.0)
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
* SQLite 3
40
41
h3. Optional components
42
43
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
44
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
45
      * "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.
46
47
h2. Redmine Version
48
49
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.
50
51 114 Etienne Massip
h2. Installation procedure
52 35 Jean-Philippe Lang
53
1. Get the Redmine source code by either downloading a packaged release or checking out the code repository. See [[Download]].
54 26 Jean-Philippe Lang
55 147 Jean-Philippe Lang
2. Since 1.4.0, Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies. You need to install Bundler first:
56 23 Jean-Philippe Lang
57 147 Jean-Philippe Lang
  gem install bundler
58
59
Then you can install all the gems required by Redmine using the following command:
60
61
  bundle install --without development test
62
63
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using: @`bundle install --without development test rmagick`@.
64
65 152 Etienne Massip
Sidenote concerning the installation of @rmagick@ on Windows:
66
67
>At the time of writing, there is little chance that the @rmagick@ gem installation (if not yet installed), go through fine when running the @bundle install@ command; you'll find some help [[HowTo_install_rmagick_gem_on_Windows|here]] .
68
69 147 Jean-Philippe Lang
You can also skip the installation of the database adapters you're not using. 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`@.
70
71 150 Mischa The Evil
If you need to load any gems that are not required by Redmine core (eg. mongrel, fcgi), create a file named @Gemfile.local@ at the root of your redmine directory. It will be loaded automatically when running `bundle install`. Example:
72 149 Jean-Philippe Lang
73
<pre>
74
# Gemfile.local
75
gem "mongrel"
76
</pre>
77 147 Jean-Philippe Lang
78
3. Create an empty database and accompanying user named @redmine@ for example.
79
80 1 Jean-Philippe Lang
For MySQL:
81
82 38 Yclept Nemo
<pre>
83 39 Yclept Nemo
create database redmine character set utf8;
84
create user 'redmine'@'localhost' identified by 'my_password';
85
grant all privileges on redmine.* to 'redmine'@'localhost';
86 38 Yclept Nemo
</pre>
87 1 Jean-Philippe Lang
88 88 Sean Farrell
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
89
<pre>
90
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
91 1 Jean-Philippe Lang
</pre>
92
93
For PostgreSQL:
94
95
<pre>
96
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
97
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
98
</pre>
99
100 147 Jean-Philippe Lang
4. Copy @config/database.yml.example@ to @config/database.yml@ and edit this file in order to configure your database settings for "production" environment.
101 1 Jean-Philippe Lang
102 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.8 or jruby:
103 88 Sean Farrell
104 63 Thanos Kyritsis
<pre>
105
production:
106
  adapter: mysql
107
  database: redmine
108 64 Thanos Kyritsis
  host: localhost
109 63 Thanos Kyritsis
  username: redmine
110 3 Jean-Philippe Lang
  password: my_password
111 1 Jean-Philippe Lang
</pre>
112 14 Jean-Philippe Lang
113 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.9 (adapter must be set to @mysql2@):
114
115
<pre>
116
production:
117
  adapter: mysql2
118
  database: redmine
119
  host: localhost
120
  username: redmine
121
  password: my_password
122
</pre>
123
124 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
125
126
<pre>
127 1 Jean-Philippe Lang
production:
128 54 Barbara Post
  adapter: mysql
129
  database: redmine
130 1 Jean-Philippe Lang
  host: localhost
131 54 Barbara Post
  port: 3307
132
  username: redmine
133
  password: my_password
134
</pre>
135
136 44 Alexey Lustin
137
Example for a PostgreSQL database (default port):
138
139
<pre>
140
production:
141
  adapter: postgresql
142
  database: <your_database_name>
143 46 Istvan DEMETER
  host: <postgres_host>
144 1 Jean-Philippe Lang
  username: <postgres_user>
145
  password: <postgres_user_password>
146
  encoding: utf8
147
  schema_search_path: <database_schema> (default - public)
148
</pre>
149
150
5. Generate a session store secret.
151
152 151 Jean-Philippe Lang
* with Redmine 1.4.x:
153 1 Jean-Philippe Lang
154 151 Jean-Philippe Lang
<pre>
155
rake generate_session_store
156
</pre>
157
158
* with Redmine 2.x:
159
160
<pre>
161
rake generate_secret_token
162
</pre>
163
164 147 Jean-Philippe Lang
6. Create the database structure, by running the following command under the application root directory:
165 1 Jean-Philippe Lang
166 90 Jiongliang Zhang
  RAILS_ENV=production rake db:migrate
167 1 Jean-Philippe Lang
168 90 Jiongliang Zhang
169
It will create tables and an administrator account.
170
171
If you get this error: 
172 1 Jean-Philippe Lang
<pre>
173 90 Jiongliang Zhang
Rake aborted!
174
no such file to load -- net/https
175
</pre>
176 114 Etienne Massip
177 1 Jean-Philippe Lang
you need to install libopenssl-ruby1.8, in Ubuntu, just like this: apt-get install libopenssl-ruby1.8
178 41 Yclept Nemo
179 147 Jean-Philippe Lang
7. Insert default configuration data in database, by running the following command:
180 1 Jean-Philippe Lang
181 62 Vladimir L
  RAILS_ENV=production rake redmine:load_default_data
182 32 Jean-Philippe Lang
183
This step is optional but *highly recommended*, as you can define your own configuration from scratch. It will load default roles, trackers, statuses, workflows and enumerations.
184
185 147 Jean-Philippe Lang
8. Setting up permissions
186 32 Jean-Philippe Lang
187 14 Jean-Philippe Lang
NB: _Windows users have to skip this section._
188
189
The user who runs Redmine must have write permission on the following subdirectories: @files@, @log@, @tmp@ (create the last one if not present).
190
191 1 Jean-Philippe Lang
Assuming you run Redmine with a @redmine@ user:
192
193
<pre>
194
mkdir tmp public/plugin_assets
195
sudo chown -R redmine:redmine files log tmp public/plugin_assets
196
sudo chmod -R 755 files log tmp public/plugin_assets
197
</pre>
198
199
9. Test the installation by running WEBrick web server:
200
201 151 Jean-Philippe Lang
* with Redmine 1.4.x:
202
203
<pre>
204
ruby script/server webrick -e production
205
</pre>
206
207
* with Redmine 2.x:
208
209
<pre>
210
ruby script/rails server webrick -e production
211
</pre>
212 1 Jean-Philippe Lang
213 14 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
214 1 Jean-Philippe Lang
215 103 Muntek Singh
> Note: Webrick is *not* suitable for normal use, please only use webrick for testing that the installation up to this point is functional. It is not recommended to use webrick for anything other than development. Use one of the many other guides in this wiki to setup redmine to use either passenger (aka mod_rails) or mongrel to serve up your redmine. 
216
217 147 Jean-Philippe Lang
10. Use default administrator account to log in:
218 1 Jean-Philippe Lang
219
    * login: admin
220 14 Jean-Philippe Lang
    * password: admin
221 1 Jean-Philippe Lang
222
You can go to @Admin & Settings@ to modify application settings.
223
224 130 Etienne Massip
h2. Configuration
225 1 Jean-Philippe Lang
226 131 Etienne Massip
Since of version:1.2.0, Redmine settings are defined in a file named @config/configuration.yml@.
227 130 Etienne Massip
228 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.
229 1 Jean-Philippe Lang
230 131 Etienne Massip
This settings may be defined per Rails environment (@production@/@development@/@test@).
231
232
+Important+ : don't forget to restart the application after any change.
233
234 130 Etienne Massip
h3. Email / SMTP server settings
235
236 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
237 1 Jean-Philippe Lang
238
h3. SCM settings
239
240 133 Etienne Massip
This configuration section allows you to:
241 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)
242
* specify the full path to the binary
243
244 133 Etienne Massip
Examples (with Subversion):
245 131 Etienne Massip
246 133 Etienne Massip
Command name override:
247 131 Etienne Massip
248
 scm_subversion_command: "svn_replacement.exe"
249
250 133 Etienne Massip
Absolute path:
251 1 Jean-Philippe Lang
252
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
253
254
h3. Attachment storage settings
255
256 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.
257
258
Examples:
259
260
 attachments_storage_path: /var/redmine/files
261
262
 attachments_storage_path: D:/redmine/files
263 130 Etienne Massip
264
h2. Logging configuration
265
266 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.
267 21 Jean-Philippe Lang
268
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@.
269 123 Jean-Philippe Lang
<pre><code class="ruby">
270 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
271 95 Mischa The Evil
config.logger = Logger.new(config.log_path, 2, 1000000)
272 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
273
</code></pre>
274
275
h2. Backups
276
277
Redmine backups should include:
278
* data (stored in your redmine database)
279
* attachments (stored in the @files@ directory of your Redmine install)
280
281
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
282
283
<pre>
284
# Database
285 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
286 11 Jean-Philippe Lang
287
# Attachments
288 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
289
</pre>
290 69 Giuliano Simoncelli
291
h2. Notes on Windows installation
292
293
Get and install rubyinstaller from http://rubyforge.org. Form start menu select _Start Command Prompt with Ruby_
294
295
In the prompt follow the instruction given before
296
297
The commands:
298
299
<pre>
300
RAILS_ENV=production rake db:migrate
301
RAILS_ENV=production rake redmine:load_default_data
302
</pre>
303
304
has to be changed in 
305
306
<pre>
307
set RAILS_ENV=production
308
rake db:migrate
309 71 Giuliano Simoncelli
rake redmine:load_default_data
310 69 Giuliano Simoncelli
</pre>  
311
312 70 Giuliano Simoncelli
You may need to install install the mysql gem, with the command
313 69 Giuliano Simoncelli
314
<pre>
315
gem install mysql
316 1 Jean-Philippe Lang
</pre>
317
318
And in some case is required to copy the libmysql.dll file in your ruby/bin directory.
319
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll
320 80 Jean-Philippe Lang
321
h2. Alternative to manual installation
322
323
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.