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