RedmineInstall » History » Version 267

Go MAEDA, 2017-05-07 15:26
Ruby 2.1 is no longer maintained by Ruby community

1 1 Jean-Philippe Lang
h1. Installing Redmine
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
{{>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 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 265 Go MAEDA
|current trunk     |ruby 1.9.3[4], 2.0.0[3], 2.1, 2.2[2], 2.3, 2.4[1]         |Rails 4.2[0]      |
19 265 Go MAEDA
|3.3               |ruby 1.9.3[4], 2.0.0[3], 2.1, 2.2[2], 2.3                 |Rails 4.2[0]      |
20 265 Go MAEDA
|3.2               |ruby 1.9.3[4], 2.0.0[3], 2.1, 2.2[2]                      |Rails 4.2[0]      |
21 1 Jean-Philippe Lang
22 267 Go MAEDA
%{color: red}Support for Ruby 1.9.3, 2.0 and 2.1 has 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 267 Go MAEDA
https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/
26 260 Toshi MARUYAMA
27 256 Toshi MARUYAMA
*Redmine 3.2 or lower does not support Ruby 2.3*. Redmine 3.3 supports Ruby 2.3.
28 255 Toshi MARUYAMA
29 254 Toshi MARUYAMA
*Redmine does not support JRuby* because some gems do not support Rails 4.2.
30 247 Toshi MARUYAMA
** "activerecord-jdbc-adapter":https://github.com/jruby/activerecord-jdbc-adapter/issues/599
31 247 Toshi MARUYAMA
** "loofah":https://github.com/flavorjones/loofah/issues/88
32 1 Jean-Philippe Lang
33 1 Jean-Philippe Lang
fn0. Rails 4.2.2 (Redmine version:3.0.3) had non ASCII URL issue on MinGW Ruby ("Windows-based installer":http://rubyinstaller.org/) thin and puma (#19321, #19374). Rails 4.2.3 (Redmine version:3.0.4) fixed it.
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 195 Mischa The Evil
 * make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running @gem install mysql2@.
48 263 Go MAEDA
 * *MySQL >= 5.6* and *MariaDB* have known issues (#19344, #19395, #17460, #25416).
49 1 Jean-Philippe Lang
50 191 Etienne Massip
* PostgreSQL 8.2 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 1 Jean-Philippe Lang
55 233 Toshi MARUYAMA
* Microsoft SQL Server
56 233 Toshi MARUYAMA
57 233 Toshi MARUYAMA
 * Redmine 2.x: 2008 or higher (since Redmine 2.3.0)
58 233 Toshi MARUYAMA
 * Redmine 3.x: "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
59 192 Etienne Massip
60 192 Etienne Massip
* SQLite 3 (not for multi-user production use!)
61 190 Etienne Massip
62 1 Jean-Philippe Lang
h3. Optional components
63 1 Jean-Philippe Lang
64 1 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
65 215 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to PNG image and thumbnails generation).
66 193 Mischa The Evil
      * "Ruby OpenID Library":http://openidenabled.com/ruby-openid/ (to enable OpenID support). Version 2 or greater is required.
67 1 Jean-Philippe Lang
68 1 Jean-Philippe Lang
h2. Redmine Version
69 1 Jean-Philippe Lang
70 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.
71 1 Jean-Philippe Lang
72 114 Etienne Massip
h2. Installation procedure
73 35 Jean-Philippe Lang
74 165 Etienne Massip
h3. Step 1 - Redmine application
75 26 Jean-Philippe Lang
76 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
77 1 Jean-Philippe Lang
78 174 Etienne Massip
See the [[Download|download page]] for details.
79 165 Etienne Massip
80 202 Jean-Philippe Lang
h3. Step 2 - Create an empty database and accompanying user
81 165 Etienne Massip
82 1 Jean-Philippe Lang
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
83 165 Etienne Massip
84 1 Jean-Philippe Lang
h4. MySQL
85 166 Etienne Massip
86 208 Etienne Massip
<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 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
90 208 Etienne Massip
</code></pre>
91 1 Jean-Philippe Lang
92 88 Sean Farrell
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
93 208 Etienne Massip
<pre><code class="sql">
94 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
95 208 Etienne Massip
</code></pre>
96 208 Etienne Massip
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 205 Etienne Massip
h4. SQL Server
106 205 Etienne Massip
107 205 Etienne Massip
The database, login and user can be created within ??SQL Server Management Studio?? with a few clicks.
108 205 Etienne Massip
109 205 Etienne Massip
If you prefer the command line option with @SQLCMD@, here's some basic example:
110 206 Etienne Massip
111 206 Etienne Massip
{{collapse(Show SQL,Hide SQL)
112 205 Etienne Massip
<pre><code class="sql">
113 205 Etienne Massip
USE [master]
114 205 Etienne Massip
GO
115 205 Etienne Massip
116 205 Etienne Massip
-- Very basic DB creation
117 205 Etienne Massip
CREATE DATABASE [REDMINE]
118 1 Jean-Philippe Lang
GO
119 1 Jean-Philippe Lang
120 206 Etienne Massip
-- Creation of a login with SQL Server login/password authentication and no password expiration policy
121 206 Etienne Massip
CREATE LOGIN [REDMINE] WITH PASSWORD=N'redminepassword', DEFAULT_DATABASE=[REDMINE], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF
122 205 Etienne Massip
GO
123 205 Etienne Massip
124 205 Etienne Massip
-- User creation using previously created login authentication
125 205 Etienne Massip
USE [REDMINE]
126 205 Etienne Massip
GO
127 205 Etienne Massip
CREATE USER [REDMINE] FOR LOGIN [REDMINE]
128 205 Etienne Massip
GO
129 205 Etienne Massip
-- User permissions set via roles
130 207 Etienne Massip
EXEC sp_addrolemember N'db_datareader', N'REDMINE'
131 205 Etienne Massip
GO
132 207 Etienne Massip
EXEC sp_addrolemember N'db_datawriter', N'REDMINE'
133 1 Jean-Philippe Lang
GO
134 205 Etienne Massip
</code></pre>
135 206 Etienne Massip
}}
136 166 Etienne Massip
137 202 Jean-Philippe Lang
h3. Step 3 - Database connection configuration
138 1 Jean-Philippe Lang
139 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.
140 165 Etienne Massip
141 264 Go MAEDA
Example for a MySQL database (default port):
142 88 Sean Farrell
143 209 Etienne Massip
<pre><code class="yml">
144 1 Jean-Philippe Lang
production:
145 1 Jean-Philippe Lang
  adapter: mysql2
146 1 Jean-Philippe Lang
  database: redmine
147 1 Jean-Philippe Lang
  host: localhost
148 1 Jean-Philippe Lang
  username: redmine
149 1 Jean-Philippe Lang
  password: my_password
150 1 Jean-Philippe Lang
</code></pre>
151 209 Etienne Massip
152 1 Jean-Philippe Lang
If your server is not running on the standard port (3306), use this configuration instead:
153 1 Jean-Philippe Lang
154 1 Jean-Philippe Lang
<pre><code class="yml">
155 1 Jean-Philippe Lang
production:
156 264 Go MAEDA
  adapter: mysql2
157 1 Jean-Philippe Lang
  database: redmine
158 1 Jean-Philippe Lang
  host: localhost
159 1 Jean-Philippe Lang
  port: 3307
160 1 Jean-Philippe Lang
  username: redmine
161 1 Jean-Philippe Lang
  password: my_password
162 209 Etienne Massip
</code></pre>
163 1 Jean-Philippe Lang
164 1 Jean-Philippe Lang
Example for a PostgreSQL database (default port):
165 1 Jean-Philippe Lang
166 209 Etienne Massip
<pre><code class="yml">
167 1 Jean-Philippe Lang
production:
168 1 Jean-Philippe Lang
  adapter: postgresql
169 1 Jean-Philippe Lang
  database: <your_database_name>
170 1 Jean-Philippe Lang
  host: <postgres_host>
171 1 Jean-Philippe Lang
  username: <postgres_user>
172 1 Jean-Philippe Lang
  password: <postgres_user_password>
173 1 Jean-Philippe Lang
  encoding: utf8
174 1 Jean-Philippe Lang
  schema_search_path: <database_schema> (default - public)
175 209 Etienne Massip
</code></pre>
176 1 Jean-Philippe Lang
177 209 Etienne Massip
Example for a SQL Server database (default host @localhost@, default port @1433@):
178 209 Etienne Massip
<pre><code class="yml">
179 209 Etienne Massip
production:
180 209 Etienne Massip
  adapter: sqlserver
181 209 Etienne Massip
  database: redmine
182 209 Etienne Massip
  username: redmine # should match the database user name
183 209 Etienne Massip
  password: redminepassword # should match the login password
184 209 Etienne Massip
</code></pre>
185 202 Jean-Philippe Lang
186 202 Jean-Philippe Lang
h3. Step 4 - Dependencies installation
187 202 Jean-Philippe Lang
188 202 Jean-Philippe Lang
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
189 202 Jean-Philippe Lang
190 202 Jean-Philippe Lang
You need to install Bundler first:
191 202 Jean-Philippe Lang
192 202 Jean-Philippe Lang
  gem install bundler
193 202 Jean-Philippe Lang
194 202 Jean-Philippe Lang
Then you can install all the gems required by Redmine using the following command:
195 202 Jean-Philippe Lang
196 202 Jean-Philippe Lang
  bundle install --without development test
197 202 Jean-Philippe Lang
198 202 Jean-Philippe Lang
h4. Optional dependencies
199 202 Jean-Philippe Lang
200 202 Jean-Philippe Lang
h5. RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
201 202 Jean-Philippe Lang
202 202 Jean-Philippe Lang
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
203 202 Jean-Philippe Lang
204 202 Jean-Philippe Lang
 @bundle install --without development test rmagick@
205 202 Jean-Philippe Lang
206 202 Jean-Philippe Lang
207 202 Jean-Philippe Lang
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
208 202 Jean-Philippe Lang
209 202 Jean-Philippe Lang
h5. Database adapters
210 202 Jean-Philippe Lang
211 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).
212 214 Etienne Massip
213 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!
214 202 Jean-Philippe Lang
215 202 Jean-Philippe Lang
h4. Additional dependencies (@Gemfile.local@)
216 202 Jean-Philippe Lang
217 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@.
218 202 Jean-Philippe Lang
219 202 Jean-Philippe Lang
Example:
220 202 Jean-Philippe Lang
<pre>
221 202 Jean-Philippe Lang
# Gemfile.local
222 202 Jean-Philippe Lang
gem 'puma'
223 1 Jean-Philippe Lang
</pre>
224 1 Jean-Philippe Lang
225 165 Etienne Massip
h3. Step 5 - Session store secret generation
226 1 Jean-Philippe Lang
227 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
228 165 Etienne Massip
Generating a new secret token invalidates all existing sessions after restart.
229 165 Etienne Massip
230 151 Jean-Philippe Lang
* with Redmine 1.4.x:
231 151 Jean-Philippe Lang
232 151 Jean-Philippe Lang
<pre>
233 234 Go MAEDA
bundle exec rake generate_session_store
234 1 Jean-Philippe Lang
</pre>
235 151 Jean-Philippe Lang
236 1 Jean-Philippe Lang
* with Redmine 2.x:
237 1 Jean-Philippe Lang
238 151 Jean-Philippe Lang
<pre>
239 234 Go MAEDA
bundle exec rake generate_secret_token
240 1 Jean-Philippe Lang
</pre>
241 90 Jiongliang Zhang
242 243 Toshi MARUYAMA
Alternatively, you can store this secret in config/secrets.yml:
243 243 Toshi MARUYAMA
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
244 243 Toshi MARUYAMA
245 165 Etienne Massip
h3. Step 6 - Database schema objects creation
246 90 Jiongliang Zhang
247 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
248 165 Etienne Massip
249 234 Go MAEDA
  RAILS_ENV=production bundle exec rake db:migrate
250 1 Jean-Philippe Lang
251 184 Etienne Massip
Windows syntax:
252 1 Jean-Philippe Lang
253 184 Etienne Massip
 set RAILS_ENV=production
254 234 Go MAEDA
bundle exec rake db:migrate
255 184 Etienne Massip
256 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@.
257 184 Etienne Massip
258 184 Etienne Massip
+Ubuntu troubleshooting:+
259 1 Jean-Philippe Lang
260 165 Etienne Massip
If you get this error with Ubuntu:
261 90 Jiongliang Zhang
<pre>
262 114 Etienne Massip
Rake aborted!
263 1 Jean-Philippe Lang
no such file to load -- net/https
264 1 Jean-Philippe Lang
</pre>
265 1 Jean-Philippe Lang
266 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
267 1 Jean-Philippe Lang
268 165 Etienne Massip
h3. Step 7 - Database default data set
269 1 Jean-Philippe Lang
270 165 Etienne Massip
Insert default configuration data in database, by running the following command:
271 165 Etienne Massip
272 234 Go MAEDA
  RAILS_ENV=production bundle exec rake redmine:load_default_data
273 62 Vladimir L
274 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.
275 171 Etienne Massip
276 171 Etienne Massip
E.g.:
277 171 Etienne Massip
278 171 Etienne Massip
Unices:
279 171 Etienne Massip
280 234 Go MAEDA
  RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data
281 171 Etienne Massip
282 171 Etienne Massip
Windows:
283 171 Etienne Massip
<pre>
284 171 Etienne Massip
set RAILS_ENV=production
285 171 Etienne Massip
set REDMINE_LANG=fr
286 234 Go MAEDA
bundle exec rake redmine:load_default_data
287 171 Etienne Massip
</pre>
288 32 Jean-Philippe Lang
289 167 Etienne Massip
h3. Step 8 - File system permissions
290 32 Jean-Philippe Lang
291 165 Etienne Massip
NB: _Windows users can skip this section._
292 14 Jean-Philippe Lang
293 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
294 1 Jean-Philippe Lang
295 165 Etienne Massip
# @files@ (storage of attachments)
296 165 Etienne Massip
# @log@ (application log file @production.log@)
297 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
298 220 Jean-Baptiste Barth
# @public/plugin_assets@ (assets of plugins)
299 221 Jean-Baptiste Barth
300 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
301 165 Etienne Massip
302 1 Jean-Philippe Lang
<pre>
303 219 Jean-Baptiste Barth
mkdir -p tmp tmp/pdf public/plugin_assets
304 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
305 1 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
306 1 Jean-Philippe Lang
</pre>
307 1 Jean-Philippe Lang
308 165 Etienne Massip
h3. Step 9 - Test the installation
309 1 Jean-Philippe Lang
310 165 Etienne Massip
Test the installation by running WEBrick web server:
311 165 Etienne Massip
312 1 Jean-Philippe Lang
* with Redmine 1.4.x:
313 1 Jean-Philippe Lang
314 151 Jean-Philippe Lang
<pre>
315 234 Go MAEDA
bundle exec ruby script/server webrick -e production
316 1 Jean-Philippe Lang
</pre>
317 1 Jean-Philippe Lang
318 151 Jean-Philippe Lang
* with Redmine 2.x:
319 151 Jean-Philippe Lang
320 151 Jean-Philippe Lang
<pre>
321 234 Go MAEDA
bundle exec ruby script/rails server webrick -e production
322 151 Jean-Philippe Lang
</pre>
323 151 Jean-Philippe Lang
324 244 Jan Niggemann (redmine.org team member)
* with Redmine 3.x:
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 11 Jean-Philippe Lang
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
401 11 Jean-Philippe Lang
402 11 Jean-Philippe Lang
<pre>
403 11 Jean-Philippe Lang
# Database
404 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
405 11 Jean-Philippe Lang
406 11 Jean-Philippe Lang
# Attachments
407 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
408 1 Jean-Philippe Lang
</pre>
409 69 Giuliano Simoncelli
410 216 Jean-Baptiste Barth
h2. Notes on Linux/Unix installation
411 216 Jean-Baptiste Barth
412 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.
413 216 Jean-Baptiste Barth
414 69 Giuliano Simoncelli
h2. Notes on Windows installation
415 69 Giuliano Simoncelli
416 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
417 156 Etienne Massip
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
418 1 Jean-Philippe Lang
419 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
420 69 Giuliano Simoncelli
421 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
422 1 Jean-Philippe Lang
423 156 Etienne Massip
I.e. commands with the following syntaxes:
424 69 Giuliano Simoncelli
425 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
426 69 Giuliano Simoncelli
427 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
428 1 Jean-Philippe Lang
429 156 Etienne Massip
have to be turned into 2 subsequent commands:
430 69 Giuliano Simoncelli
431 156 Etienne Massip
<pre>set RAILS_ENV=production
432 156 Etienne Massip
<any commmand></pre>
433 156 Etienne Massip
434 156 Etienne Massip
+MySQL gem installation issue:+
435 156 Etienne Massip
436 156 Etienne Massip
You may need to manually install the mysql gem using the following command:
437 156 Etienne Massip
438 69 Giuliano Simoncelli
<pre>
439 69 Giuliano Simoncelli
gem install mysql
440 69 Giuliano Simoncelli
</pre>
441 1 Jean-Philippe Lang
442 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
443 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.
444 156 Etienne Massip
445 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
446 186 Jan Niggemann (redmine.org team member)
On Win7 and later, @localhost@ is commented out in the hosts file[1] and IPV6 is the default[2]. As the mysql2 gem does no support IPV6 addresses[3], a connection can't be established and you get the error "@Can't connect to MySQL server on 'localhost' (10061)@".
447 186 Jan Niggemann (redmine.org team member)
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
448 186 Jan Niggemann (redmine.org team member)
449 186 Jan Niggemann (redmine.org team member)
+Workaround:+
450 186 Jan Niggemann (redmine.org team member)
Replace @localhost@ with @127.0.0.1@ in database.yml.
451 186 Jan Niggemann (redmine.org team member)
452 186 Jan Niggemann (redmine.org team member)
fn1. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
453 186 Jan Niggemann (redmine.org team member)
454 186 Jan Niggemann (redmine.org team member)
fn2. http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx
455 186 Jan Niggemann (redmine.org team member)
456 186 Jan Niggemann (redmine.org team member)
fn3. https://github.com/brianmario/mysql2/issues/279
457 186 Jan Niggemann (redmine.org team member)
458 80 Jean-Philippe Lang
459 80 Jean-Philippe Lang
h2. Alternative to manual installation
460 80 Jean-Philippe Lang
461 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.