Project

General

Profile

RedmineInstall » History » Version 82

Simon Carpinter, 2010-01-13 20:33
Updated to reflect change to session_store.rb as of r3054.

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 27 Jean-Philippe Lang
* RubyGems 1.3.1 is required
30 25 Jean-Philippe Lang
* Rake 0.8.3 is required
31 1 Jean-Philippe Lang
32 25 Jean-Philippe Lang
h3. Database
33
34 68 Mischa The Evil
* MySQL 4.1 or higher (recommended)
35 50 Mat Tipton
36 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@.
37
 * the Ruby MySQL gem currently does not support MySQL 5.1
38 35 Jean-Philippe Lang
39
* PostgreSQL 8
40 1 Jean-Philippe Lang
41 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";@
42 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
43 76 Randy Syring
 * make sure to install the PosgreSQL adapter for Ruby. You can get it by running (**one** of the following):
44
 **  @gem install postgres-pr@
45
 **  @gem install pg@ (works with SSL connections, may need development libraries/packages for your OS before it will compile)
46 81 Jiongliang Zhang
 ** *Ubuntu OS: You can install it by this command: sudo aptitude install libdbd-pg-ruby1.8*
47 35 Jean-Philippe Lang
48
* SQLite 3
49 26 Jean-Philippe Lang
50 25 Jean-Philippe Lang
h3. Optional components
51 23 Jean-Philippe Lang
52 25 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
53
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
54 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.
55 1 Jean-Philippe Lang
56 8 Thomas Lecavelier
h2. Installation
57 1 Jean-Philippe Lang
58 6 Jean-Philippe Lang
1. [[Download]] and extract the archive or [[CheckingoutRedmine|checkout]] Redmine.
59
60 36 Yclept Nemo
2. Create an empty database and accompanying user named @redmine@ for example.
61 6 Jean-Philippe Lang
62
For MySQL:
63 1 Jean-Philippe Lang
64 38 Yclept Nemo
<pre>
65 39 Yclept Nemo
create database redmine character set utf8;
66
create user 'redmine'@'localhost' identified by 'my_password';
67
grant all privileges on redmine.* to 'redmine'@'localhost';
68 38 Yclept Nemo
</pre>
69 1 Jean-Philippe Lang
70 63 Thanos Kyritsis
For PostgreSQL:
71
72
<pre>
73
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
74 64 Thanos Kyritsis
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
75 63 Thanos Kyritsis
</pre>
76
77 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.
78 1 Jean-Philippe Lang
79 14 Jean-Philippe Lang
Example for a MySQL database:
80
81
<pre>
82
production:
83
  adapter: mysql
84
  database: redmine
85
  host: localhost
86 40 Yclept Nemo
  username: redmine
87
  password: my_password
88 3 Jean-Philippe Lang
</pre>
89
90 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
91
92
<pre>
93
production:
94
  adapter: mysql
95
  database: redmine
96
  host: localhost
97
  port: 3307
98
  username: redmine
99
  password: my_password
100
</pre>
101
102
103
Example for a PostgreSQL database (default port):
104 44 Alexey Lustin
105
<pre>
106
production:
107
  adapter: postgresql
108
  database: <your_database_name>
109
  host: <postgres_host>
110
  username: <postgres_user>
111 46 Istvan DEMETER
  password: <postgres_user_password>
112 1 Jean-Philippe Lang
  encoding: utf8
113 44 Alexey Lustin
  schema_search_path: <database_schema> (default - public)
114
</pre>
115
116 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.
117 1 Jean-Philippe Lang
118 48 Mat Tipton
Redmine stores session data in cookies by default, which requires a secret to be generated. This can be done by running:
119 41 Yclept Nemo
120 61 Ethan Fremen
   rake config/initializers/session_store.rb
121 41 Yclept Nemo
122 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
123
124
   rake generate_session_store
125
126 41 Yclept Nemo
5. Create the database structure, by running the following command under the application root directory:
127
128 62 Vladimir L
  RAILS_ENV=production rake db:migrate
129 1 Jean-Philippe Lang
130
It will create tables and an administrator account.
131
132 41 Yclept Nemo
6. Insert default configuration data in database, by running the following command:
133 1 Jean-Philippe Lang
134 62 Vladimir L
  RAILS_ENV=production rake redmine:load_default_data
135 32 Jean-Philippe Lang
136
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.
137
138
7. Setting up permissions
139
140 14 Jean-Philippe Lang
NB: _Windows users have to skip this section._
141
142
The user who runs Redmine must have write permission on the following subdirectories: @files@, @log@, @tmp@ (create the last one if not present).
143
144
Assuming you run Redmine with a @redmine@ user:
145
146 31 Eric Davis
<pre>
147 1 Jean-Philippe Lang
mkdir tmp public/plugin_assets
148 31 Eric Davis
sudo chown -R redmine:redmine files log tmp public/plugin_assets
149 14 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
150
</pre>
151 1 Jean-Philippe Lang
152 32 Jean-Philippe Lang
8. Test the installation by running WEBrick web server:
153 1 Jean-Philippe Lang
154 33 Jean-Philippe Lang
  ruby script/server webrick -e production
155 1 Jean-Philippe Lang
156 14 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
157 1 Jean-Philippe Lang
158 32 Jean-Philippe Lang
9. Use default administrator account to log in:
159 1 Jean-Philippe Lang
160
    * login: admin
161 14 Jean-Philippe Lang
    * password: admin
162 1 Jean-Philippe Lang
163
You can go to @Admin & Settings@ to modify application settings.
164
165 21 Jean-Philippe Lang
h2. SMTP server Configuration
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 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 71 Giuliano Simoncelli
rake redmine:load_default_data
208 69 Giuliano Simoncelli
</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 1 Jean-Philippe Lang
</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
218 80 Jean-Philippe Lang
219
h2. Alternative to manual installation
220
221
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.