RedmineInstall » History » Version 278

Toshi MARUYAMA, 2017-07-27 15:04
fix remaining Rails5 rails db:migrate

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