Project

General

Profile

RedmineInstall » History » Version 152

Etienne Massip, 2012-05-25 13:19
Link to HowTo_install_rmagick_gem_on_Windows

1 1 Jean-Philippe Lang
h1. Installing Redmine
2
3
{{>TOC}}
4 73 Liraz Siri
5 147 Jean-Philippe Lang
This is the installation documentation for Redmine 1.4.0 and higher. You can still read the document for 1.3.x "here":/projects/redmine/wiki/RedmineInstall?version=146.
6
7 1 Jean-Philippe Lang
h2. Requirements
8
9 25 Jean-Philippe Lang
h3. Operating system
10 1 Jean-Philippe Lang
11 105 Josh Galvez
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|Mac]], [[RedmineInstallOSXServer|Mac Server]] and Windows systems as long as Ruby is available on this platform.  See specific installation HowTos [[HowTos|here]].
12 25 Jean-Philippe Lang
13 91 Kedar Mhaswade
h3. Ruby & Ruby on Rails & Rack
14 25 Jean-Philippe Lang
15 1 Jean-Philippe Lang
The required Ruby and Ruby on Rails versions for a given Redmine version is:
16
17 147 Jean-Philippe Lang
|_. Redmine version|_. Supported Ruby versions|_. Required Rails version|_. Supported RubyGems versions|
18 151 Jean-Philippe Lang
|current trunk|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.3|RubyGems <= 1.8|
19
|2.0.x|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.3|RubyGems <= 1.8|
20 147 Jean-Philippe Lang
|1.4.x|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 2.3.14|RubyGems <= 1.8|
21 1 Jean-Philippe Lang
22 125 Etienne Massip
h3. Compatibility notes
23 140 Mischa The Evil
24
* *Mongrel* 1.1.5 needs a patch attached to #7688 to work fine with Rails 2.3.11. In case of upgrade, another issue may appear for some time after migration (#7857).
25 25 Jean-Philippe Lang
26 93 Muntek Singh
h3. Database
27 92 Knight Samar
28 146 Etienne Massip
* MySQL 5.0 or higher (recommended)
29 35 Jean-Philippe Lang
30
 * make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running @gem install mysql2@. If you have problem installing the mysql gem refer "Rails Wiki pages":http://wiki.rubyonrails.org/database-support/mysql
