RedmineSettings » History » Version 50

Go MAEDA, 2017-12-17 03:24
Added placeholders for undocumented settings and reorder them to match the order Redmine 3.4.

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