Project

General

Profile

RedmineInstall » History » Version 132

Etienne Massip, 2011-07-09 12:04
Updated link to Email configuration page.

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