Project

General

Profile

RedmineInstall » History » Version 113

Etienne Massip, 2011-02-03 09:41

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