Project

General

Profile

RedmineInstall » History » Version 70

Giuliano Simoncelli, 2009-12-04 10:27

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