RedmineInstall » History » Version 254

Toshi MARUYAMA, 2016-05-25 10:22
Redmine 2.6 reached its EOL

1 1 Jean-Philippe Lang
h1. Installing Redmine
2 1 Jean-Philippe Lang
3 1 Jean-Philippe Lang
{{>TOC}}
4 73 Liraz Siri
5 147 Jean-Philippe Lang
This is the installation documentation for Redmine 1.4.0 and higher. You can still read the document for 1.3.x "here":/projects/redmine/wiki/RedmineInstall?version=146.
6 147 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. Requirements
8 1 Jean-Philippe Lang
9 25 Jean-Philippe Lang
h3. Operating system
10 1 Jean-Philippe Lang
11 161 Etienne Massip
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|Mac]], [[RedmineInstallOSXServer|Mac Server]] and [[RedmineInstall#Notes-on-Windows-installation|Windows]] systems as long as Ruby is available on this platform.  See specific installation HowTos [[HowTos|here]].
12 25 Jean-Philippe Lang
13 163 Etienne Massip
h3. Ruby interpreter
14 25 Jean-Philippe Lang
15 163 Etienne Massip
The required Ruby versions for a given Redmine version is:
16 1 Jean-Philippe Lang
17 241 Toshi MARUYAMA
|_. Redmine version|_. Supported Ruby versions                                |_. Rails version used|
18 241 Toshi MARUYAMA
|current trunk     |ruby 1.9.3[3], 2.0.0[2], 2.1, 2.2[1]                      |Rails 4.2[0]      |
19 254 Toshi MARUYAMA
|3.2, 3.1          |ruby 1.9.3[3], 2.0.0[2], 2.1, 2.2[1]                      |Rails 4.2[0]      |
20 1 Jean-Philippe Lang
21 254 Toshi MARUYAMA
*Redmine does not support JRuby* because some gems do not support Rails 4.2.
22 247 Toshi MARUYAMA
** "activerecord-jdbc-adapter":https://github.com/jruby/activerecord-jdbc-adapter/issues/599
23 247 Toshi MARUYAMA
** "loofah":https://github.com/flavorjones/loofah/issues/88
24 246 Toshi MARUYAMA
25 251 Toshi MARUYAMA
fn0. Rails 4.2.2 (Redmine version:3.0.3) had non ASCII URL issue on MinGW Ruby ("Windows-based installer":http://rubyinstaller.org/) thin and puma (#19321, #19374). Rails 4.2.3 (Redmine version:3.0.4) fixed it.
26 1 Jean-Philippe Lang
27 253 Toshi MARUYAMA
fn1. MinGW Ruby 2.2 had Nokogiri issue (#19419) and it was fixed by "Nokogiri 1.6.7":https://github.com/sparklemotion/nokogiri/issues/1256#issuecomment-160514102 (2015-11-30).
28 237 Toshi MARUYAMA
29 237 Toshi MARUYAMA
fn2. At time of writing (3/19/2013), SQL Server support is reported broken with *ruby 2.0.0 under Windows* because of a "database adapter gem incompatibility":https://github.com/rails-sqlserver/tiny_tds/issues/110
30 222 Etienne Massip
31 239 Toshi MARUYAMA
fn3. MRI 1.9.3p327 contains "a bug":http://bugs.ruby-lang.org/issues/7374 breaking plugin loading under Windows which 1.9.3p194 or 1.9.3p392 haven't.
32 239 Toshi MARUYAMA
33 212 Etienne Massip
34 164 Etienne Massip
h3. Supported database back-ends
35 92 Knight Samar
36 217 Jean-Philippe Lang
* MySQL 5.0 or higher
37 35 Jean-Philippe Lang
38 195 Mischa The Evil
 * make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running @gem install mysql2@.
39 229 Jean-Philippe Lang
 * Redmine 2.x is not compatible with mysql 5.7.3 (#17460). Il will be supported by Redmine 3.
40 1 Jean-Philippe Lang
41 191 Etienne Massip
* PostgreSQL 8.2 or higher
42 117 Etienne Massip
43 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";@
44 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
45 1 Jean-Philippe Lang
46 233 Toshi MARUYAMA
* Microsoft SQL Server
47 233 Toshi MARUYAMA
48 233 Toshi MARUYAMA
 * Redmine 2.x: 2008 or higher (since Redmine 2.3.0)
49 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
50 192 Etienne Massip
51 192 Etienne Massip
* SQLite 3 (not for multi-user production use!)
52 190 Etienne Massip
53 1 Jean-Philippe Lang
h3. Optional components
54 1 Jean-Philippe Lang
55 1 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
56 215 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to PNG image and thumbnails generation).
57 193 Mischa The Evil
      * "Ruby OpenID Library":http://openidenabled.com/ruby-openid/ (to enable OpenID support). Version 2 or greater is required.
58 1 Jean-Philippe Lang
59 1 Jean-Philippe Lang
h2. Redmine Version
60 1 Jean-Philippe Lang
61 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.
62 1 Jean-Philippe Lang
63 114 Etienne Massip
h2. Installation procedure
64 35 Jean-Philippe Lang
65 165 Etienne Massip
h3. Step 1 - Redmine application
66 26 Jean-Philippe Lang
67 165 Etienne Massip
Get the Redmine source code by either downloading a packaged release or checking out the code repository.
68 1 Jean-Philippe Lang
69 174 Etienne Massip
See the [[Download|download page]] for details.
70 165 Etienne Massip
71 202 Jean-Philippe Lang
h3. Step 2 - Create an empty database and accompanying user
72 165 Etienne Massip
73 1 Jean-Philippe Lang
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
74 165 Etienne Massip
75 1 Jean-Philippe Lang
h4. MySQL
76 166 Etienne Massip
77 208 Etienne Massip
<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 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
81 208 Etienne Massip
</code></pre>
82 1 Jean-Philippe Lang
83 88 Sean Farrell
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
84 208 Etienne Massip
<pre><code class="sql">
85 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
86 208 Etienne Massip
</code></pre>
87 208 Etienne Massip
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 205 Etienne Massip
h4. SQL Server
97 205 Etienne Massip
98 205 Etienne Massip
The database, login and user can be created within ??SQL Server Management Studio?? with a few clicks.
99 205 Etienne Massip
100 205 Etienne Massip
If you prefer the command line option with @SQLCMD@, here's some basic example:
101 206 Etienne Massip
102 206 Etienne Massip
{{collapse(Show SQL,Hide SQL)
103 205 Etienne Massip
<pre><code class="sql">
104 205 Etienne Massip
USE [master]
105 205 Etienne Massip
GO
106 205 Etienne Massip
107 205 Etienne Massip
-- Very basic DB creation
108 205 Etienne Massip
CREATE DATABASE [REDMINE]
109 1 Jean-Philippe Lang
GO
110 1 Jean-Philippe Lang
111 206 Etienne Massip
-- Creation of a login with SQL Server login/password authentication and no password expiration policy
112 206 Etienne Massip
CREATE LOGIN [REDMINE] WITH PASSWORD=N'redminepassword', DEFAULT_DATABASE=[REDMINE], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF
113 205 Etienne Massip
GO
114 205 Etienne Massip
115 205 Etienne Massip
-- User creation using previously created login authentication
116 205 Etienne Massip
USE [REDMINE]
117 205 Etienne Massip
GO
118 205 Etienne Massip
CREATE USER [REDMINE] FOR LOGIN [REDMINE]
119 205 Etienne Massip
GO
120 205 Etienne Massip
-- User permissions set via roles
121 207 Etienne Massip
EXEC sp_addrolemember N'db_datareader', N'REDMINE'
122 205 Etienne Massip
GO
123 207 Etienne Massip
EXEC sp_addrolemember N'db_datawriter', N'REDMINE'
124 1 Jean-Philippe Lang
GO
125 205 Etienne Massip
</code></pre>
126 206 Etienne Massip
}}
127 166 Etienne Massip
128 202 Jean-Philippe Lang
h3. Step 3 - Database connection configuration
129 1 Jean-Philippe Lang
130 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.
131 165 Etienne Massip
132 209 Etienne Massip
Example for a MySQL database using ruby 1.8 or jruby:
133 88 Sean Farrell
134 209 Etienne Massip
<pre><code class="yml">
135 1 Jean-Philippe Lang
production:
136 1 Jean-Philippe Lang
  adapter: mysql
137 1 Jean-Philippe Lang
  database: redmine
138 1 Jean-Philippe Lang
  host: localhost
139 1 Jean-Philippe Lang
  username: redmine
140 1 Jean-Philippe Lang
  password: my_password
141 209 Etienne Massip
</code></pre>
142 1 Jean-Philippe Lang
143 209 Etienne Massip
Example for a MySQL database using ruby 1.9 (adapter must be set to @mysql2@):
144 1 Jean-Philippe Lang
145 209 Etienne Massip
<pre><code class="yml">
146 1 Jean-Philippe Lang
production:
147 1 Jean-Philippe Lang
  adapter: mysql2
148 1 Jean-Philippe Lang
  database: redmine
149 1 Jean-Philippe Lang
  host: localhost
150 1 Jean-Philippe Lang
  username: redmine
151 1 Jean-Philippe Lang
  password: my_password
152 209 Etienne Massip
</code></pre>
153 1 Jean-Philippe Lang
154 1 Jean-Philippe Lang
If your server is not running on the standard port (3306), use this configuration instead:
155 1 Jean-Philippe Lang
156 209 Etienne Massip
<pre><code class="yml">
157 1 Jean-Philippe Lang
production:
158 1 Jean-Philippe Lang
  adapter: mysql
159 1 Jean-Philippe Lang
  database: redmine
160 1 Jean-Philippe Lang
  host: localhost
161 1 Jean-Philippe Lang
  port: 3307
162 1 Jean-Philippe Lang
  username: redmine
163 1 Jean-Philippe Lang
  password: my_password
164 209 Etienne Massip
</code></pre>
165 1 Jean-Philippe Lang
166 1 Jean-Philippe Lang
Example for a PostgreSQL database (default port):
167 1 Jean-Philippe Lang
168 209 Etienne Massip
<pre><code class="yml">
169 1 Jean-Philippe Lang
production:
170 1 Jean-Philippe Lang
  adapter: postgresql
171 1 Jean-Philippe Lang
  database: <your_database_name>
172 1 Jean-Philippe Lang
  host: <postgres_host>
173 1 Jean-Philippe Lang
  username: <postgres_user>
174 1 Jean-Philippe Lang
  password: <postgres_user_password>
175 1 Jean-Philippe Lang
  encoding: utf8
176 1 Jean-Philippe Lang
  schema_search_path: <database_schema> (default - public)
177 209 Etienne Massip
</code></pre>
178 1 Jean-Philippe Lang
179 209 Etienne Massip
Example for a SQL Server database (default host @localhost@, default port @1433@):
180 209 Etienne Massip
<pre><code class="yml">
181 209 Etienne Massip
production:
182 209 Etienne Massip
  adapter: sqlserver
183 209 Etienne Massip
  database: redmine
184 209 Etienne Massip
  username: redmine # should match the database user name
185 209 Etienne Massip
  password: redminepassword # should match the login password
186 209 Etienne Massip
</code></pre>
187 202 Jean-Philippe Lang
188 202 Jean-Philippe Lang
h3. Step 4 - Dependencies installation
189 202 Jean-Philippe Lang
190 202 Jean-Philippe Lang
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
191 202 Jean-Philippe Lang
192 202 Jean-Philippe Lang
You need to install Bundler first:
193 202 Jean-Philippe Lang
194 202 Jean-Philippe Lang
  gem install bundler
195 202 Jean-Philippe Lang
196 202 Jean-Philippe Lang
Then you can install all the gems required by Redmine using the following command:
197 202 Jean-Philippe Lang
198 202 Jean-Philippe Lang
  bundle install --without development test
199 202 Jean-Philippe Lang
200 202 Jean-Philippe Lang
h4. Optional dependencies
201 202 Jean-Philippe Lang
202 202 Jean-Philippe Lang
h5. RMagick (allows the use of ImageMagick to manipulate images for PDF and PNG export)
203 202 Jean-Philippe Lang
204 202 Jean-Philippe Lang
If ImageMagick is not installed on your system, you should skip the installation of the rmagick gem using:
205 202 Jean-Philippe Lang
206 202 Jean-Philippe Lang
 @bundle install --without development test rmagick@
207 202 Jean-Philippe Lang
208 202 Jean-Philippe Lang
209 202 Jean-Philippe Lang
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
210 202 Jean-Philippe Lang
211 202 Jean-Philippe Lang
h5. Database adapters
212 202 Jean-Philippe Lang
213 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).
214 214 Etienne Massip
215 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!
216 202 Jean-Philippe Lang
217 202 Jean-Philippe Lang
h4. Additional dependencies (@Gemfile.local@)
218 202 Jean-Philippe Lang
219 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@.
220 202 Jean-Philippe Lang
221 202 Jean-Philippe Lang
Example:
222 202 Jean-Philippe Lang
<pre>
223 202 Jean-Philippe Lang
# Gemfile.local
224 202 Jean-Philippe Lang
gem 'puma'
225 1 Jean-Philippe Lang
</pre>
226 1 Jean-Philippe Lang
227 165 Etienne Massip
h3. Step 5 - Session store secret generation
228 1 Jean-Philippe Lang
229 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
230 165 Etienne Massip
Generating a new secret token invalidates all existing sessions after restart.
231 165 Etienne Massip
232 151 Jean-Philippe Lang
* with Redmine 1.4.x:
233 151 Jean-Philippe Lang
234 151 Jean-Philippe Lang
<pre>
235 234 Go MAEDA
bundle exec rake generate_session_store
236 1 Jean-Philippe Lang
</pre>
237 151 Jean-Philippe Lang
238 1 Jean-Philippe Lang
* with Redmine 2.x:
239 1 Jean-Philippe Lang
240 151 Jean-Philippe Lang
<pre>
241 234 Go MAEDA
bundle exec rake generate_secret_token
242 1 Jean-Philippe Lang
</pre>
243 90 Jiongliang Zhang
244 243 Toshi MARUYAMA
Alternatively, you can store this secret in config/secrets.yml:
245 243 Toshi MARUYAMA
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
246 243 Toshi MARUYAMA
247 165 Etienne Massip
h3. Step 6 - Database schema objects creation
248 90 Jiongliang Zhang
249 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
250 165 Etienne Massip
251 234 Go MAEDA
  RAILS_ENV=production bundle exec rake db:migrate
252 1 Jean-Philippe Lang
253 184 Etienne Massip
Windows syntax:
254 1 Jean-Philippe Lang
255 184 Etienne Massip
 set RAILS_ENV=production
256 234 Go MAEDA
bundle exec rake db:migrate
257 184 Etienne Massip
258 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@.
259 184 Etienne Massip
260 184 Etienne Massip
+Ubuntu troubleshooting:+
261 1 Jean-Philippe Lang
262 165 Etienne Massip
If you get this error with Ubuntu:
263 90 Jiongliang Zhang
<pre>
264 114 Etienne Massip
Rake aborted!
265 1 Jean-Philippe Lang
no such file to load -- net/https
266 1 Jean-Philippe Lang
</pre>
267 1 Jean-Philippe Lang
268 165 Etienne Massip
Then you need to install @libopenssl-ruby1.8@ just like this: @apt-get install libopenssl-ruby1.8@.
269 1 Jean-Philippe Lang
270 165 Etienne Massip
h3. Step 7 - Database default data set
271 1 Jean-Philippe Lang
272 165 Etienne Massip
Insert default configuration data in database, by running the following command:
273 165 Etienne Massip
274 234 Go MAEDA
  RAILS_ENV=production bundle exec rake redmine:load_default_data
275 62 Vladimir L
276 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.
277 171 Etienne Massip
278 171 Etienne Massip
E.g.:
279 171 Etienne Massip
280 171 Etienne Massip
Unices:
281 171 Etienne Massip
282 234 Go MAEDA
  RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data
283 171 Etienne Massip
284 171 Etienne Massip
Windows:
285 171 Etienne Massip
<pre>
286 171 Etienne Massip
set RAILS_ENV=production
287 171 Etienne Massip
set REDMINE_LANG=fr
288 234 Go MAEDA
bundle exec rake redmine:load_default_data
289 171 Etienne Massip
</pre>
290 32 Jean-Philippe Lang
291 167 Etienne Massip
h3. Step 8 - File system permissions
292 32 Jean-Philippe Lang
293 165 Etienne Massip
NB: _Windows users can skip this section._
294 14 Jean-Philippe Lang
295 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
296 1 Jean-Philippe Lang
297 165 Etienne Massip
# @files@ (storage of attachments)
298 165 Etienne Massip
# @log@ (application log file @production.log@)
299 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
300 220 Jean-Baptiste Barth
# @public/plugin_assets@ (assets of plugins)
301 221 Jean-Baptiste Barth
302 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
303 165 Etienne Massip
304 1 Jean-Philippe Lang
<pre>
305 219 Jean-Baptiste Barth
mkdir -p tmp tmp/pdf public/plugin_assets
306 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
307 1 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
308 1 Jean-Philippe Lang
</pre>
309 1 Jean-Philippe Lang
310 165 Etienne Massip
h3. Step 9 - Test the installation
311 1 Jean-Philippe Lang
312 165 Etienne Massip
Test the installation by running WEBrick web server:
313 165 Etienne Massip
314 1 Jean-Philippe Lang
* with Redmine 1.4.x:
315 1 Jean-Philippe Lang
316 151 Jean-Philippe Lang
<pre>
317 234 Go MAEDA
bundle exec ruby script/server webrick -e production
318 1 Jean-Philippe Lang
</pre>
319 1 Jean-Philippe Lang
320 151 Jean-Philippe Lang
* with Redmine 2.x:
321 151 Jean-Philippe Lang
322 151 Jean-Philippe Lang
<pre>
323 234 Go MAEDA
bundle exec ruby script/rails server webrick -e production
324 151 Jean-Philippe Lang
</pre>
325 151 Jean-Philippe Lang
326 244 Jan Niggemann (redmine.org team member)
* with Redmine 3.x:
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 11 Jean-Philippe Lang
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
403 11 Jean-Philippe Lang
404 11 Jean-Philippe Lang
<pre>
405 11 Jean-Philippe Lang
# Database
406 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
407 11 Jean-Philippe Lang
408 11 Jean-Philippe Lang
# Attachments
409 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
410 1 Jean-Philippe Lang
</pre>
411 69 Giuliano Simoncelli
412 216 Jean-Baptiste Barth
h2. Notes on Linux/Unix installation
413 216 Jean-Baptiste Barth
414 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.
415 216 Jean-Baptiste Barth
416 69 Giuliano Simoncelli
h2. Notes on Windows installation
417 69 Giuliano Simoncelli
418 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
419 156 Etienne Massip
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
420 1 Jean-Philippe Lang
421 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
422 69 Giuliano Simoncelli
423 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
424 1 Jean-Philippe Lang
425 156 Etienne Massip
I.e. commands with the following syntaxes:
426 69 Giuliano Simoncelli
427 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
428 69 Giuliano Simoncelli
429 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
430 1 Jean-Philippe Lang
431 156 Etienne Massip
have to be turned into 2 subsequent commands:
432 69 Giuliano Simoncelli
433 156 Etienne Massip
<pre>set RAILS_ENV=production
434 156 Etienne Massip
<any commmand></pre>
435 156 Etienne Massip
436 156 Etienne Massip
+MySQL gem installation issue:+
437 156 Etienne Massip
438 156 Etienne Massip
You may need to manually install the mysql gem using the following command:
439 156 Etienne Massip
440 69 Giuliano Simoncelli
<pre>
441 69 Giuliano Simoncelli
gem install mysql
442 69 Giuliano Simoncelli
</pre>
443 1 Jean-Philippe Lang
444 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
445 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.
446 156 Etienne Massip
447 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
448 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)@".
449 186 Jan Niggemann (redmine.org team member)
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
450 186 Jan Niggemann (redmine.org team member)
451 186 Jan Niggemann (redmine.org team member)
+Workaround:+
452 186 Jan Niggemann (redmine.org team member)
Replace @localhost@ with @127.0.0.1@ in database.yml.
453 186 Jan Niggemann (redmine.org team member)
454 186 Jan Niggemann (redmine.org team member)
fn1. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
455 186 Jan Niggemann (redmine.org team member)
456 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
457 186 Jan Niggemann (redmine.org team member)
458 186 Jan Niggemann (redmine.org team member)
fn3. https://github.com/brianmario/mysql2/issues/279
459 186 Jan Niggemann (redmine.org team member)
460 80 Jean-Philippe Lang
461 80 Jean-Philippe Lang
h2. Alternative to manual installation
462 80 Jean-Philippe Lang
463 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.