RedmineInstall » History » Version 270

Go MAEDA, 2017-05-07 16:09
Removed description for Redmine 1.4.x and 2.x.

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