RedmineInstall » History » Version 264

Go MAEDA, 2017-04-27 10:02
Removed database.yml example for MySQL using ruby 1.8 or jruby. Redmine no longer supports them.

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