Project

General

Profile

RedmineSettings » History » Version 54

Go MAEDA, 2017-12-17 05:14
Added description of "Time span format".

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