RedmineInstall » History » Version 255

Toshi MARUYAMA, 2016-05-25 10:29
Redmine 3.2 or lower does not support Ruby 2.3. Redmine 3.3 will support Ruby 2.3.

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