RedmineInstall » History » Version 293

Go MAEDA, 2018-08-27 10:25
Updated supported Ruby versions

1 1 Jean-Philippe Lang
h1. Installing Redmine
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
{{>TOC}}
4 73 Liraz Siri
5 270 Go MAEDA
This is the installation documentation for Redmine 3.0 and higher. You can still read the document for older versions: "1.4.x - 2.6.x":/projects/redmine/wiki/RedmineInstall/263, "1.3.x":/projects/redmine/wiki/RedmineInstall?version=146
6 147 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. Requirements
8 1 Jean-Philippe Lang
9 25 Jean-Philippe Lang
h3. Operating system
10 1 Jean-Philippe Lang
11 266 Go MAEDA
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|macOS]], [[RedmineInstallOSXServer|macOS 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 241 Toshi MARUYAMA
|_. Redmine version|_. Supported Ruby versions                                |_. Rails version used|
18 293 Go MAEDA
|4.0 (upcoming)    |ruby 2.2(2.2.2 and later), 2.3, 2.4[1], 2.5               |Rails 5.2            |
19 273 Toshi MARUYAMA
|3.4               |ruby 1.9.3[4], 2.0.0[3], 2.1, 2.2[2], 2.3, 2.4[1]         |Rails 4.2            |
20 268 Go MAEDA
|3.3               |ruby 1.9.3[4], 2.0.0[3], 2.1, 2.2[2], 2.3                 |Rails 4.2            |
21 268 Go MAEDA
|3.2               |ruby 1.9.3[4], 2.0.0[3], 2.1, 2.2[2]                      |Rails 4.2            |
22 1 Jean-Philippe Lang
23 293 Go MAEDA
%{color: red}Support for Ruby 2.2 and earlier have ended by Ruby community.%
24 260 Toshi MARUYAMA
https://www.ruby-lang.org/en/news/2015/02/23/support-for-ruby-1-9-3-has-ended/
25 1 Jean-Philippe Lang
https://www.ruby-lang.org/en/news/2016/02/24/support-plan-of-ruby-2-0-0-and-2-1/
26 1 Jean-Philippe Lang
https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/
27 293 Go MAEDA
https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/
28 260 Toshi MARUYAMA
29 256 Toshi MARUYAMA
*Redmine 3.2 or lower does not support Ruby 2.3*. Redmine 3.3 supports Ruby 2.3.
30 255 Toshi MARUYAMA
31 247 Toshi MARUYAMA
*Redmine does not support JRuby* because some gems do not support Rails 4.2.
32 1 Jean-Philippe Lang
** "activerecord-jdbc-adapter":https://github.com/jruby/activerecord-jdbc-adapter/issues/599
33 1 Jean-Philippe Lang
** "loofah":https://github.com/flavorjones/loofah/issues/88
34 1 Jean-Philippe Lang
35 265 Go MAEDA
fn1. Ruby 2.4 is supported by r16355 and later.
36 1 Jean-Philippe Lang
37 265 Go MAEDA
fn2. MinGW Ruby 2.2 had Nokogiri issue (#19419) and it was fixed by "Nokogiri 1.6.7":https://github.com/sparklemotion/nokogiri/issues/1256#issuecomment-160514102 (2015-11-30).
38 237 Toshi MARUYAMA
39 265 Go MAEDA
fn3. At time of writing (3/19/2013), SQL Server support is reported broken with *ruby 2.0.0 under Windows* because of a "database adapter gem incompatibility":https://github.com/rails-sqlserver/tiny_tds/issues/110
40 265 Go MAEDA
41 265 Go MAEDA
fn4. MRI 1.9.3p327 contains "a bug":http://bugs.ruby-lang.org/issues/7374 breaking plugin loading under Windows which 1.9.3p194 or 1.9.3p392 haven't.
42 212 Etienne Massip
43 164 Etienne Massip
h3. Supported database back-ends
44 92 Knight Samar
45 262 Toshi MARUYAMA
* MySQL 5.0 - 5.5
46 35 Jean-Philippe Lang
47 287 Toshi MARUYAMA
 * *MySQL 5.6 or higher* and *MariaDB* have known issues (#19344, #19395, #17460).
48 291 Go MAEDA
 * Redmine 4.0.0 does not support MySQL <5.5 (#28504).
49 1 Jean-Philippe Lang
50 289 Go MAEDA
* PostgreSQL 8.3 or higher
51 117 Etienne Massip
52 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";@
53 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
54 292 Go MAEDA
 * Redmine 4.0.0 does not support PostgreSQL <9.2 (#28505).
55 1 Jean-Philippe Lang
56 270 Go MAEDA
* Microsoft SQL Server "2012 or higher":https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/v4.2.3/README.md#activerecord-sql-server-adapter-for-sql-server-2012-and-higher
57 192 Etienne Massip
58 192 Etienne Massip
* SQLite 3 (not for multi-user production use!)
59 190 Etienne Massip
60 1 Jean-Philippe Lang
h3. Optional components
61 1 Jean-Philippe Lang
62 1 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
63 215 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to PNG image and thumbnails generation).
64 1 Jean-Philippe Lang
65 1 Jean-Philippe Lang
h2. Redmine Version
66 1 Jean-Philippe Lang
67 1 Jean-Philippe Lang
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.
68 1 Jean-Philippe Lang
69 114 Etienne Massip
h2. Installation procedure
70 35 Jean-Philippe Lang
71 165 Etienne Massip
h3. Step 1 - Redmine application
72 26 Jean-Philippe Lang
73 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
74 1 Jean-Philippe Lang
75 174 Etienne Massip
See the [[Download|download page]] for details.
76 165 Etienne Massip
77 202 Jean-Philippe Lang
h3. Step 2 - Create an empty database and accompanying user
78 165 Etienne Massip
79 1 Jean-Philippe Lang
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
80 165 Etienne Massip
81 1 Jean-Philippe Lang
h4. MySQL
82 166 Etienne Massip
83 1 Jean-Philippe Lang
<pre><code class="sql">
84 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8mb4;
85 287 Toshi MARUYAMA
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
86 287 Toshi MARUYAMA
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
87 287 Toshi MARUYAMA
</code></pre>
88 287 Toshi MARUYAMA
89 287 Toshi MARUYAMA
For versions of MySQL "5.5.2":https://dev.mysql.com/doc/relnotes/mysql/5.5/en/news-5-5-3.html or lower - use *utf8* instead of "utf8mb4":https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
90 287 Toshi MARUYAMA
91 287 Toshi MARUYAMA
<pre><code class="sql">
92 208 Etienne Massip
CREATE DATABASE redmine CHARACTER SET utf8;
93 208 Etienne Massip
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
94 1 Jean-Philippe Lang
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
95 1 Jean-Philippe Lang
</code></pre>
96 281 Go MAEDA
97 287 Toshi MARUYAMA
For versions of MySQL "5.0.2":https://docs.oracle.com/cd/E17952_01/mysql-5.0-en/grant.html or lower - skip the 'CREATE USER' step and instead:
98 208 Etienne Massip
<pre><code class="sql">
99 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8;
100 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
101 208 Etienne Massip
</code></pre>
102 1 Jean-Philippe Lang
103 1 Jean-Philippe Lang
h4. PostgreSQL
104 166 Etienne Massip
105 205 Etienne Massip
<pre><code class="sql">
106 1 Jean-Philippe Lang
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
107 1 Jean-Philippe Lang
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
108 205 Etienne Massip
</code></pre>
109 205 Etienne Massip
110 205 Etienne Massip
h4. SQL Server
111 205 Etienne Massip
112 205 Etienne Massip
The database, login and user can be created within ??SQL Server Management Studio?? with a few clicks.
113 205 Etienne Massip
114 205 Etienne Massip
If you prefer the command line option with @SQLCMD@, here's some basic example:
115 206 Etienne Massip
116 206 Etienne Massip
{{collapse(Show SQL,Hide SQL)
117 205 Etienne Massip
<pre><code class="sql">
118 205 Etienne Massip
USE [master]
119 205 Etienne Massip
GO
120 205 Etienne Massip
121 205 Etienne Massip
-- Very basic DB creation
122 205 Etienne Massip
CREATE DATABASE [REDMINE]
123 1 Jean-Philippe Lang
GO
124 1 Jean-Philippe Lang
125 206 Etienne Massip
-- Creation of a login with SQL Server login/password authentication and no password expiration policy
126 206 Etienne Massip
CREATE LOGIN [REDMINE] WITH PASSWORD=N'redminepassword', DEFAULT_DATABASE=[REDMINE], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF
127 205 Etienne Massip
GO
128 205 Etienne Massip
129 205 Etienne Massip
-- User creation using previously created login authentication
130 205 Etienne Massip
USE [REDMINE]
131 205 Etienne Massip
GO
132 205 Etienne Massip
CREATE USER [REDMINE] FOR LOGIN [REDMINE]
133 205 Etienne Massip
GO
134 205 Etienne Massip
-- User permissions set via roles
135 207 Etienne Massip
EXEC sp_addrolemember N'db_datareader', N'REDMINE'
136 205 Etienne Massip
GO
137 207 Etienne Massip
EXEC sp_addrolemember N'db_datawriter', N'REDMINE'
138 1 Jean-Philippe Lang
GO
139 205 Etienne Massip
</code></pre>
140 206 Etienne Massip
}}
141 166 Etienne Massip
142 202 Jean-Philippe Lang
h3. Step 3 - Database connection configuration
143 1 Jean-Philippe Lang
144 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.
145 165 Etienne Massip
146 264 Go MAEDA
Example for a MySQL database (default port):
147 88 Sean Farrell
148 209 Etienne Massip
<pre><code class="yml">
149 1 Jean-Philippe Lang
production:
150 1 Jean-Philippe Lang
  adapter: mysql2
151 1 Jean-Philippe Lang
  database: redmine
152 1 Jean-Philippe Lang
  host: localhost
153 1 Jean-Philippe Lang
  username: redmine
154 1 Jean-Philippe Lang
  password: my_password
155 1 Jean-Philippe Lang
</code></pre>
156 209 Etienne Massip
157 1 Jean-Philippe Lang
If your server is not running on the standard port (3306), use this configuration instead:
158 1 Jean-Philippe Lang
159 1 Jean-Philippe Lang
<pre><code class="yml">
160 1 Jean-Philippe Lang
production:
161 264 Go MAEDA
  adapter: mysql2
162 1 Jean-Philippe Lang
  database: redmine
163 1 Jean-Philippe Lang
  host: localhost
164 1 Jean-Philippe Lang
  port: 3307
165 1 Jean-Philippe Lang
  username: redmine
166 1 Jean-Philippe Lang
  password: my_password
167 209 Etienne Massip
</code></pre>
168 1 Jean-Philippe Lang
169 1 Jean-Philippe Lang
Example for a PostgreSQL database (default port):
170 1 Jean-Philippe Lang
171 209 Etienne Massip
<pre><code class="yml">
172 1 Jean-Philippe Lang
production:
173 1 Jean-Philippe Lang
  adapter: postgresql
174 1 Jean-Philippe Lang
  database: <your_database_name>
175 1 Jean-Philippe Lang
  host: <postgres_host>
176 1 Jean-Philippe Lang
  username: <postgres_user>
177 1 Jean-Philippe Lang
  password: <postgres_user_password>
178 1 Jean-Philippe Lang
  encoding: utf8
179 1 Jean-Philippe Lang
  schema_search_path: <database_schema> (default - public)
180 209 Etienne Massip
</code></pre>
181 1 Jean-Philippe Lang
182 209 Etienne Massip
Example for a SQL Server database (default host @localhost@, default port @1433@):
183 209 Etienne Massip
<pre><code class="yml">
184 209 Etienne Massip
production:
185 209 Etienne Massip
  adapter: sqlserver
186 209 Etienne Massip
  database: redmine
187 209 Etienne Massip
  username: redmine # should match the database user name
188 209 Etienne Massip
  password: redminepassword # should match the login password
189 209 Etienne Massip
</code></pre>
190 202 Jean-Philippe Lang
191 202 Jean-Philippe Lang
h3. Step 4 - Dependencies installation
192 202 Jean-Philippe Lang
193 202 Jean-Philippe Lang
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
194 202 Jean-Philippe Lang
195 202 Jean-Philippe Lang
You need to install Bundler first:
196 202 Jean-Philippe Lang
197 202 Jean-Philippe Lang
  gem install bundler
198 202 Jean-Philippe Lang
199 202 Jean-Philippe Lang
Then you can install all the gems required by Redmine using the following command:
200 202 Jean-Philippe Lang
201 202 Jean-Philippe Lang
  bundle install --without development test
202 202 Jean-Philippe Lang
203 202 Jean-Philippe Lang
h4. Optional dependencies
204 202 Jean-Philippe Lang
205 202 Jean-Philippe Lang
h5. RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
206 202 Jean-Philippe Lang
207 202 Jean-Philippe Lang
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
208 202 Jean-Philippe Lang
209 202 Jean-Philippe Lang
 @bundle install --without development test rmagick@
210 202 Jean-Philippe Lang
211 202 Jean-Philippe Lang
212 202 Jean-Philippe Lang
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
213 202 Jean-Philippe Lang
214 202 Jean-Philippe Lang
h5. Database adapters
215 202 Jean-Philippe Lang
216 214 Etienne Massip
Redmine automatically installs the adapter gems required by your database configuration by reading it from the @config/database.yml@ file (eg. if you configured only a connection using the @mysql2@ adapter, then only the @mysql2@ gem will be installed).
217 214 Etienne Massip
218 214 Etienne Massip
Don't forget to re-run @bundle install --without development test ...@ after adding or removing adapters in the @config/database.yml@ file!
219 202 Jean-Philippe Lang
220 202 Jean-Philippe Lang
h4. Additional dependencies (@Gemfile.local@)
221 202 Jean-Philippe Lang
222 202 Jean-Philippe Lang
If you need to load 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@.
223 202 Jean-Philippe Lang
224 202 Jean-Philippe Lang
Example:
225 202 Jean-Philippe Lang
<pre>
226 202 Jean-Philippe Lang
# Gemfile.local
227 202 Jean-Philippe Lang
gem 'puma'
228 1 Jean-Philippe Lang
</pre>
229 1 Jean-Philippe Lang
230 165 Etienne Massip
h3. Step 5 - Session store secret generation
231 1 Jean-Philippe Lang
232 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
233 151 Jean-Philippe Lang
Generating a new secret token invalidates all existing sessions after restart.
234 1 Jean-Philippe Lang
235 151 Jean-Philippe Lang
<pre>
236 234 Go MAEDA
bundle exec rake generate_secret_token
237 1 Jean-Philippe Lang
</pre>
238 90 Jiongliang Zhang
239 243 Toshi MARUYAMA
Alternatively, you can store this secret in config/secrets.yml:
240 243 Toshi MARUYAMA
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
241 243 Toshi MARUYAMA
242 165 Etienne Massip
h3. Step 6 - Database schema objects creation
243 90 Jiongliang Zhang
244 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
245 165 Etienne Massip
246 271 Toshi MARUYAMA
<pre>
247 278 Toshi MARUYAMA
RAILS_ENV=production bundle exec rake db:migrate
248 271 Toshi MARUYAMA
</pre>
249 271 Toshi MARUYAMA
250 271 Toshi MARUYAMA
*Windows syntax:*
251 271 Toshi MARUYAMA
252 271 Toshi MARUYAMA
<pre>
253 271 Toshi MARUYAMA
set RAILS_ENV=production
254 184 Etienne Massip
bundle exec rake db:migrate
255 271 Toshi MARUYAMA
</pre>
256 184 Etienne Massip
257 184 Etienne Massip
It will create tables by running all migrations one by one then create the set of the permissions and the application administrator account, named @admin@.
258 184 Etienne Massip
259 184 Etienne Massip
+Ubuntu troubleshooting:+
260 1 Jean-Philippe Lang
261 165 Etienne Massip
If you get this error with Ubuntu:
262 90 Jiongliang Zhang
<pre>
263 114 Etienne Massip
Rake aborted!
264 1 Jean-Philippe Lang
no such file to load -- net/https
265 1 Jean-Philippe Lang
</pre>
266 1 Jean-Philippe Lang
267 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
268 1 Jean-Philippe Lang
269 165 Etienne Massip
h3. Step 7 - Database default data set
270 1 Jean-Philippe Lang
271 165 Etienne Massip
Insert default configuration data in database, by running the following command:
272 165 Etienne Massip
273 234 Go MAEDA
  RAILS_ENV=production bundle exec rake redmine:load_default_data
274 62 Vladimir L
275 171 Etienne Massip
Redmine will prompt you for the data set language that should be loaded; you can also define the @REDMINE_LANG@ environment variable before running the command to a value which will be automatically and silently picked up by the task.
276 171 Etienne Massip
277 171 Etienne Massip
E.g.:
278 171 Etienne Massip
279 171 Etienne Massip
Unices:
280 171 Etienne Massip
281 234 Go MAEDA
  RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data
282 171 Etienne Massip
283 171 Etienne Massip
Windows:
284 171 Etienne Massip
<pre>
285 171 Etienne Massip
set RAILS_ENV=production
286 171 Etienne Massip
set REDMINE_LANG=fr
287 234 Go MAEDA
bundle exec rake redmine:load_default_data
288 171 Etienne Massip
</pre>
289 32 Jean-Philippe Lang
290 167 Etienne Massip
h3. Step 8 - File system permissions
291 32 Jean-Philippe Lang
292 165 Etienne Massip
NB: _Windows users can skip this section._
293 14 Jean-Philippe Lang
294 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
295 1 Jean-Philippe Lang
296 165 Etienne Massip
# @files@ (storage of attachments)
297 165 Etienne Massip
# @log@ (application log file @production.log@)
298 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
299 220 Jean-Baptiste Barth
# @public/plugin_assets@ (assets of plugins)
300 221 Jean-Baptiste Barth
301 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
302 165 Etienne Massip
303 1 Jean-Philippe Lang
<pre>
304 219 Jean-Baptiste Barth
mkdir -p tmp tmp/pdf public/plugin_assets
305 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
306 1 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
307 1 Jean-Philippe Lang
</pre>
308 1 Jean-Philippe Lang
309 284 Toshi MARUYAMA
Note: If you have files in these directories (e.g. restore files from backup), make sure these files are not executable.
310 284 Toshi MARUYAMA
311 284 Toshi MARUYAMA
<pre>
312 284 Toshi MARUYAMA
sudo find files log tmp public/plugin_assets -type f -exec chmod -x {} +
313 284 Toshi MARUYAMA
</pre>
314 284 Toshi MARUYAMA
315 165 Etienne Massip
h3. Step 9 - Test the installation
316 151 Jean-Philippe Lang
317 244 Jan Niggemann (redmine.org team member)
Test the installation by running WEBrick web server:
318 244 Jan Niggemann (redmine.org team member)
319 244 Jan Niggemann (redmine.org team member)
<pre>
320 244 Jan Niggemann (redmine.org team member)
bundle exec rails server webrick -e production
321 244 Jan Niggemann (redmine.org team member)
</pre>
322 244 Jan Niggemann (redmine.org team member)
323 151 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
324 151 Jean-Philippe Lang
325 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.
326 14 Jean-Philippe Lang
327 165 Etienne Massip
h3. Step 10 - Logging into the application
328 158 Etienne Massip
329 165 Etienne Massip
Use default administrator account to log in:
330 165 Etienne Massip
331 1 Jean-Philippe Lang
    * login: admin
332 1 Jean-Philippe Lang
    * password: admin
333 14 Jean-Philippe Lang
334 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
335 165 Etienne Massip
336 130 Etienne Massip
h2. Configuration
337 1 Jean-Philippe Lang
338 185 Etienne Massip
Redmine settings are defined in a file named @config/configuration.yml@.
339 1 Jean-Philippe Lang
340 185 Etienne Massip
If you need to override default application settings, simply copy @config/configuration.yml.example@ to @config/configuration.yml@ and edit the new file; the file is well commented by itself, so you should have a look at it.
341 1 Jean-Philippe Lang
342 185 Etienne Massip
These settings may be defined per Rails environment (@production@/@development@/@test@).
343 131 Etienne Massip
344 131 Etienne Massip
+Important+ : don't forget to restart the application after any change.
345 131 Etienne Massip
346 130 Etienne Massip
h3. Email / SMTP server settings
347 130 Etienne Massip
348 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
349 1 Jean-Philippe Lang
350 1 Jean-Philippe Lang
h3. SCM settings
351 1 Jean-Philippe Lang
352 133 Etienne Massip
This configuration section allows you to:
353 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)
354 131 Etienne Massip
* specify the full path to the binary
355 131 Etienne Massip
356 133 Etienne Massip
Examples (with Subversion):
357 131 Etienne Massip
358 133 Etienne Massip
Command name override:
359 131 Etienne Massip
360 131 Etienne Massip
 scm_subversion_command: "svn_replacement.exe"
361 131 Etienne Massip
362 133 Etienne Massip
Absolute path:
363 1 Jean-Philippe Lang
364 1 Jean-Philippe Lang
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
365 1 Jean-Philippe Lang
366 1 Jean-Philippe Lang
h3. Attachment storage settings
367 1 Jean-Philippe Lang
368 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.
369 133 Etienne Massip
370 133 Etienne Massip
Examples:
371 133 Etienne Massip
372 133 Etienne Massip
 attachments_storage_path: /var/redmine/files
373 133 Etienne Massip
374 133 Etienne Massip
 attachments_storage_path: D:/redmine/files
375 130 Etienne Massip
376 130 Etienne Massip
h2. Logging configuration
377 130 Etienne Massip
378 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.
379 21 Jean-Philippe Lang
380 21 Jean-Philippe Lang
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@.
381 123 Jean-Philippe Lang
<pre><code class="ruby">
382 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
383 162 Jean-Philippe Lang
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
384 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
385 11 Jean-Philippe Lang
</code></pre>
386 11 Jean-Philippe Lang
387 11 Jean-Philippe Lang
h2. Backups
388 11 Jean-Philippe Lang
389 11 Jean-Philippe Lang
Redmine backups should include:
390 11 Jean-Philippe Lang
* data (stored in your redmine database)
391 11 Jean-Philippe Lang
* attachments (stored in the @files@ directory of your Redmine install)
392 11 Jean-Philippe Lang
393 288 Go MAEDA
Please refer to [[RedmineBackupAndRestore|Backing up and restoring Redmine]] for more details.
394 69 Giuliano Simoncelli
395 216 Jean-Baptiste Barth
h2. Notes on Linux/Unix installation
396 216 Jean-Baptiste Barth
397 216 Jean-Baptiste Barth
Be sure to disable security hardenning tools during the installation process if you run into bizarre permission problems. These problems are mostly silent and can be caused by tools like extended ACLs, SELinux, or AppArmor. There tools are mostly used in big companies with a strict security policy, default Linux/Unix distributions settings shouldn't be a problem.
398 216 Jean-Baptiste Barth
399 69 Giuliano Simoncelli
h2. Notes on Windows installation
400 69 Giuliano Simoncelli
401 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
402 156 Etienne Massip
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
403 1 Jean-Philippe Lang
404 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
405 69 Giuliano Simoncelli
406 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
407 1 Jean-Philippe Lang
408 156 Etienne Massip
I.e. commands with the following syntaxes:
409 69 Giuliano Simoncelli
410 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
411 69 Giuliano Simoncelli
412 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
413 1 Jean-Philippe Lang
414 156 Etienne Massip
have to be turned into 2 subsequent commands:
415 69 Giuliano Simoncelli
416 156 Etienne Massip
<pre>set RAILS_ENV=production
417 156 Etienne Massip
<any commmand></pre>
418 156 Etienne Massip
419 156 Etienne Massip
+MySQL gem installation issue:+
420 156 Etienne Massip
421 156 Etienne Massip
You may need to manually install the mysql gem using the following command:
422 156 Etienne Massip
423 69 Giuliano Simoncelli
<pre>
424 69 Giuliano Simoncelli
gem install mysql
425 69 Giuliano Simoncelli
</pre>
426 1 Jean-Philippe Lang
427 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
428 156 Etienne Massip
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll.
429 156 Etienne Massip
430 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
431 283 Mischa The Evil
On Win7 and later, @localhost@ is commented out in the hosts file[5] and IPV6 is the default[6]. As the mysql2 gem does no support IPV6 addresses[7], a connection can't be established and you get the error "@Can't connect to MySQL server on 'localhost' (10061)@".
432 186 Jan Niggemann (redmine.org team member)
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
433 186 Jan Niggemann (redmine.org team member)
434 186 Jan Niggemann (redmine.org team member)
+Workaround:+
435 186 Jan Niggemann (redmine.org team member)
Replace @localhost@ with @127.0.0.1@ in database.yml.
436 186 Jan Niggemann (redmine.org team member)
437 283 Mischa The Evil
fn5. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
438 186 Jan Niggemann (redmine.org team member)
439 283 Mischa The Evil
fn6. http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx
440 186 Jan Niggemann (redmine.org team member)
441 283 Mischa The Evil
fn7. https://github.com/brianmario/mysql2/issues/279
442 80 Jean-Philippe Lang
443 80 Jean-Philippe Lang
h2. Alternative to manual installation
444 80 Jean-Philippe Lang
445 80 Jean-Philippe Lang
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.