RedmineInstall » History » Version 309

Go MAEDA, 2020-02-16 10:12
Redmine 4.1 requires Ghostscript to enable thumbnails for PDF attachments (#22481)

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 301 Go MAEDA
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|macOS]] 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 299 Go MAEDA
|_. Redmine version|_. Supported Ruby versions                       |_. Rails version used|
18 307 Go MAEDA
|4.1               |Ruby 2.3, 2.4, 2.5, 2.6                          |Rails 5.2            |
19 308 Go MAEDA
|4.0               |Ruby 2.2[1], 2.3, 2.4, 2.5, 2.6                  |Rails 5.2            |
20 308 Go MAEDA
|3.4               |Ruby 1.9.3[2], 2.0.0, 2.1, 2.2, 2.3, 2.4         |Rails 4.2            |
21 1 Jean-Philippe Lang
22 308 Go MAEDA
fn1. Redmine prior to 4.0.6 supports Ruby >= 2.2.2. Redmine 4.0.6 and later don't support Ruby 2.2 (see #32787).
23 308 Go MAEDA
24 308 Go MAEDA
fn2. 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.
25 255 Toshi MARUYAMA
26 300 Go MAEDA
Important notices:
27 294 Go MAEDA
28 307 Go MAEDA
* %{color: red}Support of Ruby 2.3 and earlier have ended by Ruby community.% See the official announcements for details: "1.9.3":https://www.ruby-lang.org/en/news/2015/02/23/support-for-ruby-1-9-3-has-ended/, "2.0":https://www.ruby-lang.org/en/news/2016/02/24/support-plan-of-ruby-2-0-0-and-2-1/, "2.1":https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/, "2.2":https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/, "2.3":https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/
29 306 Go MAEDA
* *Redmine does not support JRuby* because "activerecord-jdbc-adapter":https://github.com/jruby/activerecord-jdbc-adapter/issues/599 and "loofah":https://github.com/flavorjones/loofah/issues/88 do not support Rails 4.2 or later.
30 212 Etienne Massip
31 164 Etienne Massip
h3. Supported database back-ends
32 92 Knight Samar
33 302 Go MAEDA
* MySQL 5.5 - 5.7
34 35 Jean-Philippe Lang
35 287 Toshi MARUYAMA
 * *MySQL 5.6 or higher* and *MariaDB* have known issues (#19344, #19395, #17460).
36 303 Go MAEDA
 * Redmine 3.x also supports MySQL 5.0 and 5.1
37 289 Go MAEDA
38 302 Go MAEDA
* PostgreSQL 9.2 or higher
39 1 Jean-Philippe Lang
40 146 Etienne Massip
 * 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";@
41 302 Go MAEDA
 * Redmine 3.x also supports PostgreSQL 8.3 - 9.1.
42 1 Jean-Philippe Lang
43 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
44 192 Etienne Massip
45 304 Go MAEDA
 * Redmine 4.0 does not support SQL Server as of December 2018 because a dependent library "activerecord-sqlserver-adapter":https://github.com/rails-sqlserver/activerecord-sqlserver-adapter does not support Rails 5.2 yet.
46 304 Go MAEDA
47 192 Etienne Massip
* SQLite 3 (not for multi-user production use!)
48 190 Etienne Massip
49 1 Jean-Philippe Lang
h3. Optional components
50 1 Jean-Philippe Lang
51 1 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
52 215 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to PNG image and thumbnails generation).
53 309 Go MAEDA
      * "Ghostscript":https://www.ghostscript.com/ (to enable thumbnails generation for PDF attachments in Redmine 4.1 or later).
