Project

General

Profile

RedmineInstall » History » Version 94

Felix Schäfer, 2010-07-12 23:14

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 68 Mischa The Evil
Redmine should run on most Unix, Linux, Mac and Windows systems as long as Ruby is available on this platform.
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 78 Jean-Philippe Lang
|0.9.x|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
20 77 Anonymous
|0.8.x|ruby 1.8.6, 1.8.7|Rails 2.1.2||
21
|0.7.x|ruby 1.8.6|Rails 2.0.2||
22 22 Jean-Philippe Lang
23
Official releases include the appropriate Rails version in their @vendor@ directory. So no particular action is needed.
24 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:
25
26 78 Jean-Philippe Lang
  gem install rails -v=2.3.5
27 1 Jean-Philippe Lang
28 91 Kedar Mhaswade
Install Rack:
29
 
30
  gem install rack -v=1.0.1
31
32 28 Jean-Philippe Lang
Notes:
33 94 Felix Schäfer
* *Ruby 1.9 is not supported yet.* You _have_ to use Ruby 1.8.x as stated above.
34 27 Jean-Philippe Lang
* RubyGems 1.3.1 is required
35 1 Jean-Philippe Lang
* Rake 0.8.3 is required
36 91 Kedar Mhaswade
* Rack 1.0.1 is required. If you don't have this exact version, database migration would fail.
37 1 Jean-Philippe Lang
38 25 Jean-Philippe Lang
h3. Database
39
40 93 Muntek Singh
* MySQL 5.0 or higher (recommended)
41 92 Knight Samar
42 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
43 35 Jean-Philippe Lang
44
* PostgreSQL 8
45 1 Jean-Philippe Lang
46 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";@
47 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
48 76 Randy Syring
 * make sure to install the PosgreSQL adapter for Ruby. You can get it by running (**one** of the following):
49
 **  @gem install postgres-pr@
50
 **  @gem install pg@ (works with SSL connections, may need development libraries/packages for your OS before it will compile)
51 84 Randy Syring
 *** Ubuntu OS: development libraries can be installed with (or similiar): @sudo aptitude install libdbd-pg-ruby1.8@
52 35 Jean-Philippe Lang
53
* SQLite 3
54 26 Jean-Philippe Lang
55 25 Jean-Philippe Lang
h3. Optional components
56 23 Jean-Philippe Lang
57 25 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
58
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
59 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.
60 1 Jean-Philippe Lang
61 8 Thomas Lecavelier
h2. Installation
62 1 Jean-Philippe Lang
63 6 Jean-Philippe Lang
1. [[Download]] and extract the archive or [[CheckingoutRedmine|checkout]] Redmine.
64
65 36 Yclept Nemo
2. Create an empty database and accompanying user named @redmine@ for example.
66 6 Jean-Philippe Lang
67
For MySQL:
68 1 Jean-Philippe Lang
69 38 Yclept Nemo
<pre>
70 39 Yclept Nemo
create database redmine character set utf8;
71
create user 'redmine'@'localhost' identified by 'my_password';
72
grant all privileges on redmine.* to 'redmine'@'localhost';
73 38 Yclept Nemo
</pre>
74 1 Jean-Philippe Lang
75 88 Sean Farrell
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
76
<pre>
77
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
78
</pre>
79
80 63 Thanos Kyritsis
For PostgreSQL:
81
82
<pre>
83
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
84 64 Thanos Kyritsis
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
85 63 Thanos Kyritsis
</pre>
86
87 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.
88 1 Jean-Philippe Lang
89 14 Jean-Philippe Lang
Example for a MySQL database:
90
91
<pre>
92
production:
93
  adapter: mysql
94
  database: redmine
95
  host: localhost
96 40 Yclept Nemo
  username: redmine
97
  password: my_password
98 3 Jean-Philippe Lang
</pre>
99
100 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
101
102
<pre>
103
production:
104
  adapter: mysql
105
  database: redmine
