RedmineSettings » History » Version 56

Go MAEDA, 2017-12-17 07:16

1 1 Jean-Philippe Lang
h1. Application Settings
2 1 Jean-Philippe Lang
3 3 Jean-Philippe Lang
{{>TOC}}
4 1 Jean-Philippe Lang
5 3 Jean-Philippe Lang
h2. General settings
6 3 Jean-Philippe Lang
7 3 Jean-Philippe Lang
h3. Application title
8 3 Jean-Philippe Lang
9 17 Thomas Lecavelier
Title which appears in heading of the application. This is the link just under the little bar with « Home/My page/Projects/Help» when you're logged in.
10 1 Jean-Philippe Lang
11 3 Jean-Philippe Lang
h3. Welcome text
12 1 Jean-Philippe Lang
13 17 Thomas Lecavelier
Text displayed on the home page of Redmine. This text can contain HTML tags.
14 1 Jean-Philippe Lang
15 22 Jean-Philippe Lang
16 22 Jean-Philippe Lang
h3. Objects per page options
17 22 Jean-Philippe Lang
18 22 Jean-Philippe Lang
Here you can configure the fixed values which users can select for the amount of objects (issues, commits etc.) which are displayed per page.
19 1 Jean-Philippe Lang
20 1 Jean-Philippe Lang
_Default: 25, 50, 100_
21 1 Jean-Philippe Lang
22 50 Go MAEDA
h3. Search results per page
23 50 Go MAEDA
24 51 Go MAEDA
The number of [[RedmineSearch|search]] results which are displayed per page.
25 51 Go MAEDA
26 51 Go MAEDA
_Default: 20_
27 50 Go MAEDA
28 22 Jean-Philippe Lang
h3. Days displayed on project activity
29 22 Jean-Philippe Lang
30 1 Jean-Philippe Lang
The initial (and recurring while browsing) amount of days of which the project(s)-activity is shown in the [[RedmineProjectActivity|activity]]-tab.
31 22 Jean-Philippe Lang
32 23 Jean-Philippe Lang
h3. Host name and path
33 22 Jean-Philippe Lang
34 50 Go MAEDA
Host name and path of your Redmine server. This name is used to write URL in emails sent to users. i.e.: the hostname of this precise Redmine is redmine.org.
35 22 Jean-Philippe Lang
36 22 Jean-Philippe Lang
h3. Protocol
37 22 Jean-Philippe Lang
38 22 Jean-Philippe Lang
Protocol used to generate links in email notifications. _Default: http_
39 22 Jean-Philippe Lang
40 22 Jean-Philippe Lang
Links in email are "guessed", but can't determine whether you're using an unsecure web server (http) or a secure one (https -> http over SSL).
41 22 Jean-Philippe Lang
42 22 Jean-Philippe Lang
h3. Text formatting
43 1 Jean-Philippe Lang
44 22 Jean-Philippe Lang
Formatting method applied to the "description" fields of the issues, news, documents...
45 22 Jean-Philippe Lang
46 24 Jean-Philippe Lang
h3. Cache formatted text (1.0)
47 24 Jean-Philippe Lang
48 50 Go MAEDA
Text formatting transforms raw text to HTML and runs each time a formatted text is sent to a user's browser (eg. issue description, wiki page...), and this process can be slow with large pages or texts.
49 24 Jean-Philippe Lang
50 43 Ben Blanco
This setting lets you enable caching of formatted text.
51 1 Jean-Philippe Lang
52 43 Ben Blanco
In order to use this feature you also need to specify a cache store, such as @config.action_controller.cache_store = :memory_store@, which you configure by adding this setting to your @config/environments/production.rb@, for example:
53 43 Ben Blanco
54 43 Ben Blanco
<pre>
55 45 Ben Blanco
# config/environments/production.rb
56 45 Ben Blanco
57 45 Ben Blanco
  ...
58 45 Ben Blanco
59 43 Ben Blanco
  config.consider_all_requests_local = false
60 43 Ben Blanco
  config.action_controller.perform_caching = true
61 43 Ben Blanco
62 44 Ben Blanco
  # Specify which cache store redmine should use:
