RedmineInstall » History » Version 269

Go MAEDA, 2017-05-07 15:51
Database adapter is installed by bunder. Users don't need to run `gem install mysql2`.

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