54 1 Jean-Philippe Lang
55 1 Jean-Philippe Lang
h2. Redmine Version
56 1 Jean-Philippe Lang
57 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.
58 1 Jean-Philippe Lang
59 114 Etienne Massip
h2. Installation procedure
60 35 Jean-Philippe Lang
61 165 Etienne Massip
h3. Step 1 - Redmine application
62 26 Jean-Philippe Lang
63 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
64 1 Jean-Philippe Lang
65 174 Etienne Massip
See the [[Download|download page]] for details.
66 165 Etienne Massip
67 202 Jean-Philippe Lang
h3. Step 2 - Create an empty database and accompanying user
68 165 Etienne Massip
69 1 Jean-Philippe Lang
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
70 165 Etienne Massip
71 1 Jean-Philippe Lang
h4. MySQL
72 166 Etienne Massip
73 1 Jean-Philippe Lang
<pre><code class="sql">
74 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8mb4;
75 287 Toshi MARUYAMA
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
76 287 Toshi MARUYAMA
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
77 287 Toshi MARUYAMA
</code></pre>
78 287 Toshi MARUYAMA
79 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
80 287 Toshi MARUYAMA
81 287 Toshi MARUYAMA
<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 1 Jean-Philippe Lang
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
85 1 Jean-Philippe Lang
</code></pre>
86 281 Go MAEDA
87 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:
88 208 Etienne Massip
<pre><code class="sql">
89 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8;
90 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
91 208 Etienne Massip
</code></pre>
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 296 Go MAEDA
h4. SQLite
101 296 Go MAEDA
102 296 Go MAEDA
Skip this step. A database file will be created during [[RedmineInstall#Step-6-Database-schema-objects-creation|Step 6]].
103 296 Go MAEDA
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 295 Go MAEDA
  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 295 Go MAEDA
  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 295 Go MAEDA
  password: "<postgres_user_password>"
172 1 Jean-Philippe Lang
  encoding: utf8
173 1 Jean-Philippe Lang
  schema_search_path: <database_schema> (default - public)
174 296 Go MAEDA
</code></pre>
175 296 Go MAEDA
176 296 Go MAEDA
Example for a SQLite database:
177 296 Go MAEDA
178 296 Go MAEDA
<pre><code class="yml">
179 296 Go MAEDA
production:
180 296 Go MAEDA
  adapter: sqlite3
181 296 Go MAEDA
  database: db/redmine.sqlite3
182 209 Etienne Massip
</code></pre>
183 1 Jean-Philippe Lang
184 209 Etienne Massip
Example for a SQL Server database (default host @localhost@, default port @1433@):
185 209 Etienne Massip
<pre><code class="yml">
186 209 Etienne Massip
production:
187 209 Etienne Massip
  adapter: sqlserver
188 209 Etienne Massip
  database: redmine
189 209 Etienne Massip
  username: redmine # should match the database user name
190 295 Go MAEDA
  password: "redminepassword" # should match the login password
191 209 Etienne Massip
</code></pre>
192 202 Jean-Philippe Lang
193 202 Jean-Philippe Lang
h3. Step 4 - Dependencies installation
194 202 Jean-Philippe Lang
195 202 Jean-Philippe Lang
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
196 202 Jean-Philippe Lang
197 202 Jean-Philippe Lang
You need to install Bundler first:
198 202 Jean-Philippe Lang
199 202 Jean-Philippe Lang
  gem install bundler
200 202 Jean-Philippe Lang
201 202 Jean-Philippe Lang
Then you can install all the gems required by Redmine using the following command:
202 202 Jean-Philippe Lang
203 202 Jean-Philippe Lang
  bundle install --without development test
204 202 Jean-Philippe Lang
205 202 Jean-Philippe Lang
h4. Optional dependencies
206 202 Jean-Philippe Lang
207 202 Jean-Philippe Lang
h5. RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
208 202 Jean-Philippe Lang
209 202 Jean-Philippe Lang
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
210 202 Jean-Philippe Lang
211 202 Jean-Philippe Lang
 @bundle install --without development test rmagick@
212 202 Jean-Philippe Lang
213 202 Jean-Philippe Lang
214 202 Jean-Philippe Lang
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
215 202 Jean-Philippe Lang
216 202 Jean-Philippe Lang
h5. Database adapters
217 202 Jean-Philippe Lang
218 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).
219 214 Etienne Massip
220 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!
221 202 Jean-Philippe Lang
222 202 Jean-Philippe Lang
h4. Additional dependencies (@Gemfile.local@)
223 202 Jean-Philippe Lang
224 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@.
225 202 Jean-Philippe Lang
226 202 Jean-Philippe Lang
Example:
227 202 Jean-Philippe Lang
<pre>
228 202 Jean-Philippe Lang
# Gemfile.local
229 202 Jean-Philippe Lang
gem 'puma'
230 1 Jean-Philippe Lang
</pre>
231 1 Jean-Philippe Lang
232 165 Etienne Massip
h3. Step 5 - Session store secret generation
233 1 Jean-Philippe Lang
234 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
235 151 Jean-Philippe Lang
Generating a new secret token invalidates all existing sessions after restart.
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 271 Toshi MARUYAMA
<pre>
249 278 Toshi MARUYAMA
RAILS_ENV=production bundle exec rake db:migrate
250 271 Toshi MARUYAMA
</pre>
251 271 Toshi MARUYAMA
252 271 Toshi MARUYAMA
*Windows syntax:*
253 271 Toshi MARUYAMA
254 271 Toshi MARUYAMA
<pre>
255 271 Toshi MARUYAMA
set RAILS_ENV=production
256 184 Etienne Massip
bundle exec rake db:migrate
257 271 Toshi MARUYAMA
</pre>
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 284 Toshi MARUYAMA
Note: If you have files in these directories (e.g. restore files from backup), make sure these files are not executable.
312 284 Toshi MARUYAMA
313 284 Toshi MARUYAMA
<pre>
314 284 Toshi MARUYAMA
sudo find files log tmp public/plugin_assets -type f -exec chmod -x {} +
315 284 Toshi MARUYAMA
</pre>
316 284 Toshi MARUYAMA
317 165 Etienne Massip
h3. Step 9 - Test the installation
318 151 Jean-Philippe Lang
319 244 Jan Niggemann (redmine.org team member)
Test the installation by running WEBrick web server:
320 244 Jan Niggemann (redmine.org team member)
321 244 Jan Niggemann (redmine.org team member)
<pre>
322 244 Jan Niggemann (redmine.org team member)
bundle exec rails server webrick -e production
323 244 Jan Niggemann (redmine.org team member)
</pre>
324 244 Jan Niggemann (redmine.org team member)
325 151 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
326 151 Jean-Philippe Lang
327 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.
328 14 Jean-Philippe Lang
329 165 Etienne Massip
h3. Step 10 - Logging into the application
330 158 Etienne Massip
331 165 Etienne Massip
Use default administrator account to log in:
332 165 Etienne Massip
333 1 Jean-Philippe Lang
    * login: admin
334 1 Jean-Philippe Lang
    * password: admin
335 14 Jean-Philippe Lang
336 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
337 165 Etienne Massip
338 130 Etienne Massip
h2. Configuration
339 1 Jean-Philippe Lang
340 185 Etienne Massip
Redmine settings are defined in a file named @config/configuration.yml@.
341 1 Jean-Philippe Lang
342 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.
343 1 Jean-Philippe Lang
344 185 Etienne Massip
These settings may be defined per Rails environment (@production@/@development@/@test@).
345 131 Etienne Massip
346 131 Etienne Massip
+Important+ : don't forget to restart the application after any change.
347 131 Etienne Massip
348 130 Etienne Massip
h3. Email / SMTP server settings
349 130 Etienne Massip
350 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
351 1 Jean-Philippe Lang
352 1 Jean-Philippe Lang
h3. SCM settings
353 1 Jean-Philippe Lang
354 133 Etienne Massip
This configuration section allows you to:
355 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)
356 131 Etienne Massip
* specify the full path to the binary
357 131 Etienne Massip
358 133 Etienne Massip
Examples (with Subversion):
359 131 Etienne Massip
360 133 Etienne Massip
Command name override:
361 131 Etienne Massip
362 131 Etienne Massip
 scm_subversion_command: "svn_replacement.exe"
