RedmineInstall » History » Version 296

Go MAEDA, 2018-11-25 10:37
Add cases for SQLite in the installation guide Step 2 and Step 3 (#30023). Contributed by Takashi Maekawa.

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