RedmineSettings » History » Version 70

Go MAEDA, 2018-01-08 09:07

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