RedmineInstall » History » Version 297

Go MAEDA, 2018-12-09 00:39
Removed the footnote about the issue regarding Windows Ruby 2.0 and SQL Server which should have been fixed in tiny_tds 0.6.2 (https://github.com/rails-sqlserver/tiny_tds/issues/110)

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