Project

General

Profile

RedmineInstall » History » Version 163

Etienne Massip, 2012-10-23 10:42
Rails is part of the bundle dependencies.

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