Project

General

Profile

RedmineInstall » History » Version 78

Jean-Philippe Lang, 2010-01-09 13:59
0.9.x requirements

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