63 44 Ben Blanco
64 43 Ben Blanco
  config.action_controller.cache_store = :memory_store
65 43 Ben Blanco
</pre>
66 43 Ben Blanco
67 43 Ben Blanco
By default, this cache store is "MemoryStore":http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html.
68 43 Ben Blanco
69 43 Ben Blanco
If RAM memory usage on your server is a concern, it's highly recommended that you configure the cache to use another cache store like MemCacheStore or FileStore.
70 24 Jean-Philippe Lang
71 24 Jean-Philippe Lang
You can read more about cache stores in the Rails guides:
72 1 Jean-Philippe Lang
http://guides.rubyonrails.org/caching_with_rails.html#cache-stores
73 24 Jean-Philippe Lang
74 22 Jean-Philippe Lang
h3. Wiki history compression
75 22 Jean-Philippe Lang
76 1 Jean-Philippe Lang
Lets you activate compression for wiki history storage (reduces database size). _Default: disabled_
77 23 Jean-Philippe Lang
78 50 Go MAEDA
h3. Maximum number of items in Atom feeds
79 22 Jean-Philippe Lang
80 22 Jean-Philippe Lang
Maximum number of records contained in RSS feeds. _Default: 15_
81 23 Jean-Philippe Lang
82 22 Jean-Philippe Lang
83 22 Jean-Philippe Lang
h2. Display
84 22 Jean-Philippe Lang
85 18 Mischa The Evil
h3. Theme
86 18 Mischa The Evil
87 18 Mischa The Evil
This option lets you choose a custom theme.
88 18 Mischa The Evil
Redmine is shipped with two additional themes besides the [[ThemeDefault|default]] theme:
89 1 Jean-Philippe Lang
* [[ThemeAlternate|alternate]], which mainly provides issue list colorization based on issues priority.
90 1 Jean-Philippe Lang
* [[ThemeClassic|classic]], which is derived from the Redmine 0.5.1 design and brings a _classic_ look.
91 1 Jean-Philippe Lang
92 1 Jean-Philippe Lang
Screenshot of the [[ThemeAlternate|alternate]] theme:
93 1 Jean-Philippe Lang
94 1 Jean-Philippe Lang
!alternate_theme.png!
95 1 Jean-Philippe Lang
96 1 Jean-Philippe Lang
Themes are located in @public/themes/@. You can read more about [[Themes]].
97 1 Jean-Philippe Lang
98 1 Jean-Philippe Lang
h3. Default language
99 1 Jean-Philippe Lang
100 1 Jean-Philippe Lang
The default language is selected when the application could not determine the user's browser language. The default language is also used when sending email to multiple users. _Default: English_
101 1 Jean-Philippe Lang
102 50 Go MAEDA
h3. Force default language for anonymous users
103 50 Go MAEDA
104 52 Go MAEDA
Disables automatic language detection based on browser setting and force [[RedmineSettings#Default-language|default language]] for anonymous users.
105 50 Go MAEDA
106 50 Go MAEDA
h3. Force default language for logged-in users
107 50 Go MAEDA
108 53 Go MAEDA
Disables "Language" setting on [[RedmineAccounts#My-account|My account]] page and force [[RedmineSettings#Default-language|default language]]  for logged-in users.
109 50 Go MAEDA
110 50 Go MAEDA
h3. Start calendars on
111 50 Go MAEDA
112 50 Go MAEDA
(WIP)
113 50 Go MAEDA
114 1 Jean-Philippe Lang
h3. Date format
115 1 Jean-Philippe Lang
116 18 Mischa The Evil
Lets you choose how dates are displayed:
117 18 Mischa The Evil
118 1 Jean-Philippe Lang
  * *Based on user's language*: dates will be displayed specifically for each user, according to the format defined for its language
119 1 Jean-Philippe Lang
  * *Other formats*: dates will always be displayed using the specified format
120 1 Jean-Philippe Lang
121 1 Jean-Philippe Lang
_Default: Based on user's language_
122 1 Jean-Philippe Lang
123 1 Jean-Philippe Lang
h3. Time format
124 10 Jean-Philippe Lang
125 17 Thomas Lecavelier
Lets you choose how times are displayed:
126 17 Thomas Lecavelier
127 1 Jean-Philippe Lang
  * *Based on user's language*: times will be displayed specifically for each user, according to the format defined for its language
128 3 Jean-Philippe Lang
  * *Other formats*: times will always be displayed using the specified format
129 1 Jean-Philippe Lang
130 1 Jean-Philippe Lang
_Default: Based on user's language_
131 1 Jean-Philippe Lang
132 50 Go MAEDA
h3. Time span format
133 50 Go MAEDA
134 54 Go MAEDA
Let you choose the display format of timespans (estimated time, spent time, etc).
135 54 Go MAEDA
136 55 Go MAEDA
* *0.75* _(default)_ : Displays in decimal.
137 54 Go MAEDA
* *0:45 h* : Displays in "HH:MM" format.
138 50 Go MAEDA
139 1 Jean-Philippe Lang
h3. Users display format
140 1 Jean-Philippe Lang
141 1 Jean-Philippe Lang
Lets you choose how usernames are displayed. The following combinations are provided:
142 1 Jean-Philippe Lang
143 1 Jean-Philippe Lang
  * _Firstname_
144 1 Jean-Philippe Lang
  * _Firstname Surname_
145 1 Jean-Philippe Lang
  * _Surname Firstname_
146 1 Jean-Philippe Lang
  * _Surname, Firstname_
147 1 Jean-Philippe Lang
  * _Username_
148 1 Jean-Philippe Lang
149 1 Jean-Philippe Lang
h3. Use Gravatar user icons
150 1 Jean-Philippe Lang
151 1 Jean-Philippe Lang
If enabled, users "Gravatars":http://en.gravatar.com/ (globally recognized avatar) will be displayed in several places.
152 1 Jean-Philippe Lang
153 1 Jean-Philippe Lang
h3. Default Gravatar image
154 1 Jean-Philippe Lang
155 1 Jean-Philippe Lang
The image to use for users who don't have a Gravatar.
156 1 Jean-Philippe Lang
157 50 Go MAEDA
h3. Display attachment thumbnails
158 50 Go MAEDA
159 56 Go MAEDA
If enabled, thumbnails of attached images are displayed below the list of attached files.
160 50 Go MAEDA
161 50 Go MAEDA
h3. Thumbnails size
162 50 Go MAEDA
163 50 Go MAEDA
(WIP)
164 50 Go MAEDA
165 50 Go MAEDA
h3. Project menu tab for creating new objects
166 50 Go MAEDA
167 50 Go MAEDA
(WIP)
168 50 Go MAEDA
169 12 Jean-Philippe Lang
h2. Authentication
170 12 Jean-Philippe Lang
171 12 Jean-Philippe Lang
h3. Authentication required
172 12 Jean-Philippe Lang
173 41 Mischa The Evil
If this option is checked, no page of the application is accessible to anonymous users. Users must sign in to access the application. _Default: No_
174 12 Jean-Philippe Lang
175 1 Jean-Philippe Lang
h3. Autologin
176 1 Jean-Philippe Lang
177 1 Jean-Philippe Lang
This option let users use the auto-login feature. _Default: Disabled_
178 1 Jean-Philippe Lang
179 1 Jean-Philippe Lang
h3. Self-registration
180 1 Jean-Philippe Lang
181 1 Jean-Philippe Lang
This option lets you enable/disable new users self registration:
182 1 Jean-Philippe Lang
183 12 Jean-Philippe Lang
* *disabled*: users are not allowed to register
184 12 Jean-Philippe Lang
* *account activation by email*: new users receive an email containing a link used to activate their accounts (users must provide a valid email address).
185 12 Jean-Philippe Lang
* *manual account activation* _(default)_: new users' accounts are created but need administrator approval. Administrators receive an email informing them that an account is pending their approval.
186 12 Jean-Philippe Lang
* *automatic account activation*: new users can log in as soon as they have registered.
187 12 Jean-Philippe Lang
188 50 Go MAEDA
h3. Show custom fields on registration
189 50 Go MAEDA
190 50 Go MAEDA
(WIP)
191 50 Go MAEDA
192 50 Go MAEDA
h3. Allow users to delete their own account
193 50 Go MAEDA
194 50 Go MAEDA
(WIP)
195 50 Go MAEDA
196 25 Michael Bishop
h3. Minimum password length
197 1 Jean-Philippe Lang
198 1 Jean-Philippe Lang
Let's the admin decide on the minimum length of the chosen passwords.
199 1 Jean-Philippe Lang
200 1 Jean-Philippe Lang
_Default: 8_
201 1 Jean-Philippe Lang
202 50 Go MAEDA
h3. Require password change after
203 50 Go MAEDA
204 50 Go MAEDA
(WIP)
205 50 Go MAEDA
206 35 Mischa The Evil
h3. Lost password
207 18 Mischa The Evil
208 34 Mischa The Evil
If this option is checked, [[RedmineAccounts#Password-lost|lost password functionality]] is available. _Default: Yes_
209 1 Jean-Philippe Lang
210 50 Go MAEDA
h3. Maximum number of additional email addresses
211 50 Go MAEDA
212 50 Go MAEDA
(WIP)
213 50 Go MAEDA
214 1 Jean-Philippe Lang
h3. Allow OpenID login and registration
215 1 Jean-Philippe Lang
216 1 Jean-Philippe Lang
Provides the admin a way to disable OpenID logins and registrations.
217 1 Jean-Philippe Lang
Note that the setting is immutable as long as the dependency for the feature (an installed copy of the @ruby-openid@ gem) is not met.
218 1 Jean-Philippe Lang
219 1 Jean-Philippe Lang
h3. Session expiration
220 1 Jean-Philippe Lang
221 1 Jean-Philippe Lang
Session maximum lifetime: Lets the administrator set the maximum lifetime of the session
222 1 Jean-Philippe Lang
Session inactivity timeout: Lets the administrator specify after how many hours of inactivity the session times out.
223 1 Jean-Philippe Lang
%{color:red}Warning 1%: Changing these settings may expire the current sessions (including your own).
224 18 Mischa The Evil
%{color:red}Warning 2%: Redmine uses the rails cookiestore for session management. We strongly advise you to set a maximum session lifetime. If you don't, it is theoretically possible that an attacker steals the session cookie and re-uses it.
225 18 Mischa The Evil
226 50 Go MAEDA
h2. API
227 50 Go MAEDA
228 50 Go MAEDA
h3. Enable REST web service
229 50 Go MAEDA
230 50 Go MAEDA
(WIP)
231 50 Go MAEDA
232 50 Go MAEDA
h3. Enable JSONP support
233 50 Go MAEDA
234 50 Go MAEDA
(WIP)
235 50 Go MAEDA
236 1 Jean-Philippe Lang
h2. Projects
237 37 Jan Niggemann (redmine.org team member)
238 37 Jan Niggemann (redmine.org team member)
h3. New projects are public by default
239 37 Jan Niggemann (redmine.org team member)
240 46 Jacob Jones
The default state of newly created projects. The project can still be made non-public while creating new project or after the creation of the project.
241 37 Jan Niggemann (redmine.org team member)
242 50 Go MAEDA
h3. Default enabled modules for new projects
243 50 Go MAEDA
244 50 Go MAEDA
(WIP)
245 50 Go MAEDA
246 50 Go MAEDA
h3. Default trackers for new projects
247 50 Go MAEDA
248 50 Go MAEDA
(WIP)
249 50 Go MAEDA
250 18 Mischa The Evil
h3. Generate sequential project identifiers
251 1 Jean-Philippe Lang
252 1 Jean-Philippe Lang
This setting will let Redmine propose sequential project identifiers for you. This can still be manually changed only while creating the project, not afterward.
253 1 Jean-Philippe Lang
254 1 Jean-Philippe Lang
h3. Role given to a non-admin user who creates a project
255 18 Mischa The Evil
256 18 Mischa The Evil
Defines which role is given by default to a non-admin user who creates a project (this only applies when you have configured Redmine permissions in such a way that non-admin users are actually privileged to create projects).
257 18 Mischa The Evil
258 18 Mischa The Evil
h2. Issue tracking
259 18 Mischa The Evil
260 23 Jean-Philippe Lang
h3. Allow cross-project issue relations
261 18 Mischa The Evil
262 18 Mischa The Evil
If set to Yes, relations between issues from different projects can be created. _Default: No_
263 18 Mischa The Evil
264 50 Go MAEDA
h3. Link issues on copy
265 50 Go MAEDA
266 50 Go MAEDA
(WIP)
267 50 Go MAEDA
268 1 Jean-Philippe Lang
h3. Allow cross-project subtasks
269 1 Jean-Philippe Lang
270 1 Jean-Philippe Lang
Define some limits for subtasking. Definitions used are the same as version sharing, documented in [[RedmineProjectSettings#Versions]]. _Default: With project tree_
271 1 Jean-Philippe Lang
272 1 Jean-Philippe Lang
Options are:
273 1 Jean-Philippe Lang
* @disabled@ : a parent task can only have subtasks in the same project.
274 1 Jean-Philippe Lang
* @With all projects@ : a parent task can have subtasks in any other project.
275 1 Jean-Philippe Lang
* @With project tree@ : a parent task can have subtasks in the same project, ancestor projects and all their descendants (e.g. also "sibling projects", "cousin projects", etc.).
276 1 Jean-Philippe Lang
* @With project hierarchy@ : a parent task can have subtasks in the same project, subprojects, or ancestor projects.
277 1 Jean-Philippe Lang
* @With subprojects@ : a parent task can only have subtasks in the same project or subprojects (not in parent projects or unrelated projects).
278 31 Jean-Baptiste Barth
279 50 Go MAEDA
h3. Close duplicate issues automatically
280 50 Go MAEDA
281 50 Go MAEDA
(WIP)
282 50 Go MAEDA
283 50 Go MAEDA
h3. Allow issue assignment to groups
284 50 Go MAEDA
285 50 Go MAEDA
(WIP)
286 50 Go MAEDA
287 50 Go MAEDA
h3. Use current date as start date for new issues
288 50 Go MAEDA
289 50 Go MAEDA
(WIP)
290 50 Go MAEDA
291 1 Jean-Philippe Lang
h3. Display subprojects issues on main projects by default
292 1 Jean-Philippe Lang
293 12 Jean-Philippe Lang
If set to true, subprojects issues will be displayed by default on the issue list, calendar and gantt of the main projects (Since r1198). _Default: Yes_
294 12 Jean-Philippe Lang
295 12 Jean-Philippe Lang
h3. Calculate the issue done ratio
296 12 Jean-Philippe Lang
297 1 Jean-Philippe Lang
Defines how the Issue Done Percentage is set.
298 1 Jean-Philippe Lang
299 1 Jean-Philippe Lang
* *Use the issue field* _(default)_: Users can manually set % done.
300 1 Jean-Philippe Lang
* *Use the issue status*: Each issue status can be assigned a percentage. This enables the [[RedmineIssueTrackingSetup#-Done|"% Done" option for issues]] and the [[RedmineIssueTrackingSetup#Update-issue-done-ratios|"Update issue done ratios" command in the issue statuses overview]].
301 1 Jean-Philippe Lang
302 50 Go MAEDA
h3. Non-working days
303 50 Go MAEDA
304 50 Go MAEDA
(WIP)
305 50 Go MAEDA
306 12 Jean-Philippe Lang
h3. Issues export limit
307 12 Jean-Philippe Lang
308 12 Jean-Philippe Lang
Maximum number of issues contained in CSV and PDF exports. _Default: 500_
309 12 Jean-Philippe Lang
310 50 Go MAEDA
h3. Maximum number of items displayed on the gantt chart
311 50 Go MAEDA
312 50 Go MAEDA
(WIP)
313 50 Go MAEDA
314 50 Go MAEDA
h3. Parent tasks attributes
315 50 Go MAEDA
316 50 Go MAEDA
(WIP)
317 50 Go MAEDA
318 1 Jean-Philippe Lang
h3. Default columns displayed on the issue list
319 1 Jean-Philippe Lang
320 1 Jean-Philippe Lang
This setting lets you define which columns are displayed on the issue lists by default.
321 1 Jean-Philippe Lang
Only custom fields that are marked as 'For all projects' can be selected here.
322 1 Jean-Philippe Lang
323 50 Go MAEDA
h2. Time tracking
324 50 Go MAEDA
325 50 Go MAEDA
h3. Required fields for time logs
326 50 Go MAEDA
327 50 Go MAEDA
(WIP)
328 50 Go MAEDA
329 50 Go MAEDA
h2. Files
330 50 Go MAEDA
331 50 Go MAEDA
h3. Attachment max. size
332 50 Go MAEDA
333 50 Go MAEDA
Maximum size of uploaded files (in "kibi-bytes":http://en.wikipedia.org/wiki/Binary_prefix). _Default: 5120 (i.e. 5 "mebi-bytes":http://en.wikipedia.org/wiki/Binary_prefix )_
334 50 Go MAEDA
335 50 Go MAEDA
h3. Allowed extensions
336 50 Go MAEDA
337 50 Go MAEDA
(WIP)
338 50 Go MAEDA
339 50 Go MAEDA
h3. Disallowed extensions
340 50 Go MAEDA
341 50 Go MAEDA
(WIP)
342 50 Go MAEDA
343 50 Go MAEDA
344 50 Go MAEDA
h3. Max size of text files displayed inline KB
345 50 Go MAEDA
346 50 Go MAEDA
It provides a way to limit the maximum size of text files which are display inline.
347 50 Go MAEDA
348 50 Go MAEDA
h3. Max number of diff lines displayed
349 50 Go MAEDA
350 50 Go MAEDA
It provides a way to limit the maximum number of diff lines which are displayed by Redmine.
351 50 Go MAEDA
352 50 Go MAEDA
353 50 Go MAEDA
h3. Repositories encodings
354 50 Go MAEDA
355 50 Go MAEDA
This option lets you specify preferred encodings for repository files (multiple values allowed, comma separated). These encodings are used to convert files content and diff to UTF-8 so that they're properly displayed in the browser.
356 50 Go MAEDA
When entering multiple encodings, the first valid encoding regarding the file content is used.
357 50 Go MAEDA
358 50 Go MAEDA
For French users, this option can be for example set to:
359 50 Go MAEDA
360 50 Go MAEDA
  UTF-8, ISO 8859-15, CP1252
361 50 Go MAEDA
362 50 Go MAEDA
For Japanese users:
363 50 Go MAEDA
364 50 Go MAEDA
  UTF-8, CP932, EUC-JP
365 50 Go MAEDA
366 15 Jean-Philippe Lang
h2. Email notifications
367 1 Jean-Philippe Lang
368 1 Jean-Philippe Lang
h3. Emission mail address
369 1 Jean-Philippe Lang
370 1 Jean-Philippe Lang
Email address used in the "From" field of messages sent to users.
371 1 Jean-Philippe Lang
372 1 Jean-Philippe Lang
h3. Blind carbon copy recipients (bcc)
373 1 Jean-Philippe Lang
374 1 Jean-Philippe Lang
If set to true, email notification will be sent as Blind carbon copy. _Default: Yes_
375 15 Jean-Philippe Lang
376 15 Jean-Philippe Lang
h3. Plain text mail
377 12 Jean-Philippe Lang
378 1 Jean-Philippe Lang
If set to true, emails are sent in plain text only (no HTML).
379 1 Jean-Philippe Lang
380 50 Go MAEDA
h3. Default notification option
381 50 Go MAEDA
382 50 Go MAEDA
(WIP)
383 50 Go MAEDA
384 50 Go MAEDA
h3. Emails header
385 50 Go MAEDA
386 50 Go MAEDA
(WIP)
387 50 Go MAEDA
388 1 Jean-Philippe Lang
h3. Emails footer
389 1 Jean-Philippe Lang
390 1 Jean-Philippe Lang
Here you can enter some text that will be appended to the emails sent by the application.
391 18 Mischa The Evil
392 18 Mischa The Evil
h2. Incoming emails
393 18 Mischa The Evil
394 18 Mischa The Evil
See for detailed instructions about these settings [[RedmineReceivingEmails]].
395 18 Mischa The Evil
396 18 Mischa The Evil
h3. Truncate emails after one of these lines
397 18 Mischa The Evil
398 12 Jean-Philippe Lang
These setting can be used to remove signatures from incoming emails.
399 1 Jean-Philippe Lang
400 50 Go MAEDA
h3. Exclude attachments by name
401 50 Go MAEDA
402 50 Go MAEDA
(WIP)
403 50 Go MAEDA
404 28 @ go2null
h3. Enable WS for incoming emails
405 1 Jean-Philippe Lang
406 3 Jean-Philippe Lang
Redmine can be configured to allow issue creation or comments via email. In order to use that feature, you have to enable the API that receives emails. That is where this setting is for. _Default: Off_
407 3 Jean-Philippe Lang
408 3 Jean-Philippe Lang
h3. API key
409 14 Jean-Philippe Lang
410 3 Jean-Philippe Lang
Within this setting you can enter a secret key used for the issue creation or comments via email feature.
411 1 Jean-Philippe Lang
412 14 Jean-Philippe Lang
h2. Repositories
413 14 Jean-Philippe Lang
414 33 Alexander Menk
h3. Enabled SCM
415 33 Alexander Menk
416 33 Alexander Menk
Here you can (de)select the SCM-systems Redmine should "provide" to the individual projects. This setting is useful if you only support several SCM-systems (e.g. only Git or only SVN).
417 33 Alexander Menk
418 42 Sebastian Paluch
h3. Fetch commits automatically
419 1 Jean-Philippe Lang
420 1 Jean-Philippe Lang
If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.
421 1 Jean-Philippe Lang
422 1 Jean-Philippe Lang
_Default: Yes_
423 42 Sebastian Paluch
424 42 Sebastian Paluch
You can disable this option and automate the call to Repository#fetch_changesets using cron to regularly retrieve the revisions for all of the repositories in the background.
425 42 Sebastian Paluch
Example:
426 14 Jean-Philippe Lang
<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>
427 36 Mischa The Evil
428 3 Jean-Philippe Lang
For Redmine 2.x:
429 18 Mischa The Evil
430 18 Mischa The Evil
<pre>ruby script/rails runner "Repository.fetch_changesets" -e production</pre>
431 21 Nick Fischer
432 18 Mischa The Evil
For Redmine 3.x:
433 8 Jean-Philippe Lang
434 1 Jean-Philippe Lang
<pre>bin/rails runner "Repository.fetch_changesets" -e production</pre>
435 21 Nick Fischer
436 8 Jean-Philippe Lang
You can also call this task from your repository in a post-commit or post-receive hook, so that changesets are fetched after each commit.
437 8 Jean-Philippe Lang
Here is a tutorial for doing so with git: http://www.barricane.com/remine-git-post-receive.html
438 8 Jean-Philippe Lang
439 1 Jean-Philippe Lang
h3. Enable WS for repository management
440 8 Jean-Philippe Lang
441 1 Jean-Philippe Lang
This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_
442 1 Jean-Philippe Lang
443 1 Jean-Philippe Lang
h3. Maximum number of revisions displayed on file log
444 47 Go MAEDA
445 47 Go MAEDA
It provides a way to limit the amount of revisions which are retrieved from the SCM for a certain, browsed path.
446 50 Go MAEDA
447 50 Go MAEDA
h3. Apply text formatting to commit messages
448 50 Go MAEDA
449 50 Go MAEDA
(WIP)
450 4 Jean-Philippe Lang
451 12 Jean-Philippe Lang
h3. Referencing issues in commit messages
452 4 Jean-Philippe Lang
453 9 Jean-Philippe Lang
When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.
454 9 Jean-Philippe Lang
These options lets you define keywords that can be used in commit message to reference or fix issues automatically, and the status to apply to fixed issues.
455 1 Jean-Philippe Lang
456 9 Jean-Philippe Lang
Default keywords are:
457 9 Jean-Philippe Lang
458 9 Jean-Philippe Lang
* for referencing issues: refs, references, IssueID
459 9 Jean-Philippe Lang
* for fixing issues: fixes, closes
460 9 Jean-Philippe Lang
461 9 Jean-Philippe Lang
There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.
462 27 Larry Cai
If you want to reference issues without using keywords, enter a single star: * in the *Referencing keywords* (Administration/Repository) setting. In this case, any issue ID found in the message will be linked to the changeset.
463 9 Jean-Philippe Lang
464 9 Jean-Philippe Lang
Example of a working commit message using default keywords:
465 9 Jean-Philippe Lang
466 9 Jean-Philippe Lang
  This commit refs #1, #2 and fixes #3
467 9 Jean-Philippe Lang
468 9 Jean-Philippe Lang
This message would reference issues 1 and 2 and automatically fix issue 3.
469 9 Jean-Philippe Lang
After a keyword issue IDs can be separated with a space, a comma or &.
470 30 Jean-Baptiste Barth
471 40 Ulf Renman
The keywords are caseinsensitive and at least one blankspace or colon is needed between the keyword and the first hash to produce 
472 40 Ulf Renman
a match. More examples that will produce the same result as the example above:<pre>
473 40 Ulf Renman
This commit refs:#1, #2 and fixes #3
474 40 Ulf Renman
This commit Refs  #1, #2 and fixes #3
475 40 Ulf Renman
This commit REFS: #1, #2 and fixes #3
476 40 Ulf Renman
</pre>
477 40 Ulf Renman
478 30 Jean-Baptiste Barth
h3. Enable time logging
479 30 Jean-Baptiste Barth
480 30 Jean-Baptiste Barth
Allows time logging directly from commit messages. This only makes sense if you activated the "Time tracking" module in said project. In this case, you can add special words in your commit message to indicate the time you spent on an issue.
481 30 Jean-Baptiste Barth
482 30 Jean-Baptiste Barth
The basic syntax for doing that is : @@<time>@, where time consists in a number of hours or minutes.
483 30 Jean-Baptiste Barth
484 30 Jean-Baptiste Barth
Here's a list of many valid commit messages that would work if you want to say you spent N hours on issue 1234: <pre>
485 30 Jean-Baptiste Barth
Implement feature #1234 @2
486 30 Jean-Baptiste Barth
487 30 Jean-Baptiste Barth
Implement feature #1234 @2h
488 30 Jean-Baptiste Barth
489 30 Jean-Baptiste Barth
Implement feature #1234 @2hours
490 30 Jean-Baptiste Barth
491 30 Jean-Baptiste Barth
Implement feature #1234 @15m
492 30 Jean-Baptiste Barth
493 30 Jean-Baptiste Barth
Implement feature #1234 @15min
494 30 Jean-Baptiste Barth
495 30 Jean-Baptiste Barth
Implement feature #1234 @3h15
496 30 Jean-Baptiste Barth
497 30 Jean-Baptiste Barth
Implement feature #1234 @3h15m
498 30 Jean-Baptiste Barth
499 30 Jean-Baptiste Barth
Implement feature #1234 @3:15
500 30 Jean-Baptiste Barth
501 30 Jean-Baptiste Barth
Implement feature #1234 @3.25
502 30 Jean-Baptiste Barth
503 30 Jean-Baptiste Barth
Implement feature #1234 @3.25h
504 30 Jean-Baptiste Barth
505 30 Jean-Baptiste Barth
Implement feature #1234 @3,25
506 30 Jean-Baptiste Barth
507 30 Jean-Baptiste Barth
Implement feature #1234 @3,25h
508 30 Jean-Baptiste Barth
</pre>
509 30 Jean-Baptiste Barth
510 30 Jean-Baptiste Barth
h3. Activity for logged time
511 30 Jean-Baptiste Barth
512 30 Jean-Baptiste Barth
This is the type of activity that should be used when detecting there's a log time in a commit message (see above).