RedmineInstall » History » Version 300

Go MAEDA, 2018-12-09 01:15

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 299 Go MAEDA
|_. Redmine version|_. Supported Ruby versions                       |_. Rails version used|
18 299 Go MAEDA
|4.0 (upcoming)    |ruby 2.2 (2.2.2 and later), 2.3, 2.4, 2.5        |Rails 5.2            |
19 299 Go MAEDA
|3.4               |ruby 1.9.3[1], 2.0.0, 2.1, 2.2, 2.3, 2.4         |Rails 4.2            |
20 299 Go MAEDA
|3.3               |ruby 1.9.3[1], 2.0.0, 2.1, 2.2, 2.3              |Rails 4.2            |
21 1 Jean-Philippe Lang
22 300 Go MAEDA
fn1. 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.
23 255 Toshi MARUYAMA
24 300 Go MAEDA
Important notices:
25 294 Go MAEDA
26 300 Go MAEDA
* %{color: red}Support of Ruby 2.2 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/
27 300 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.
28 212 Etienne Massip
29 164 Etienne Massip
h3. Supported database back-ends
30 92 Knight Samar
31 262 Toshi MARUYAMA
* MySQL 5.0 - 5.5
32 35 Jean-Philippe Lang
33 287 Toshi MARUYAMA
 * *MySQL 5.6 or higher* and *MariaDB* have known issues (#19344, #19395, #17460).
34 291 Go MAEDA
 * Redmine 4.0.0 does not support MySQL <5.5 (#28504).
35 1 Jean-Philippe Lang
36 289 Go MAEDA
* PostgreSQL 8.3 or higher
37 117 Etienne Massip
38 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";@
39 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
40 292 Go MAEDA
 * Redmine 4.0.0 does not support PostgreSQL <9.2 (#28505).
41 1 Jean-Philippe Lang
42 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
43 192 Etienne Massip
44 192 Etienne Massip
* SQLite 3 (not for multi-user production use!)
45 190 Etienne Massip
46 1 Jean-Philippe Lang
h3. Optional components
47 1 Jean-Philippe Lang
48 1 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
49 215 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to PNG image and thumbnails generation).
50 1 Jean-Philippe Lang
51 1 Jean-Philippe Lang
h2. Redmine Version
52 1 Jean-Philippe Lang
53 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.
54 1 Jean-Philippe Lang
55 114 Etienne Massip
h2. Installation procedure
56 35 Jean-Philippe Lang
57 165 Etienne Massip
h3. Step 1 - Redmine application
58 26 Jean-Philippe Lang
59 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
60 1 Jean-Philippe Lang
61 174 Etienne Massip
See the [[Download|download page]] for details.
62 165 Etienne Massip
63 202 Jean-Philippe Lang
h3. Step 2 - Create an empty database and accompanying user
64 165 Etienne Massip
65 1 Jean-Philippe Lang
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
66 165 Etienne Massip
67 1 Jean-Philippe Lang
h4. MySQL
68 166 Etienne Massip
69 1 Jean-Philippe Lang
<pre><code class="sql">
70 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8mb4;
71 287 Toshi MARUYAMA
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
72 287 Toshi MARUYAMA
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
73 287 Toshi MARUYAMA
</code></pre>
74 287 Toshi MARUYAMA
75 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
76 287 Toshi MARUYAMA
77 287 Toshi MARUYAMA
<pre><code class="sql">
78 208 Etienne Massip
CREATE DATABASE redmine CHARACTER SET utf8;
79 208 Etienne Massip
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
80 1 Jean-Philippe Lang
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
81 1 Jean-Philippe Lang
</code></pre>
82 281 Go MAEDA
83 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:
84 208 Etienne Massip
<pre><code class="sql">
85 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8;
86 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
87 208 Etienne Massip
</code></pre>
88 1 Jean-Philippe Lang
89 1 Jean-Philippe Lang
h4. PostgreSQL
90 166 Etienne Massip
91 205 Etienne Massip
<pre><code class="sql">
92 1 Jean-Philippe Lang
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
93 1 Jean-Philippe Lang
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
94 205 Etienne Massip
</code></pre>
95 205 Etienne Massip
96 296 Go MAEDA
h4. SQLite
97 296 Go MAEDA
98 296 Go MAEDA
Skip this step. A database file will be created during [[RedmineInstall#Step-6-Database-schema-objects-creation|Step 6]].
99 296 Go MAEDA
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 264 Go MAEDA
Example for a MySQL database (default port):
137 88 Sean Farrell
138 209 Etienne Massip
<pre><code class="yml">
139 1 Jean-Philippe Lang
production:
140 1 Jean-Philippe Lang
  adapter: mysql2
141 1 Jean-Philippe Lang
  database: redmine
142 1 Jean-Philippe Lang
  host: localhost
143 1 Jean-Philippe Lang
  username: redmine
144 295 Go MAEDA
  password: "my_password"
145 1 Jean-Philippe Lang
</code></pre>
146 209 Etienne Massip
147 1 Jean-Philippe Lang
If your server is not running on the standard port (3306), use this configuration instead:
148 1 Jean-Philippe Lang
149 1 Jean-Philippe Lang
<pre><code class="yml">
150 1 Jean-Philippe Lang
production:
151 264 Go MAEDA
  adapter: mysql2
152 1 Jean-Philippe Lang
  database: redmine
153 1 Jean-Philippe Lang
  host: localhost
154 1 Jean-Philippe Lang
  port: 3307
155 1 Jean-Philippe Lang
  username: redmine
156 295 Go MAEDA
  password: "my_password"
157 209 Etienne Massip
</code></pre>
158 1 Jean-Philippe Lang
159 1 Jean-Philippe Lang
Example for a PostgreSQL database (default port):
160 1 Jean-Philippe Lang
161 209 Etienne Massip
<pre><code class="yml">
162 1 Jean-Philippe Lang
production:
163 1 Jean-Philippe Lang
  adapter: postgresql
164 1 Jean-Philippe Lang
  database: <your_database_name>
165 1 Jean-Philippe Lang
  host: <postgres_host>
166 1 Jean-Philippe Lang
  username: <postgres_user>
167 295 Go MAEDA
  password: "<postgres_user_password>"
168 1 Jean-Philippe Lang
  encoding: utf8
169 1 Jean-Philippe Lang
  schema_search_path: <database_schema> (default - public)
170 296 Go MAEDA
</code></pre>
171 296 Go MAEDA
172 296 Go MAEDA
Example for a SQLite database:
173 296 Go MAEDA
174 296 Go MAEDA
<pre><code class="yml">
175 296 Go MAEDA
production:
176 296 Go MAEDA
  adapter: sqlite3
177 296 Go MAEDA
  database: db/redmine.sqlite3
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 295 Go MAEDA
  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 151 Jean-Philippe Lang
Generating a new secret token invalidates all existing sessions after restart.
232 1 Jean-Philippe Lang
233 151 Jean-Philippe Lang
<pre>
234 234 Go MAEDA
bundle exec rake generate_secret_token
235 1 Jean-Philippe Lang
</pre>
236 90 Jiongliang Zhang
237 243 Toshi MARUYAMA
Alternatively, you can store this secret in config/secrets.yml:
238 243 Toshi MARUYAMA
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
239 243 Toshi MARUYAMA
240 165 Etienne Massip
h3. Step 6 - Database schema objects creation
241 90 Jiongliang Zhang
242 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
243 165 Etienne Massip
244 271 Toshi MARUYAMA
<pre>
245 278 Toshi MARUYAMA
RAILS_ENV=production bundle exec rake db:migrate
246 271 Toshi MARUYAMA
</pre>
247 271 Toshi MARUYAMA
248 271 Toshi MARUYAMA
*Windows syntax:*
249 271 Toshi MARUYAMA
250 271 Toshi MARUYAMA
<pre>
251 271 Toshi MARUYAMA
set RAILS_ENV=production
252 184 Etienne Massip
bundle exec rake db:migrate
253 271 Toshi MARUYAMA
</pre>
254 184 Etienne Massip
255 184 Etienne Massip
It will create tables by running all migrations one by one then create the set of the permissions and the application administrator account, named @admin@.
256 184 Etienne Massip
257 184 Etienne Massip
+Ubuntu troubleshooting:+
258 1 Jean-Philippe Lang
259 165 Etienne Massip
If you get this error with Ubuntu:
260 90 Jiongliang Zhang
<pre>
261 114 Etienne Massip
Rake aborted!
262 1 Jean-Philippe Lang
no such file to load -- net/https
263 1 Jean-Philippe Lang
</pre>
264 1 Jean-Philippe Lang
265 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
266 1 Jean-Philippe Lang
267 165 Etienne Massip
h3. Step 7 - Database default data set
268 1 Jean-Philippe Lang
269 165 Etienne Massip
Insert default configuration data in database, by running the following command:
270 165 Etienne Massip
271 234 Go MAEDA
  RAILS_ENV=production bundle exec rake redmine:load_default_data
272 62 Vladimir L
273 171 Etienne Massip
Redmine will prompt you for the data set language that should be loaded; you can also define the @REDMINE_LANG@ environment variable before running the command to a value which will be automatically and silently picked up by the task.
274 171 Etienne Massip
275 171 Etienne Massip
E.g.:
276 171 Etienne Massip
277 171 Etienne Massip
Unices:
278 171 Etienne Massip
279 234 Go MAEDA
  RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data
280 171 Etienne Massip
281 171 Etienne Massip
Windows:
282 171 Etienne Massip
<pre>
283 171 Etienne Massip
set RAILS_ENV=production
284 171 Etienne Massip
set REDMINE_LANG=fr
285 234 Go MAEDA
bundle exec rake redmine:load_default_data
286 171 Etienne Massip
</pre>
287 32 Jean-Philippe Lang
288 167 Etienne Massip
h3. Step 8 - File system permissions
289 32 Jean-Philippe Lang
290 165 Etienne Massip
NB: _Windows users can skip this section._
291 14 Jean-Philippe Lang
292 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
293 1 Jean-Philippe Lang
294 165 Etienne Massip
# @files@ (storage of attachments)
295 165 Etienne Massip
# @log@ (application log file @production.log@)
296 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
297 220 Jean-Baptiste Barth
# @public/plugin_assets@ (assets of plugins)
298 221 Jean-Baptiste Barth
299 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
300 165 Etienne Massip
301 1 Jean-Philippe Lang
<pre>
302 219 Jean-Baptiste Barth
mkdir -p tmp tmp/pdf public/plugin_assets
303 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
304 1 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
305 1 Jean-Philippe Lang
</pre>
306 1 Jean-Philippe Lang
307 284 Toshi MARUYAMA
Note: If you have files in these directories (e.g. restore files from backup), make sure these files are not executable.
308 284 Toshi MARUYAMA
309 284 Toshi MARUYAMA
<pre>
310 284 Toshi MARUYAMA
sudo find files log tmp public/plugin_assets -type f -exec chmod -x {} +
311 284 Toshi MARUYAMA
</pre>
312 284 Toshi MARUYAMA
313 165 Etienne Massip
h3. Step 9 - Test the installation
314 151 Jean-Philippe Lang
315 244 Jan Niggemann (redmine.org team member)
Test the installation by running WEBrick web server:
316 244 Jan Niggemann (redmine.org team member)
317 244 Jan Niggemann (redmine.org team member)
<pre>
318 244 Jan Niggemann (redmine.org team member)
bundle exec rails server webrick -e production
319 244 Jan Niggemann (redmine.org team member)
</pre>
320 244 Jan Niggemann (redmine.org team member)
321 151 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
322 151 Jean-Philippe Lang
323 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.
324 14 Jean-Philippe Lang
325 165 Etienne Massip
h3. Step 10 - Logging into the application
326 158 Etienne Massip
327 165 Etienne Massip
Use default administrator account to log in:
328 165 Etienne Massip
329 1 Jean-Philippe Lang
    * login: admin
330 1 Jean-Philippe Lang
    * password: admin
331 14 Jean-Philippe Lang
332 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
333 165 Etienne Massip
334 130 Etienne Massip
h2. Configuration
335 1 Jean-Philippe Lang
336 185 Etienne Massip
Redmine settings are defined in a file named @config/configuration.yml@.
337 1 Jean-Philippe Lang
338 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.
339 1 Jean-Philippe Lang
340 185 Etienne Massip
These settings may be defined per Rails environment (@production@/@development@/@test@).
341 131 Etienne Massip
342 131 Etienne Massip
+Important+ : don't forget to restart the application after any change.
343 131 Etienne Massip
344 130 Etienne Massip
h3. Email / SMTP server settings
345 130 Etienne Massip
346 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
347 1 Jean-Philippe Lang
348 1 Jean-Philippe Lang
h3. SCM settings
349 1 Jean-Philippe Lang
350 133 Etienne Massip
This configuration section allows you to:
351 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)
352 131 Etienne Massip
* specify the full path to the binary
353 131 Etienne Massip
354 133 Etienne Massip
Examples (with Subversion):
355 131 Etienne Massip
356 133 Etienne Massip
Command name override:
357 131 Etienne Massip
358 131 Etienne Massip
 scm_subversion_command: "svn_replacement.exe"
359 131 Etienne Massip
360 133 Etienne Massip
Absolute path:
361 1 Jean-Philippe Lang
362 1 Jean-Philippe Lang
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
363 1 Jean-Philippe Lang
364 1 Jean-Philippe Lang
h3. Attachment storage settings
365 1 Jean-Philippe Lang
366 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.
367 133 Etienne Massip
368 133 Etienne Massip
Examples:
369 133 Etienne Massip
370 133 Etienne Massip
 attachments_storage_path: /var/redmine/files
371 133 Etienne Massip
372 133 Etienne Massip
 attachments_storage_path: D:/redmine/files
373 130 Etienne Massip
374 130 Etienne Massip
h2. Logging configuration
375 130 Etienne Massip
376 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.
377 21 Jean-Philippe Lang
378 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@.
379 123 Jean-Philippe Lang
<pre><code class="ruby">
380 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
381 162 Jean-Philippe Lang
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
382 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
383 11 Jean-Philippe Lang
</code></pre>
384 11 Jean-Philippe Lang
385 11 Jean-Philippe Lang
h2. Backups
386 11 Jean-Philippe Lang
387 11 Jean-Philippe Lang
Redmine backups should include:
388 11 Jean-Philippe Lang
* data (stored in your redmine database)
389 11 Jean-Philippe Lang
* attachments (stored in the @files@ directory of your Redmine install)
390 11 Jean-Philippe Lang
391 288 Go MAEDA
Please refer to [[RedmineBackupAndRestore|Backing up and restoring Redmine]] for more details.
392 69 Giuliano Simoncelli
393 216 Jean-Baptiste Barth
h2. Notes on Linux/Unix installation
394 216 Jean-Baptiste Barth
395 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.
396 216 Jean-Baptiste Barth
397 69 Giuliano Simoncelli
h2. Notes on Windows installation
398 69 Giuliano Simoncelli
399 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
400 156 Etienne Massip
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
401 1 Jean-Philippe Lang
402 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
403 69 Giuliano Simoncelli
404 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
405 1 Jean-Philippe Lang
406 156 Etienne Massip
I.e. commands with the following syntaxes:
407 69 Giuliano Simoncelli
408 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
409 69 Giuliano Simoncelli
410 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
411 1 Jean-Philippe Lang
412 156 Etienne Massip
have to be turned into 2 subsequent commands:
413 69 Giuliano Simoncelli
414 156 Etienne Massip
<pre>set RAILS_ENV=production
415 156 Etienne Massip
<any commmand></pre>
416 156 Etienne Massip
417 156 Etienne Massip
+MySQL gem installation issue:+
418 156 Etienne Massip
419 156 Etienne Massip
You may need to manually install the mysql gem using the following command:
420 156 Etienne Massip
421 69 Giuliano Simoncelli
<pre>
422 69 Giuliano Simoncelli
gem install mysql
423 69 Giuliano Simoncelli
</pre>
424 1 Jean-Philippe Lang
425 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
426 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.
427 156 Etienne Massip
428 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
429 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)@".
430 186 Jan Niggemann (redmine.org team member)
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
431 186 Jan Niggemann (redmine.org team member)
432 186 Jan Niggemann (redmine.org team member)
+Workaround:+
433 186 Jan Niggemann (redmine.org team member)
Replace @localhost@ with @127.0.0.1@ in database.yml.
434 186 Jan Niggemann (redmine.org team member)
435 283 Mischa The Evil
fn5. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
436 186 Jan Niggemann (redmine.org team member)
437 283 Mischa The Evil
fn6. http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx
438 186 Jan Niggemann (redmine.org team member)
439 283 Mischa The Evil
fn7. https://github.com/brianmario/mysql2/issues/279
440 80 Jean-Philippe Lang
441 80 Jean-Philippe Lang
h2. Alternative to manual installation
442 80 Jean-Philippe Lang
443 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.