Project

General

Profile

RedmineInstall » History » Version 142

Etienne Massip, 2012-01-05 13:34
Removed old trunk requirements

1 1 Jean-Philippe Lang
h1. Installing Redmine
2
3
{{>TOC}}
4 73 Liraz Siri
5 1 Jean-Philippe Lang
h2. Requirements
6
7 25 Jean-Philippe Lang
h3. Operating system
8 1 Jean-Philippe Lang
9 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]].
10 25 Jean-Philippe Lang
11 91 Kedar Mhaswade
h3. Ruby & Ruby on Rails & Rack
12 25 Jean-Philippe Lang
13 30 Jean-Philippe Lang
The required Ruby and Ruby on Rails versions for a given Redmine version is:
14 25 Jean-Philippe Lang
15 77 Anonymous
|_. Redmine version|_. Supported Ruby versions|_. Required Rails version|_. Required Rack version|
16 141 Etienne Massip
|current trunk|ruby 1.8.7, 1.9.2, 1.9.3|Rails 2.3.14|Rack 1.1.1|
17
|1.3.x|ruby 1.8.6, 1.8.7|Rails 2.3.14|Rack 1.1.1|
18 124 Etienne Massip
|1.2.x|ruby 1.8.6, 1.8.7|Rails 2.3.11|Rack 1.1.1|
19 113 Etienne Massip
|1.1.x|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
20 96 Felix Schäfer
|1.0.x|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
21 78 Jean-Philippe Lang
|0.9.x|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
22 77 Anonymous
|0.8.x|ruby 1.8.6, 1.8.7|Rails 2.1.2||
23 22 Jean-Philippe Lang
24 137 Etienne Massip
Official releases include the appropriate Rails version in their @vendor@ directory so you only need to make sure that you have the right Ruby/RubyGems/Rake/Rack stack installed.
25
26 1 Jean-Philippe Lang
If you checkout the source from the Redmine repository, you can install a specific Rails version on your machine by running:
27
28 123 Jean-Philippe Lang
  gem install rails -v=2.3.11
29 1 Jean-Philippe Lang
30
Install Rack:
31 125 Etienne Massip
32 137 Etienne Massip
  gem install rack -v=1.1.1
33 1 Jean-Philippe Lang
34 125 Etienne Massip
h3. Compatibility notes
35 1 Jean-Philippe Lang
36
* *Ruby 1.9 is not supported yet.* You _have_ to use Ruby 1.8.x as stated above.
37 140 Mischa The Evil
* *RubyGems* 1.3.7 or higher is required with following limitations :
38
** *Rails 2.3.5 will fail with RubyGems 1.5.0 or later*, stick to previous versions of RubyGems !
39
** *Rails 2.3.11 will fail with RubyGems 1.7.0 or later*, stick to previous versions of RubyGems !
40 128 Jean-Baptiste Barth
* *Rake 0.8.7 is required* (rake 0.9.x is not supported by Rails yet)
41 140 Mischa The Evil
* *Rack* 1.1.x is required, 1.1.0 has a bug with quotes (#8416). Database migration would fail with other version.
42 125 Etienne Massip
* *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).
43 140 Mischa The Evil
* *I18n* 0.4.2 is required for Redmine >= 1.0.5
44
* *Rails* 2.3.11 to 2.3.14 suffer from a major issue with sending mails to multiple recipients, see #8751 for details and solution.
45
* *Rails* 2.3.14 is a minor security release known to work fine with Redmine 1.2.x series (except for previous point) and can be used as a replacement for 2.3.11 (read @config/environment.rb@ first).
46 1 Jean-Philippe Lang
47 25 Jean-Philippe Lang
h3. Database
48
49 93 Muntek Singh
* MySQL 5.0 or higher (recommended)
50 92 Knight Samar
51 68 Mischa The Evil
 * make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running @gem install mysql@. If you have problem installing the mysql gem refer "Rails Wiki pages":http://wiki.rubyonrails.org/database-support/mysql
