Project

General

Profile

RedmineInstall » History » Version 92

Knight Samar, 2010-06-28 14:15
Added a link to Railswiki pages about installing MySQL gem

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