106
  host: localhost
107
  port: 3307
108
  username: redmine
109
  password: my_password
110
</pre>
111
112
113
Example for a PostgreSQL database (default port):
114 44 Alexey Lustin
115
<pre>
116
production:
117
  adapter: postgresql
118
  database: <your_database_name>
119
  host: <postgres_host>
120
  username: <postgres_user>
121 46 Istvan DEMETER
  password: <postgres_user_password>
122 1 Jean-Philippe Lang
  encoding: utf8
123 44 Alexey Lustin
  schema_search_path: <database_schema> (default - public)
124
</pre>
125
126 68 Mischa The Evil
4. Generate a session store secret. This is required on the *trunk* version of Redmine at r2493 or above and the released 0.8.7 version or above.
127 1 Jean-Philippe Lang
128 48 Mat Tipton
Redmine stores session data in cookies by default, which requires a secret to be generated. This can be done by running:
129 41 Yclept Nemo
130 83 Prabhas Pokharel
   RAILS_ENV=production rake config/initializers/session_store.rb
131 41 Yclept Nemo
132 82 Simon Carpinter
If you're using an SVN version of Redmine post r3055, the above file will no longer exist; it was deprecated as of r3054.  On these versions, run
133
134
   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 32 Jean-Philippe Lang
9. Use default administrator account to log in:
178 1 Jean-Philippe Lang
179
    * login: admin
180 14 Jean-Philippe Lang
    * password: admin
181 1 Jean-Philippe Lang
182
You can go to @Admin & Settings@ to modify application settings.
183
184 21 Jean-Philippe Lang
h2. SMTP server Configuration
185
186 66 Henry Bernard
Copy @config/email.yml.example@ to @config/email.yml@ and edit this file to adjust your SMTP settings.
187 21 Jean-Philippe Lang
188 45 Cyber Sprocket
See the [[Email Configuration|email configuration]] examples.
189 11 Jean-Philippe Lang
190
Don't forget to restart the application after any change.
191
192
h2. Backups
193
194
Redmine backups should include:
195
* data (stored in your redmine database)
196
* attachments (stored in the @files@ directory of your Redmine install)
197
198
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
199
200
<pre>
201
# Database
202 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
203 11 Jean-Philippe Lang
204
# Attachments
205 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
206
</pre>
207 69 Giuliano Simoncelli
208
h2. Notes on Windows installation
209
210
Get and install rubyinstaller from http://rubyforge.org. Form start menu select _Start Command Prompt with Ruby_
211
212
In the prompt follow the instruction given before
213
214
The commands:
215
216
<pre>
217
RAILS_ENV=production rake db:migrate
218
RAILS_ENV=production rake redmine:load_default_data
219
</pre>
220
221
has to be changed in 
222
223
<pre>
224
set RAILS_ENV=production
225
rake db:migrate
226 71 Giuliano Simoncelli
rake redmine:load_default_data
227 69 Giuliano Simoncelli
</pre>  
228
229 70 Giuliano Simoncelli
You may need to install install the mysql gem, with the command
230 69 Giuliano Simoncelli
231
<pre>
232
gem install mysql
233 1 Jean-Philippe Lang
</pre>
234
235
And in some case is required to copy the libmysql.dll file in your ruby/bin directory.
236
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll
237 80 Jean-Philippe Lang
238 87 Alex Ford
h3. Problems with MySQL 5.1 and Rails 2.2+
239
240
With the latest version of MySQL, you may get several errors such as: "!!! The bundled mysql.rb driver has been removed from Ruby 2.2" and when you try to do "gem install mysql" you may also get many errors. Attempting to perform any rake commands subsequently fail. One possible solution:
241
242
Try to download the following DLL file from the InstantRails project:
243
244
http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll
245
246
Copy this file into your \Ruby\bin directory and try running your rake commands again.
247
248 80 Jean-Philippe Lang
h2. Alternative to manual installation
249
250
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.