52 35 Jean-Philippe Lang
53
* PostgreSQL 8
54 1 Jean-Philippe Lang
55 35 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";@
56 114 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
57 76 Randy Syring
 * make sure to install the PosgreSQL adapter for Ruby. You can get it by running (**one** of the following):
58 117 Etienne Massip
 **  @gem install postgres-pr@ (native Ruby implementation no more actively maintained by its author, presents "issues":https://github.com/mneumann/postgres-pr/issues#issue/4 with 9.x)
59 76 Randy Syring
 **  @gem install pg@ (works with SSL connections, may need development libraries/packages for your OS before it will compile)
60 114 Etienne Massip
 *** Ubuntu OS: development libraries can be installed with (or similar): @sudo aptitude install libdbd-pg-ruby1.8@
61 35 Jean-Philippe Lang
62
* SQLite 3
63 26 Jean-Philippe Lang
64 25 Jean-Philippe Lang
h3. Optional components
65 23 Jean-Philippe Lang
66 25 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
67
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
68 56 Eric Davis
      * "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.
69 1 Jean-Philippe Lang
70 129 Etienne Massip
h2. Redmine Version
71 107 Muntek Singh
72 130 Etienne Massip
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.
73 107 Muntek Singh
74 129 Etienne Massip
h2. Installation procedure
75 1 Jean-Philippe Lang
76 111 Jean-Philippe Lang
1. Get the Redmine source code by either downloading a packaged release or checking out the code repository. See [[Download]].
77 6 Jean-Philippe Lang
78 36 Yclept Nemo
2. Create an empty database and accompanying user named @redmine@ for example.
79 6 Jean-Philippe Lang
80
For MySQL:
81 1 Jean-Philippe Lang
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
</pre>
92
93 63 Thanos Kyritsis
For PostgreSQL:
94
95
<pre>
96
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
97 64 Thanos Kyritsis
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
98 63 Thanos Kyritsis
</pre>
99
100 3 Jean-Philippe Lang
3. 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 14 Jean-Philippe Lang
Example for a MySQL database:
103
104
<pre>
105
production:
106
  adapter: mysql
107
  database: redmine
108
  host: localhost
109 40 Yclept Nemo
  username: redmine
110
  password: my_password
111 3 Jean-Philippe Lang
</pre>
112
113 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
114
115
<pre>
116
production:
117
  adapter: mysql
118
  database: redmine
119
  host: localhost
120
  port: 3307
121
  username: redmine
122
  password: my_password
123
</pre>
124
125
126
Example for a PostgreSQL database (default port):
127 44 Alexey Lustin
128
<pre>
129
production:
130
  adapter: postgresql
131
  database: <your_database_name>
132
  host: <postgres_host>
133
  username: <postgres_user>
134 46 Istvan DEMETER
  password: <postgres_user_password>
135 1 Jean-Philippe Lang
  encoding: utf8
136 44 Alexey Lustin
  schema_search_path: <database_schema> (default - public)
137
</pre>
138
139 111 Jean-Philippe Lang
4. Generate a session store secret.
140 1 Jean-Philippe Lang
141 82 Simon Carpinter
   rake generate_session_store
142
143 41 Yclept Nemo
5. Create the database structure, by running the following command under the application root directory:
144
145 62 Vladimir L
  RAILS_ENV=production rake db:migrate
146 1 Jean-Philippe Lang
147 90 Jiongliang Zhang
148 1 Jean-Philippe Lang
It will create tables and an administrator account.
149 90 Jiongliang Zhang
150
If you get this error: 
151
<pre>
152
Rake aborted!
153
no such file to load -- net/https
154
</pre>
155
156 114 Etienne Massip
you need to install libopenssl-ruby1.8, in Ubuntu, just like this: apt-get install libopenssl-ruby1.8
157 1 Jean-Philippe Lang
158 41 Yclept Nemo
6. Insert default configuration data in database, by running the following command:
159 1 Jean-Philippe Lang
160 62 Vladimir L
  RAILS_ENV=production rake redmine:load_default_data
161 32 Jean-Philippe Lang
162
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.
163
164
7. Setting up permissions
165
166 14 Jean-Philippe Lang
NB: _Windows users have to skip this section._
167
168
The user who runs Redmine must have write permission on the following subdirectories: @files@, @log@, @tmp@ (create the last one if not present).
169
170
Assuming you run Redmine with a @redmine@ user:
171
172 31 Eric Davis
<pre>
173 1 Jean-Philippe Lang
mkdir tmp public/plugin_assets
174 31 Eric Davis
sudo chown -R redmine:redmine files log tmp public/plugin_assets
175 14 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
176
</pre>
177 1 Jean-Philippe Lang
178 32 Jean-Philippe Lang
8. Test the installation by running WEBrick web server:
179 1 Jean-Philippe Lang
180 33 Jean-Philippe Lang
  ruby script/server webrick -e production
181 1 Jean-Philippe Lang
182 14 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
183 1 Jean-Philippe Lang
184 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. 
185
186 32 Jean-Philippe Lang
9. Use default administrator account to log in:
187 1 Jean-Philippe Lang
188
    * login: admin
189 14 Jean-Philippe Lang
    * password: admin
190 1 Jean-Philippe Lang
191
You can go to @Admin & Settings@ to modify application settings.
192
193 130 Etienne Massip
h2. Configuration
194 1 Jean-Philippe Lang
195 131 Etienne Massip
Since of version:1.2.0, Redmine settings are defined in a file named @config/configuration.yml@.
196 130 Etienne Massip
197 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.
198 1 Jean-Philippe Lang
199 131 Etienne Massip
This settings may be defined per Rails environment (@production@/@development@/@test@).
200
201
+Important+ : don't forget to restart the application after any change.
202
203 130 Etienne Massip
h3. Email / SMTP server settings
204
205 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
206 1 Jean-Philippe Lang
207
h3. SCM settings
208
209 133 Etienne Massip
This configuration section allows you to:
210 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)
211
* specify the full path to the binary
212
213 133 Etienne Massip
Examples (with Subversion):
214 131 Etienne Massip
215 133 Etienne Massip
Command name override:
216 131 Etienne Massip
217
 scm_subversion_command: "svn_replacement.exe"
