Project

General

Profile

RedmineSettings » History » Version 50

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

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