Project

General

Profile

RedmineInstall » History » Version 337

Mischa The Evil, 2023-12-20 04:11
Remaining Ruby 2.7 is EOL

1 1 Jean-Philippe Lang
h1. Installing Redmine
2
3
{{>TOC}}
4 73 Liraz Siri
5 310 Go MAEDA
This is the installation documentation for Redmine 4.0 and higher. You can still read the document for older versions: "3.x":/projects/redmine/wiki/RedmineInstall/308 , "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
9 25 Jean-Philippe Lang
h3. Operating system
10 1 Jean-Philippe Lang
11 301 Go MAEDA
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|macOS]] 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 334 Mischa The Evil
h3. Ruby interpreter and supported databases
14 1 Jean-Philippe Lang
15 334 Mischa The Evil
The required Ruby versions and supported database back-ends for a given Redmine version are:
16 318 Mischa The Evil
17 336 Mischa The Evil
|_/2-. Redmine version|_/2-. Supported Ruby versions           |_/2-. Rails version used |_\4=. Recommended Databases                           | 
18
                                                                                         |*PostgreSQL*    |*MySQL*       |*MSSQL*    | *SQLite* | 
19
|trunk (>= r22488)    |Ruby 2.7[1], 3.0, 3.1, 3.2              |Rails 7.1                |14              |8.0 - 8.1[3]  |>2012      | 3        |
20
|5.1                  |Ruby 2.7[1], 3.0, 3.1, 3.2              |Rails 6.1                |>9.2[5]         |5.7 - 8.1[3]  |>2012      | 3        |
21
|5.0                  |Ruby 2.5[1], 2.6[1], 2.7[1], 3.0, 3.1   |Rails 6.1                |>9.2[5]         |5.7 - 5.7[4]  |>2012      | 3        |
22
|4.2                  |Ruby 2.4[1], 2.5[1], 2.6[1], 2.7[2]     |Rails 5.2                |>9.2[5]         |5.5 - 5.7[4]  |>2012      | 3        |
23 1 Jean-Philippe Lang
24 337 Mischa The Evil
fn1. %{color: red}Support of Ruby 2.7 and earlier has been ended by the Ruby community.% See the official announcements for details: "2.3":https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/, "2.4":https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/, "2.5":https://www.ruby-lang.org/en/news/2021/04/05/ruby-2-5-9-released/, "2.6":https://www.ruby-lang.org/en/news/2022/04/12/ruby-2-6-10-released/, "2.7":https://www.ruby-lang.org/en/news/2023/03/30/ruby-2-7-8-released/.
25 313 Go MAEDA
26 320 Go MAEDA
fn2. Redmine 4.2 does not support Ruby 2.7.0 and 2.7.1. Use Ruby 2.7.2 or higher (see #31500#note-13).
27 294 Go MAEDA
28 330 Marius BĂLTEANU
fn3. Redmine >= version:"5.1.1" *MySQL* requires to change the @transaction_isolation@ to @READ COMMITTED@ in order to properly work [[MySQL_configuration]]. 
29 306 Go MAEDA
30 329 Marius BĂLTEANU
fn4. On Redmine < version:"5.1.1" *MySQL 5.6 or higher* and *MariaDB* have known issues (#19344, #19395, #17460)
31 164 Etienne Massip
32 333 Holger Just
fn5. PostgreSQL 9.2 or higher required. 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";@
33 303 Go MAEDA
34 289 Go MAEDA
35 329 Marius BĂLTEANU
Important notices:
36 1 Jean-Philippe Lang
37 329 Marius BĂLTEANU
* *Redmine does not support JRuby* because "activerecord-jdbc-adapter":https://github.com/jruby/activerecord-jdbc-adapter/issues/599 and "loofah":https://github.com/flavorjones/loofah/issues/88 do not support Rails 4.2 or later.
38
 
39 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
40 192 Etienne Massip
41 311 Go MAEDA
 * Redmine 4.0.0 to 4.0.6 and 4.1.0 don't support SQL Server (#30285, #32737).
42 304 Go MAEDA
43 192 Etienne Massip
* SQLite 3 (not for multi-user production use!)
44 190 Etienne Massip
45 1 Jean-Philippe Lang
h3. Optional components
46
47
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
48 215 Etienne Massip
      * "ImageMagick":http://www.imagemagick.org/ (to enable Gantt export to PNG image and thumbnails generation).
49 309 Go MAEDA
      * "Ghostscript":https://www.ghostscript.com/ (to enable thumbnails generation for PDF attachments in Redmine 4.1 or later).
50 1 Jean-Philippe Lang
51
h2. Redmine Version
52
53
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.
54
55 114 Etienne Massip
h2. Installation procedure
56 35 Jean-Philippe Lang
57 165 Etienne Massip
h3. Step 1 - Redmine application
58 26 Jean-Philippe Lang
59 319 Bernhard Rohloff
Download a released package and extract it to an appropriate destination on your system.
60
As an alternative one can checkout the files directly from the version control system.
61 1 Jean-Philippe Lang
62 319 Bernhard Rohloff
Please visit the [[Download|download page]] for further information on how to download Redmine.
63 165 Etienne Massip
64 202 Jean-Philippe Lang
h3. Step 2 - Create an empty database and accompanying user
65 165 Etienne Massip
66 1 Jean-Philippe Lang
Redmine database user will be named @redmine@ hereafter but it can be changed to anything else.
67 165 Etienne Massip
68 1 Jean-Philippe Lang
h4. MySQL
69 166 Etienne Massip
70 1 Jean-Philippe Lang
<pre><code class="sql">
71 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8mb4;
72
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
73
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
74
</code></pre>
75
76
For versions of MySQL "5.5.2":https://dev.mysql.com/doc/relnotes/mysql/5.5/en/news-5-5-3.html or lower - use *utf8* instead of "utf8mb4":https://dev.mysql.com/doc/refman/5.5/en/charset-unicode-utf8mb4.html
77
78
<pre><code class="sql">
79 208 Etienne Massip
CREATE DATABASE redmine CHARACTER SET utf8;
80
CREATE USER 'redmine'@'localhost' IDENTIFIED BY 'my_password';
81 1 Jean-Philippe Lang
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost';
82
</code></pre>
83 281 Go MAEDA
84 287 Toshi MARUYAMA
For versions of MySQL "5.0.2":https://docs.oracle.com/cd/E17952_01/mysql-5.0-en/grant.html or lower - skip the 'CREATE USER' step and instead:
85 208 Etienne Massip
<pre><code class="sql">
86 287 Toshi MARUYAMA
CREATE DATABASE redmine CHARACTER SET utf8;
87 208 Etienne Massip
GRANT ALL PRIVILEGES ON redmine.* TO 'redmine'@'localhost' IDENTIFIED BY 'my_password';
88
</code></pre>
89 1 Jean-Philippe Lang
90
h4. PostgreSQL
91 166 Etienne Massip
92 205 Etienne Massip
<pre><code class="sql">
93 1 Jean-Philippe Lang
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
94
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
95 205 Etienne Massip
</code></pre>
96
97 296 Go MAEDA
h4. SQLite
98
99
Skip this step. A database file will be created during [[RedmineInstall#Step-6-Database-schema-objects-creation|Step 6]].
100
101 205 Etienne Massip
h4. SQL Server
102
103
The database, login and user can be created within ??SQL Server Management Studio?? with a few clicks.
104
105
If you prefer the command line option with @SQLCMD@, here's some basic example:
106 206 Etienne Massip
107
{{collapse(Show SQL,Hide SQL)
108 205 Etienne Massip
<pre><code class="sql">
109
USE [master]
110
GO
111
112
-- Very basic DB creation
113
CREATE DATABASE [REDMINE]
114 1 Jean-Philippe Lang
GO
115
116 206 Etienne Massip
-- Creation of a login with SQL Server login/password authentication and no password expiration policy
117
CREATE LOGIN [REDMINE] WITH PASSWORD=N'redminepassword', DEFAULT_DATABASE=[REDMINE], CHECK_EXPIRATION=OFF, CHECK_POLICY=OFF
118 205 Etienne Massip
GO
119
120
-- User creation using previously created login authentication
121
USE [REDMINE]
122
GO
123
CREATE USER [REDMINE] FOR LOGIN [REDMINE]
124
GO
125
-- 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 332 Marius BĂLTEANU
Copy @config/database.yml.example@ to @config/database.yml@ and edit this file in order to configure your database settings for "production" environment. For MySQL, please read this guide as well [[MySQL_configuration]].
136
137 165 Etienne Massip
138 264 Go MAEDA
Example for a MySQL database (default port):
139 88 Sean Farrell
140 209 Etienne Massip
<pre><code class="yml">
141 1 Jean-Philippe Lang
production:
142
  adapter: mysql2
143
  database: redmine
144
  host: localhost
145
  username: redmine
146 295 Go MAEDA
  password: "my_password"
147 331 Marius BĂLTEANU
  variables:
148
    transaction_isolation: "READ-COMMITTED" 
149 1 Jean-Philippe Lang
</code></pre>
150 209 Etienne Massip
151 1 Jean-Philippe Lang
If your server is not running on the standard port (3306), use this configuration instead:
152
153
<pre><code class="yml">
154
production:
155 264 Go MAEDA
  adapter: mysql2
156 1 Jean-Philippe Lang
  database: redmine
157
  host: localhost
158
  port: 3307
159
  username: redmine
160 295 Go MAEDA
  password: "my_password"
161 331 Marius BĂLTEANU
  variables:
162
    transaction_isolation: "READ-COMMITTED" 
163 209 Etienne Massip
</code></pre>
164 1 Jean-Philippe Lang
165
Example for a PostgreSQL database (default port):
166
167 209 Etienne Massip
<pre><code class="yml">
168 1 Jean-Philippe Lang
production:
169
  adapter: postgresql
170
  database: <your_database_name>
171
  host: <postgres_host>
172
  username: <postgres_user>
173 295 Go MAEDA
  password: "<postgres_user_password>"
174 1 Jean-Philippe Lang
  encoding: utf8
175
  schema_search_path: <database_schema> (default - public)
176 296 Go MAEDA
</code></pre>
177
178
Example for a SQLite database:
179
180
<pre><code class="yml">
181
production:
182
  adapter: sqlite3
183
  database: db/redmine.sqlite3
184 209 Etienne Massip
</code></pre>
185 1 Jean-Philippe Lang
186 209 Etienne Massip
Example for a SQL Server database (default host @localhost@, default port @1433@):
187
<pre><code class="yml">
188
production:
189
  adapter: sqlserver
190
  database: redmine
191 1 Jean-Philippe Lang
  username: redmine # should match the database user name
192 209 Etienne Massip
  password: "redminepassword" # should match the login password
193 295 Go MAEDA
</code></pre>
194 209 Etienne Massip
195 202 Jean-Philippe Lang
h3. Step 4 - Dependencies installation
196
197
Redmine uses "Bundler":http://gembundler.com/ to manage gems dependencies.
198
199 310 Go MAEDA
You need to install Bundler first if you use Ruby 2.5 or earlier:
200 1 Jean-Philippe Lang
201 323 Holger Just
<pre>
202
gem install bundler
203
</pre>
204 1 Jean-Philippe Lang
205
Then you can install all the gems required by Redmine using the following command:
206
207 323 Holger Just
<pre>
208
bundle config set --local without 'development test' 
209
bundle install
210
</pre>
211 202 Jean-Philippe Lang
212
h4. Optional dependencies
213
214 310 Go MAEDA
h5. RMagick
215
216 1 Jean-Philippe Lang
RMagick is an interface between the Ruby programming language and the ImageMagick image processing library. The library is necessary for Redmine prior to 4.1.0 to export gantt charts to PNG or PDF.
217
218
If ImageMagick (6.4.9 - 6.9.10) is not installed on your system and you are installing Redmine 4.0 or earlier, you should skip the installation of the rmagick gem using:
219
220 323 Holger Just
<pre>
221
bundle config set --local without 'development test rmagick' 
222
bundle install
223
</pre>
224 202 Jean-Philippe Lang
225
If you have trouble installing @rmagick@ on Windows, refer to [[HowTo_install_rmagick_gem_on_Windows|this HowTo]].
226
227
h5. Database adapters
228
229 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).
230
231
Don't forget to re-run @bundle install --without development test ...@ after adding or removing adapters in the @config/database.yml@ file!
232 202 Jean-Philippe Lang
233
h4. Additional dependencies (@Gemfile.local@)
234
235
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@.
236
237
Example:
238
<pre>
239
# Gemfile.local
240
gem 'puma'
241 1 Jean-Philippe Lang
</pre>
242
243 165 Etienne Massip
h3. Step 5 - Session store secret generation
244 1 Jean-Philippe Lang
245 165 Etienne Massip
This step generates a random key used by Rails to encode cookies storing session data thus preventing their tampering.
246 151 Jean-Philippe Lang
Generating a new secret token invalidates all existing sessions after restart.
247 1 Jean-Philippe Lang
248 151 Jean-Philippe Lang
<pre>
249 234 Go MAEDA
bundle exec rake generate_secret_token
250 1 Jean-Philippe Lang
</pre>
251 90 Jiongliang Zhang
252 243 Toshi MARUYAMA
Alternatively, you can store this secret in config/secrets.yml:
253
http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
254
255 165 Etienne Massip
h3. Step 6 - Database schema objects creation
256 90 Jiongliang Zhang
257 165 Etienne Massip
Create the database structure, by running the following command under the application root directory:
258
259 271 Toshi MARUYAMA
<pre>
260 278 Toshi MARUYAMA
RAILS_ENV=production bundle exec rake db:migrate
261 271 Toshi MARUYAMA
</pre>
262
263
*Windows syntax:*
264
265
<pre>
266
set RAILS_ENV=production
267 184 Etienne Massip
bundle exec rake db:migrate
268 271 Toshi MARUYAMA
</pre>
269 184 Etienne Massip
270
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@.
271
272 165 Etienne Massip
h3. Step 7 - Database default data set
273 1 Jean-Philippe Lang
274 165 Etienne Massip
Insert default configuration data in database, by running the following command:
275
276 234 Go MAEDA
  RAILS_ENV=production bundle exec rake redmine:load_default_data
277 62 Vladimir L
278 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.
279
280
E.g.:
281
282
Unices:
283
284 234 Go MAEDA
  RAILS_ENV=production REDMINE_LANG=fr bundle exec rake redmine:load_default_data
285 171 Etienne Massip
286
Windows:
287
<pre>
288
set RAILS_ENV=production
289
set REDMINE_LANG=fr
290 234 Go MAEDA
bundle exec rake redmine:load_default_data
291 171 Etienne Massip
</pre>
292 32 Jean-Philippe Lang
293 167 Etienne Massip
h3. Step 8 - File system permissions
294 32 Jean-Philippe Lang
295 165 Etienne Massip
NB: _Windows users can skip this section._
296 14 Jean-Philippe Lang
297 165 Etienne Massip
The user account running the application must have write permission on the following subdirectories:
298 1 Jean-Philippe Lang
299 165 Etienne Massip
# @files@ (storage of attachments)
300
# @log@ (application log file @production.log@)
301 167 Etienne Massip
# @tmp@ and @tmp/pdf@ (create these ones if not present, used to generate PDF documents among other things)
302 220 Jean-Baptiste Barth
# @public/plugin_assets@ (assets of plugins)
303 221 Jean-Baptiste Barth
304 167 Etienne Massip
E.g., assuming you run the application with a redmine user account:
305 165 Etienne Massip
306 1 Jean-Philippe Lang
<pre>
307 219 Jean-Baptiste Barth
mkdir -p tmp tmp/pdf public/plugin_assets
308 1 Jean-Philippe Lang
sudo chown -R redmine:redmine files log tmp public/plugin_assets
309
sudo chmod -R 755 files log tmp public/plugin_assets
310
</pre>
311
312 284 Toshi MARUYAMA
Note: If you have files in these directories (e.g. restore files from backup), make sure these files are not executable.
313
314
<pre>
315
sudo find files log tmp public/plugin_assets -type f -exec chmod -x {} +
316
</pre>
317
318 165 Etienne Massip
h3. Step 9 - Test the installation
319 151 Jean-Philippe Lang
320 328 Marius BĂLTEANU
Test the installation by running Puma web server:
321 244 Jan Niggemann (redmine.org team member)
322
<pre>
323 328 Marius BĂLTEANU
bundle exec rails server -e production
324 165 Etienne Massip
</pre>
325 14 Jean-Philippe Lang
326 165 Etienne Massip
h3. Step 10 - Logging into the application
327 158 Etienne Massip
328 165 Etienne Massip
Use default administrator account to log in:
329
330 1 Jean-Philippe Lang
    * login: admin
331
    * password: admin
332 14 Jean-Philippe Lang
333 165 Etienne Massip
You can go to ??Administration?? menu and choose ??Settings?? to modify most of the application settings.
334
335 130 Etienne Massip
h2. Configuration
336 1 Jean-Philippe Lang
337 185 Etienne Massip
Redmine settings are defined in a file named @config/configuration.yml@.
338 1 Jean-Philippe Lang
339 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.
340 1 Jean-Philippe Lang
341 185 Etienne Massip
These settings may be defined per Rails environment (@production@/@development@/@test@).
342 131 Etienne Massip
343
+Important+ : don't forget to restart the application after any change.
344
345 130 Etienne Massip
h3. Email / SMTP server settings
346
347 132 Etienne Massip
Email configuration is described in a [[EmailConfiguration|dedicated page]].
348 1 Jean-Philippe Lang
349
h3. SCM settings
350
351 133 Etienne Massip
This configuration section allows you to:
352 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)
353
* specify the full path to the binary
354
355 133 Etienne Massip
Examples (with Subversion):
356 131 Etienne Massip
357 133 Etienne Massip
Command name override:
358 131 Etienne Massip
359
 scm_subversion_command: "svn_replacement.exe"
360
361 133 Etienne Massip
Absolute path:
362 1 Jean-Philippe Lang
363
 scm_subversion_command: "C:\Program Files\Subversion\bin\svn.exe"
364
365
h3. Attachment storage settings
366
367 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.
368
369
Examples:
370
371
 attachments_storage_path: /var/redmine/files
372
373
 attachments_storage_path: D:/redmine/files
374 130 Etienne Massip
375
h2. Logging configuration
376
377 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.
378 21 Jean-Philippe Lang
379
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@.
380 123 Jean-Philippe Lang
<pre><code class="ruby">
381 21 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
382 162 Jean-Philippe Lang
config.logger = Logger.new('/path/to/logfile.log', 2, 1000000)
383 11 Jean-Philippe Lang
config.logger.level = Logger::INFO
384
</code></pre>
385
386
h2. Backups
387
388
Redmine backups should include:
389
* data (stored in your redmine database)
390
* attachments (stored in the @files@ directory of your Redmine install)
391
392 288 Go MAEDA
Please refer to [[RedmineBackupAndRestore|Backing up and restoring Redmine]] for more details.
393 69 Giuliano Simoncelli
394 216 Jean-Baptiste Barth
h2. Notes on Linux/Unix installation
395
396
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.
397
398 69 Giuliano Simoncelli
h2. Notes on Windows installation
399
400 156 Etienne Massip
There is an prebuilt installer of Ruby MRI available from http://rubyinstaller.org.
401
After installing it, select _Start Command Prompt with Ruby_ in the start menu.
402 1 Jean-Philippe Lang
403 156 Etienne Massip
+Specifying the @RAILS_ENV@ environment variable:+
404 69 Giuliano Simoncelli
405 156 Etienne Massip
When running command as described in this guide, you have to set the @RAILS_ENV@ environment variable using a separate command.
406 1 Jean-Philippe Lang
407 156 Etienne Massip
I.e. commands with the following syntaxes:
408 69 Giuliano Simoncelli
409 156 Etienne Massip
<pre>RAILS_ENV=production <any commmand></pre>
410 69 Giuliano Simoncelli
411 156 Etienne Massip
<pre><any commmand> RAILS_ENV=production</pre>
412 1 Jean-Philippe Lang
413 156 Etienne Massip
have to be turned into 2 subsequent commands:
414 69 Giuliano Simoncelli
415 156 Etienne Massip
<pre>set RAILS_ENV=production
416
<any commmand></pre>
417
418
+MySQL gem installation issue:+
419
420
You may need to manually install the mysql gem using the following command:
421
422 69 Giuliano Simoncelli
<pre>
423
gem install mysql
424
</pre>
425 1 Jean-Philippe Lang
426 156 Etienne Massip
And in some case it is required to copy the _libmysql.dll_ file in your ruby/bin directory.
427
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll.
428
429 186 Jan Niggemann (redmine.org team member)
*Important note for Win7 and later*
430 283 Mischa The Evil
On Win7 and later, @localhost@ is commented out in the hosts file[5] and IPV6 is the default[6]. As the mysql2 gem does no support IPV6 addresses[7], a connection can't be established and you get the error "@Can't connect to MySQL server on 'localhost' (10061)@".
431 186 Jan Niggemann (redmine.org team member)
You can confirm this by pinging @localhost@, if ping targets "::1:" IPV6 is being used.
432
433
+Workaround:+
434
Replace @localhost@ with @127.0.0.1@ in database.yml.
435
436 283 Mischa The Evil
fn5. http://serverfault.com/questions/4689/windows-7-localhost-name-resolution-is-handled-within-dns-itself-why
437 186 Jan Niggemann (redmine.org team member)
438 283 Mischa The Evil
fn6. http://www.victor-ratajczyk.com/post/2012/02/25/mysql-fails-to-resolve-localhost-disable-ipv6-on-windows.aspx
439 186 Jan Niggemann (redmine.org team member)
440 283 Mischa The Evil
fn7. https://github.com/brianmario/mysql2/issues/279
441 80 Jean-Philippe Lang
442
h2. Alternative to manual installation
443
444
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.