RedmineInstall » History » Version 253

Toshi MARUYAMA, 2015-11-30 14:20
Nokorigi 1.6.7 has released

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