Project

General

Profile

RedmineInstall » History » Version 73

Liraz Siri, 2009-12-17 02:22
added alternative to manual installation preamble (users that just want to get up and running quickly should be able to skip instructions for manual installation)

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