Project

General

Profile

RedmineInstall » History » Version 90

Jiongliang Zhang, 2010-04-28 09:46

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