RedmineInstall » History » Version 266

Go MAEDA, 2017-05-07 15:14
Mac OS X was renamed to macOS

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