31 1 Jean-Philippe Lang
32 147 Jean-Philippe Lang
* PostgreSQL 8 or higher
33 117 Etienne Massip
34 1 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";@
35 146 Etienne Massip
 * some bugs in PostgreSQL 8.4.0 and 8.4.1 affect Redmine behavior (#4259, #4314), they are fixed in PostgreSQL 8.4.2
36 1 Jean-Philippe Lang
37
* SQLite 3
38
39
h3. Optional components
40
41
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
42
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
43
      * "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.
44
45
h2. Redmine Version
46
47
It is recommended that the majority of users install the proper point releases of redmine. Redmine currently releases a new version every 6 months, and these releases are considered very usable and stable. It is *not* recommended to install redmine from trunk, unless you are deeply familiar with Ruby on Rails and keep up with the changes - Trunk _does_ break from time-to-time.
48
49 114 Etienne Massip
h2. Installation procedure
50 35 Jean-Philippe Lang
51
1. Get the Redmine source code by either downloading a packaged release or checking out the code repository. See [[Download]].
52 26 Jean-Philippe Lang
53 147 Jean-Philippe Lang
2. Since 1.4.0, Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies. You need to install Bundler first:
54 23 Jean-Philippe Lang
55 147 Jean-Philippe Lang
  gem install bundler
56
57
Then you can install all the gems required by Redmine using the following command:
58
59
  bundle install --without development test
60
61
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using: @`bundle install --without development test rmagick`@.
62
63 152 Etienne Massip
Sidenote concerning the installation of @rmagick@ on Windows:
64
65
>At the time of writing, there is little chance that the @rmagick@ gem installation (if not yet installed), go through fine when running the @bundle install@ command; you'll find some help [[HowTo_install_rmagick_gem_on_Windows|here]] .
66
67 147 Jean-Philippe Lang
You can also skip the installation of the database adapters you're not using. For example, if you're using MySQL, you can skip the installation of the postgresql and sqlite gems using @`bundle install --without development test postgresql sqlite`@.
68
69 150 Mischa The Evil
If you need to load any gems that are not required by Redmine core (eg. mongrel, fcgi), create a file named @Gemfile.local@ at the root of your redmine directory. It will be loaded automatically when running `bundle install`. Example:
70 149 Jean-Philippe Lang
71
<pre>
72
# Gemfile.local
73
gem "mongrel"
74
</pre>
75 147 Jean-Philippe Lang
76
3. Create an empty database and accompanying user named @redmine@ for example.
77
78 1 Jean-Philippe Lang
For MySQL:
79
80 38 Yclept Nemo
<pre>
81 39 Yclept Nemo
create database redmine character set utf8;
82
create user 'redmine'@'localhost' identified by 'my_password';
83
grant all privileges on redmine.* to 'redmine'@'localhost';
84 38 Yclept Nemo
</pre>
85 1 Jean-Philippe Lang
86 88 Sean Farrell
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
87
<pre>
88
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
89 1 Jean-Philippe Lang
</pre>
90
91
For PostgreSQL:
92
93
<pre>
94
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
95
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
96
</pre>
97
98 147 Jean-Philippe Lang
4. Copy @config/database.yml.example@ to @config/database.yml@ and edit this file in order to configure your database settings for "production" environment.
99 1 Jean-Philippe Lang
100 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.8 or jruby:
101 88 Sean Farrell
102 63 Thanos Kyritsis
<pre>
103
production:
104
  adapter: mysql
105
  database: redmine
106 64 Thanos Kyritsis
  host: localhost
107 63 Thanos Kyritsis
  username: redmine
108 3 Jean-Philippe Lang
  password: my_password
109 1 Jean-Philippe Lang
</pre>
110 14 Jean-Philippe Lang
111 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.9 (adapter must be set to @mysql2@):
112
113
<pre>
114
production:
115
  adapter: mysql2
116
  database: redmine
117
  host: localhost
118
  username: redmine
119
  password: my_password
120
</pre>
121
122 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
123
124
<pre>
125 1 Jean-Philippe Lang
production:
126 54 Barbara Post
  adapter: mysql
127
  database: redmine
128 1 Jean-Philippe Lang
  host: localhost
129 54 Barbara Post
  port: 3307
130
  username: redmine
131
  password: my_password
132
</pre>
133
134 44 Alexey Lustin
135
Example for a PostgreSQL database (default port):
136
137
<pre>
138
production:
139
  adapter: postgresql
140
  database: <your_database_name>
141 46 Istvan DEMETER
  host: <postgres_host>
142 1 Jean-Philippe Lang
  username: <postgres_user>
143
  password: <postgres_user_password>
144
  encoding: utf8
145
  schema_search_path: <database_schema> (default - public)
146
</pre>
147
148
5. Generate a session store secret.
149
150 151 Jean-Philippe Lang
* with Redmine 1.4.x:
151 1 Jean-Philippe Lang
152 151 Jean-Philippe Lang
<pre>
153
rake generate_session_store
154
</pre>
155
156
* with Redmine 2.x:
157
158
<pre>
159
rake generate_secret_token
160
</pre>
161
162 147 Jean-Philippe Lang
6. Create the database structure, by running the following command under the application root directory:
163 1 Jean-Philippe Lang
164 90 Jiongliang Zhang
  RAILS_ENV=production rake db:migrate
165 1 Jean-Philippe Lang
166 90 Jiongliang Zhang
167
It will create tables and an administrator account.
168
169
If you get this error: 
170 1 Jean-Philippe Lang
<pre>
171 90 Jiongliang Zhang
Rake aborted!
172
no such file to load -- net/https
173
</pre>
174 114 Etienne Massip
175 1 Jean-Philippe Lang
you need to install libopenssl-ruby1.8, in Ubuntu, just like this: apt-get install libopenssl-ruby1.8
176 41 Yclept Nemo
177 147 Jean-Philippe Lang
7. Insert default configuration data in database, by running the following command:
178 1 Jean-Philippe Lang
179 62 Vladimir L
  RAILS_ENV=production rake redmine:load_default_data
180 32 Jean-Philippe Lang
181
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.
182
183 147 Jean-Philippe Lang
8. Setting up permissions
184 32 Jean-Philippe Lang
185 14 Jean-Philippe Lang
NB: _Windows users have to skip this section._
186
187
The user who runs Redmine must have write permission on the following subdirectories: @files@, @log@, @tmp@ (create the last one if not present).
188
189 1 Jean-Philippe Lang
Assuming you run Redmine with a @redmine@ user:
190
191
<pre>
192
mkdir tmp public/plugin_assets
193
sudo chown -R redmine:redmine files log tmp public/plugin_assets
194
sudo chmod -R 755 files log tmp public/plugin_assets
195
</pre>
196
197
9. Test the installation by running WEBrick web server:
198
199 151 Jean-Philippe Lang
* with Redmine 1.4.x:
200
201
<pre>
202
ruby script/server webrick -e production
203
</pre>
204
205
* with Redmine 2.x:
206
207
<pre>
208
ruby script/rails server webrick -e production
209
</pre>
210 1 Jean-Philippe Lang
211 14 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
212 1 Jean-Philippe Lang
213 103 Muntek Singh
> Note: Webrick is *not* suitable for normal use, please only use webrick for testing that the installation up to this point is functional. It is not recommended to use webrick for anything other than development. Use one of the many other guides in this wiki to setup redmine to use either passenger (aka mod_rails) or mongrel to serve up your redmine. 
214
215 147 Jean-Philippe Lang
10. Use default administrator account to log in:
216 1 Jean-Philippe Lang
217
    * login: admin
218 14 Jean-Philippe Lang
    * password: admin
219 1 Jean-Philippe Lang
220
You can go to @Admin & Settings@ to modify application settings.
221
222 130 Etienne Massip
h2. Configuration
223 1 Jean-Philippe Lang
224 131 Etienne Massip
Since of version:1.2.0, Redmine settings are defined in a file named @config/configuration.yml@.
225 130 Etienne Massip
226 133 Etienne Massip
If you need to override default application settings, simply copy @config/configuration.yml.example@ to @config/configuration.yml@ then edit the new file; the file is well commented by itself, so you should have a look at it.
227 1 Jean-Philippe Lang
228 131 Etienne Massip
This settings may be defined per Rails environment (@production@/@development@/@test@).
229
230
+Important+ : don't forget to restart the application after any change.
231
232 130 Etienne Massip
h3. Email / SMTP server settings
233
234 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
235 1 Jean-Philippe Lang
236
h3. SCM settings
237
238 133 Etienne Massip
This configuration section allows you to:
239 131 Etienne Massip
* override default commands names if the SCM binaries present in the @PATH@ variable doesn't use the standard name (Windows .bat/.cmd names won't work)
240
* specify the full path to the binary
241
242 133 Etienne Massip
Examples (with Subversion):
243 131 Etienne Massip
244 133 Etienne Massip
Command name override:
245 131 Etienne Massip
246
 scm_subversion_command: "svn_replacement.exe"