218
219 133 Etienne Massip
Absolute path:
220 1 Jean-Philippe Lang
221
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
222
223
h3. Attachment storage settings
224
225 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.
226
227
Examples:
228
229
 attachments_storage_path: /var/redmine/files
230
231
 attachments_storage_path: D:/redmine/files
232 130 Etienne Massip
233
h2. Logging configuration
234
235 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.
236 21 Jean-Philippe Lang
237
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@.
238 123 Jean-Philippe Lang
<pre><code class="ruby">
239 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
240 95 Mischa The Evil
config.logger = Logger.new(config.log_path, 2, 1000000)
241 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
242
</code></pre>
243
244
h2. Backups
245
246
Redmine backups should include:
247
* data (stored in your redmine database)
248
* attachments (stored in the @files@ directory of your Redmine install)
249
250
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
251
252
<pre>
253
# Database
254 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
255 11 Jean-Philippe Lang
256
# Attachments
257 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
258
</pre>
259 69 Giuliano Simoncelli
260
h2. Notes on Windows installation
261
262
Get and install rubyinstaller from http://rubyforge.org. Form start menu select _Start Command Prompt with Ruby_
263
264
In the prompt follow the instruction given before
265
266
The commands:
267
268
<pre>
269
RAILS_ENV=production rake db:migrate
270
RAILS_ENV=production rake redmine:load_default_data
271
</pre>
272
273
has to be changed in 
274
275
<pre>
276
set RAILS_ENV=production
277
rake db:migrate
278 71 Giuliano Simoncelli
rake redmine:load_default_data
279 69 Giuliano Simoncelli
</pre>  
280
281 70 Giuliano Simoncelli
You may need to install install the mysql gem, with the command
282 69 Giuliano Simoncelli
283
<pre>
284
gem install mysql
285 1 Jean-Philippe Lang
</pre>
286
287
And in some case is required to copy the libmysql.dll file in your ruby/bin directory.
288
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll
289 80 Jean-Philippe Lang
290
h2. Alternative to manual installation
291
292
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.