363 131 Etienne Massip
364 133 Etienne Massip
Absolute path:
365 1 Jean-Philippe Lang
366 1 Jean-Philippe Lang
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
367 1 Jean-Philippe Lang
368 1 Jean-Philippe Lang
h3. Attachment storage settings
369 1 Jean-Philippe Lang
370 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.
371 133 Etienne Massip
372 133 Etienne Massip
Examples:
373 133 Etienne Massip
374 133 Etienne Massip
 attachments_storage_path: /var/redmine/files
375 133 Etienne Massip
376 133 Etienne Massip
 attachments_storage_path: D:/redmine/files
377 130 Etienne Massip
378 130 Etienne Massip
h2. Logging configuration
379 130 Etienne Massip
380 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.
381 21 Jean-Philippe Lang
382 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@.
383 123 Jean-Philippe Lang
<pre><code class="ruby">
384 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
385 162 Jean-Philippe Lang
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
386 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
387 11 Jean-Philippe Lang
</code></pre>
388 11 Jean-Philippe Lang
389 11 Jean-Philippe Lang
h2. Backups
390 11 Jean-Philippe Lang
391 11 Jean-Philippe Lang
Redmine backups should include:
392 11 Jean-Philippe Lang
* data (stored in your redmine database)
393 11 Jean-Philippe Lang
* attachments (stored in the @files@ directory of your Redmine install)
394 11 Jean-Philippe Lang
395 288 Go MAEDA
Please refer to [[RedmineBackupAndRestore|Backing up and restoring Redmine]] for more details.
396 69 Giuliano Simoncelli
397 216 Jean-Baptiste Barth
h2. Notes on Linux/Unix installation
398 216 Jean-Baptiste Barth
399 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.
400 216 Jean-Baptiste Barth
401 69 Giuliano Simoncelli
h2. Notes on Windows installation
402 69 Giuliano Simoncelli
403 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
404 156 Etienne Massip
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
405 1 Jean-Philippe Lang
406 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
407 69 Giuliano Simoncelli
408 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
409 1 Jean-Philippe Lang
410 156 Etienne Massip
I.e. commands with the following syntaxes:
411 69 Giuliano Simoncelli
412 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
413 69 Giuliano Simoncelli
414 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
415 1 Jean-Philippe Lang
416 156 Etienne Massip
have to be turned into 2 subsequent commands:
417 69 Giuliano Simoncelli
418 156 Etienne Massip
<pre>set RAILS_ENV=production
419 156 Etienne Massip
<any commmand></pre>
420 156 Etienne Massip
421 156 Etienne Massip
+MySQL gem installation issue:+
422 156 Etienne Massip
423 156 Etienne Massip
You may need to manually install the mysql gem using the following command:
424 156 Etienne Massip
425 69 Giuliano Simoncelli
<pre>
426 69 Giuliano Simoncelli
gem install mysql
427 69 Giuliano Simoncelli
</pre>
428 1 Jean-Philippe Lang
429 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
430 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.
431 156 Etienne Massip
432 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
433 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)@".
434 186 Jan Niggemann (redmine.org team member)
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
435 186 Jan Niggemann (redmine.org team member)
436 186 Jan Niggemann (redmine.org team member)
+Workaround:+
437 186 Jan Niggemann (redmine.org team member)
Replace @localhost@ with @127.0.0.1@ in database.yml.
438 186 Jan Niggemann (redmine.org team member)
439 283 Mischa The Evil
fn5. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
440 186 Jan Niggemann (redmine.org team member)
441 283 Mischa The Evil
fn6. http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx
442 186 Jan Niggemann (redmine.org team member)
443 283 Mischa The Evil
fn7. https://github.com/brianmario/mysql2/issues/279
444 80 Jean-Philippe Lang
445 80 Jean-Philippe Lang
h2. Alternative to manual installation
446 80 Jean-Philippe Lang
447 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.