Project

General

Profile

RedmineInstall » History » Version 158

Etienne Massip, 2012-09-03 11:15
Replaced mongrel with Puma (mongrel is no more usable with Rails 3.x)

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