RedmineInstall » History » Version 298

Go MAEDA, 2018-12-09 00:44
Removed the footnote about the MinGW Ruby 2.2 and Nokogiri 1.6.7 issue (#19419) because Redmine 3.3.8 requires Nokogiri 1.6.8 or later

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