Project

General

Profile

RedmineSettings » History » Version 74

Roshani Bhalerao, 2022-02-11 12:00

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