Project

General

Profile

RedmineInstall » History » Version 166

Etienne Massip, 2012-10-23 11:15

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 161 Etienne Massip
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|Mac]], [[RedmineInstallOSXServer|Mac Server]] and [[RedmineInstall#Notes-on-Windows-installation|Windows]] systems as long as Ruby is available on this platform.  See specific installation HowTos [[HowTos|here]].
12 25 Jean-Philippe Lang
13 163 Etienne Massip
h3. Ruby interpreter
14 25 Jean-Philippe Lang
15 163 Etienne Massip
The required Ruby versions for a given Redmine version is:
16 1 Jean-Philippe Lang
17 163 Etienne Massip
|_. Redmine version|_. Supported Ruby versions|_. Rails version used|_. Supported RubyGems versions|
18 159 Jean-Philippe Lang
|current trunk|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.8|RubyGems <= 1.8|
19 160 Jean-Philippe Lang
|2.1.0|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.8|RubyGems <= 1.8|
20 155 Jean-Philippe Lang
|2.0.3|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.6|RubyGems <= 1.8|
21 153 Jean-Philippe Lang
|2.0.2|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.5|RubyGems <= 1.8|
22
|2.0.0, 2.0.1|ruby 1.8.7, 1.9.2, 1.9.3, jruby-1.6.7|Rails 3.2.3|RubyGems <= 1.8|
23 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|
24 1 Jean-Philippe Lang
25 164 Etienne Massip
h3. Supported database back-ends
26 92 Knight Samar
27 146 Etienne Massip
* MySQL 5.0 or higher (recommended)
28 35 Jean-Philippe Lang
29
 * 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
30 1 Jean-Philippe Lang
31 154 Etienne Massip
* PostgreSQL 8 or higher (8.2 or higher starting from Redmine version:2.0.0)
32 117 Etienne Massip
33 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";@
34 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
35 1 Jean-Philippe Lang
36
* SQLite 3
37
38
h3. Optional components
39
40
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
41
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
42
      * "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.
43
44
h2. Redmine Version
45
46
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.
47
48 114 Etienne Massip
h2. Installation procedure
49 35 Jean-Philippe Lang
50 165 Etienne Massip
h3. Step 1 - Redmine application
51 26 Jean-Philippe Lang
52 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
53 1 Jean-Philippe Lang
54 165 Etienne Massip
See the [[Download|download page]].
55
56
h3. Step 2 - Dependencies installation
57
58
Since version:1.4.0, Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
59
60
You need to install Bundler first:
61
62 147 Jean-Philippe Lang
  gem install bundler
63
64
Then you can install all the gems required by Redmine using the following command:
65
66
  bundle install --without development test
67
68
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using: @`bundle install --without development test rmagick`@.
69
70 152 Etienne Massip
Sidenote concerning the installation of @rmagick@ on Windows:
71
72
>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]] .
73 147 Jean-Philippe Lang
74 158 Etienne Massip
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`@.
75 149 Jean-Philippe Lang
76
If you need to load any gems that are not required by Redmine core (eg. puma, fcgi), create a file named @Gemfile.local@ at the root of your redmine directory. It will be loaded automatically when running `bundle install`. Example:
77
78 158 Etienne Massip
<pre>
79 149 Jean-Philippe Lang
# Gemfile.local
80 1 Jean-Philippe Lang
gem 'puma'
81
</pre>
82 147 Jean-Philippe Lang
83 165 Etienne Massip
h3. Step 3 - Create an empty database and accompanying user
84 1 Jean-Philippe Lang
85 165 Etienne Massip
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
86 1 Jean-Philippe Lang
87 166 Etienne Massip
h4. MySQL
88 165 Etienne Massip
89 39 Yclept Nemo
<pre>
90
create database redmine character set utf8;
91
create user 'redmine'@'localhost' identified by 'my_password';
92 1 Jean-Philippe Lang
grant all privileges on redmine.* to 'redmine'@'localhost';
93 88 Sean Farrell
</pre>
94
95 1 Jean-Philippe Lang
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
96 88 Sean Farrell
<pre>
97 1 Jean-Philippe Lang
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
98
</pre>
99
100 166 Etienne Massip
h4. PostgreSQL
101 1 Jean-Philippe Lang
102
<pre>
103
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
104
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
105
</pre>
106 166 Etienne Massip
107 1 Jean-Philippe Lang
108 165 Etienne Massip
h3. Step 4 - Configuration
109 1 Jean-Philippe Lang
110 165 Etienne Massip
Copy @config/database.yml.example@ to @config/database.yml@ and edit this file in order to configure your database settings for "production" environment.
111
112 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.8 or jruby:
113 88 Sean Farrell
114 63 Thanos Kyritsis
<pre>
115
production:
116
  adapter: mysql
117
  database: redmine
118 64 Thanos Kyritsis
  host: localhost
119 63 Thanos Kyritsis
  username: redmine
120 3 Jean-Philippe Lang
  password: my_password
121 1 Jean-Philippe Lang
</pre>
122 14 Jean-Philippe Lang
123 147 Jean-Philippe Lang
Example for a MySQL database using ruby1.9 (adapter must be set to @mysql2@):
124
125
<pre>
126
production:
127
  adapter: mysql2
128
  database: redmine
129
  host: localhost
130
  username: redmine
131
  password: my_password
132
</pre>
133
134 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
135
136
<pre>
137 1 Jean-Philippe Lang
production:
138 54 Barbara Post
  adapter: mysql
139
  database: redmine
140 1 Jean-Philippe Lang
  host: localhost
141 54 Barbara Post
  port: 3307
142
  username: redmine
143
  password: my_password
144
</pre>
145 44 Alexey Lustin
146
147
Example for a PostgreSQL database (default port):
148
149
<pre>
150
production:
151
  adapter: postgresql
152 46 Istvan DEMETER
  database: <your_database_name>
153 1 Jean-Philippe Lang
  host: <postgres_host>
154
  username: <postgres_user>
155
  password: <postgres_user_password>
156
  encoding: utf8
157
  schema_search_path: <database_schema> (default - public)
158
</pre>
159
160 165 Etienne Massip
h3. Step 5 - Session store secret generation
161 1 Jean-Philippe Lang
162 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
163
Generating a new secret token invalidates all existing sessions after restart.
164
165 151 Jean-Philippe Lang
* with Redmine 1.4.x:
166
167
<pre>
168
rake generate_session_store
169 1 Jean-Philippe Lang
</pre>
170 151 Jean-Philippe Lang
171 1 Jean-Philippe Lang
* with Redmine 2.x:
172
173 151 Jean-Philippe Lang
<pre>
174 1 Jean-Philippe Lang
rake generate_secret_token
175
</pre>
176 90 Jiongliang Zhang
177 165 Etienne Massip
h3. Step 6 - Database schema objects creation
178 90 Jiongliang Zhang
179 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
180
181 1 Jean-Philippe Lang
  RAILS_ENV=production rake db:migrate
182
183
184 90 Jiongliang Zhang
It will create tables and an administrator account.
185 1 Jean-Philippe Lang
186 165 Etienne Massip
If you get this error with Ubuntu:
187 90 Jiongliang Zhang
<pre>
188 114 Etienne Massip
Rake aborted!
189 1 Jean-Philippe Lang
no such file to load -- net/https
190
</pre>
191
192 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
193 1 Jean-Philippe Lang
194 165 Etienne Massip
h3. Step 7 - Database default data set
195 1 Jean-Philippe Lang
196 165 Etienne Massip
Insert default configuration data in database, by running the following command:
197
198 1 Jean-Philippe Lang
  RAILS_ENV=production rake redmine:load_default_data
199 62 Vladimir L
200 32 Jean-Philippe Lang
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.
201
202 165 Etienne Massip
h3. Step 8 - Setting up permissions
203 32 Jean-Philippe Lang
204 165 Etienne Massip
NB: _Windows users can skip this section._
205 14 Jean-Philippe Lang
206 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
207 1 Jean-Philippe Lang
208 165 Etienne Massip
# @files@ (storage of attachments)
209
# @log@ (application log file @production.log@)
210
# @tmp@ (create the last one if not present, used to generate PDFs document among other things)
211 1 Jean-Philippe Lang
212 165 Etienne Massip
E.g., assuming you run the application with a @redmine@ user account:
213
214 1 Jean-Philippe Lang
<pre>
215
mkdir tmp public/plugin_assets
216
sudo chown -R redmine:redmine files log tmp public/plugin_assets
217
sudo chmod -R 755 files log tmp public/plugin_assets
218
</pre>
219
220 165 Etienne Massip
h3. Step 9 - Test the installation
221 1 Jean-Philippe Lang
222 165 Etienne Massip
Test the installation by running WEBrick web server:
223
224 1 Jean-Philippe Lang
* with Redmine 1.4.x:
225
226 151 Jean-Philippe Lang
<pre>
227
ruby script/server webrick -e production
228 1 Jean-Philippe Lang
</pre>
229
230 151 Jean-Philippe Lang
* with Redmine 2.x:
231
232
<pre>
233
ruby script/rails server webrick -e production
234
</pre>
235
236
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
237
238 165 Etienne Massip
> Note: Webrick is *not* suitable for production use, please only use webrick for testing that the installation up to this point is functional. Use one of the many other guides in this wiki to setup redmine to use either Passenger (aka @mod_rails@), FCGI or a Rack server (Unicorn, Thin, Puma, hellip;) to serve up your redmine.
239 14 Jean-Philippe Lang
240 165 Etienne Massip
h3. Step 10 - Logging into the application
241 158 Etienne Massip
242 165 Etienne Massip
Use default administrator account to log in:
243
244 1 Jean-Philippe Lang
    * login: admin
245
    * password: admin
246 14 Jean-Philippe Lang
247 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
248
249 1 Jean-Philippe Lang
250 130 Etienne Massip
h2. Configuration
251 1 Jean-Philippe Lang
252 131 Etienne Massip
Since of version:1.2.0, Redmine settings are defined in a file named @config/configuration.yml@.
253 130 Etienne Massip
254 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.
255 1 Jean-Philippe Lang
256 131 Etienne Massip
This settings may be defined per Rails environment (@production@/@development@/@test@).
257
258
+Important+ : don't forget to restart the application after any change.
259
260 130 Etienne Massip
h3. Email / SMTP server settings
261
262 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
263 1 Jean-Philippe Lang
264
h3. SCM settings
265
266 133 Etienne Massip
This configuration section allows you to:
267 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)
268
* specify the full path to the binary
269
270 133 Etienne Massip
Examples (with Subversion):
271 131 Etienne Massip
272 133 Etienne Massip
Command name override:
273 131 Etienne Massip
274
 scm_subversion_command: "svn_replacement.exe"
275
276 133 Etienne Massip
Absolute path:
277 1 Jean-Philippe Lang
278
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
279
280
h3. Attachment storage settings
281
282 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.
283
284
Examples:
285
286
 attachments_storage_path: /var/redmine/files
287
288
 attachments_storage_path: D:/redmine/files
289 130 Etienne Massip
290
h2. Logging configuration
291
292 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.
293 21 Jean-Philippe Lang
294
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@.
295 123 Jean-Philippe Lang
<pre><code class="ruby">
296 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
297 162 Jean-Philippe Lang
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
298 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
299
</code></pre>
300
301
h2. Backups
302
303
Redmine backups should include:
304
* data (stored in your redmine database)
305
* attachments (stored in the @files@ directory of your Redmine install)
306
307
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
308
309
<pre>
310
# Database
311 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
312 11 Jean-Philippe Lang
313
# Attachments
314 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
315
</pre>
316 69 Giuliano Simoncelli
317
h2. Notes on Windows installation
318
319 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
320
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
321 1 Jean-Philippe Lang
322 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
323 69 Giuliano Simoncelli
324 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
325 1 Jean-Philippe Lang
326 156 Etienne Massip
I.e. commands with the following syntaxes:
327 69 Giuliano Simoncelli
328 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
329 69 Giuliano Simoncelli
330 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
331 1 Jean-Philippe Lang
332 156 Etienne Massip
have to be turned into 2 subsequent commands:
333 69 Giuliano Simoncelli
334 156 Etienne Massip
<pre>set RAILS_ENV=production
335
<any commmand></pre>
336
337
+MySQL gem installation issue:+
338
339
You may need to manually install the mysql gem using the following command:
340
341 69 Giuliano Simoncelli
<pre>
342
gem install mysql
343
</pre>
344 1 Jean-Philippe Lang
345 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
346
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll.
347
348 80 Jean-Philippe Lang
349
h2. Alternative to manual installation
350
351
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.