RedmineSettings » History » Version 60

Go MAEDA, 2018-01-07 02:57
Fixed a typo: s/unsecure/unsecured/

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