247
248 133 Etienne Massip
Absolute path:
249 1 Jean-Philippe Lang
250
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
251
252
h3. Attachment storage settings
253
254 133 Etienne Massip
You can set a path where Redmine attachments will be stored which is different from the default 'files' directory of your Redmine instance using the @attachments_storage_path@ setting.
255
256
Examples:
257
258
 attachments_storage_path: /var/redmine/files
259
260
 attachments_storage_path: D:/redmine/files
261 130 Etienne Massip
262
h2. Logging configuration
263
264 101 T. Hauptman
Redmine defaults to a log level of :info, writing to the @log@ subdirectory. Depending on site usage, this can be a lot of data so to avoid the contents of the logfile growing without bound, consider rotating them, either through a system utility like @logrotate@ or via the @config/additional_environment.rb@ file.
265 21 Jean-Philippe Lang
266
To use the latter, copy @config/additional_environment.rb.example@ to @config/additional_environment.rb@ and add the following lines. Note that the new logger defaults to a high log level and hence has to be explicitly set to @info@.
267 123 Jean-Philippe Lang
<pre><code class="ruby">
268 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
269 95 Mischa The Evil
config.logger = Logger.new(config.log_path, 2, 1000000)
270 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
271
</code></pre>
272
273
h2. Backups
274
275
Redmine backups should include:
276
* data (stored in your redmine database)
277
* attachments (stored in the @files@ directory of your Redmine install)
278
279
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
280
281
<pre>
282
# Database
283 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
284 11 Jean-Philippe Lang
285
# Attachments
286 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
287
</pre>
288 69 Giuliano Simoncelli
289
h2. Notes on Windows installation
290
291
Get and install rubyinstaller from http://rubyforge.org. Form start menu select _Start Command Prompt with Ruby_
292
293
In the prompt follow the instruction given before
294
295
The commands:
296
297
<pre>
298
RAILS_ENV=production rake db:migrate
299
RAILS_ENV=production rake redmine:load_default_data
300
</pre>
301
302
has to be changed in 
303
304
<pre>
305
set RAILS_ENV=production
306
rake db:migrate
307 71 Giuliano Simoncelli
rake redmine:load_default_data
308 69 Giuliano Simoncelli
</pre>  
309
310 70 Giuliano Simoncelli
You may need to install install the mysql gem, with the command
311 69 Giuliano Simoncelli
312
<pre>
313
gem install mysql
314 1 Jean-Philippe Lang
</pre>
315
316
And in some case is required to copy the libmysql.dll file in your ruby/bin directory.
317
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll
318 80 Jean-Philippe Lang
319
h2. Alternative to manual installation
320
321
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.