RedmineSettings » History » Version 67

Go MAEDA, 2018-01-07 06:49
Added explanation of "Project menu tab for creating new objects"

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