Project

General

Profile

RedmineInstall » History » Version 118

Jean-Philippe Lang, 2011-02-21 17:12
Rails 2.3.11 upgrade

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