Project

General

Profile

RedmineSettings » History » Version 51

Go MAEDA, 2017-12-17 03:36
Added the description of "Search results per page" setting.

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
(WIP)
105
106
h3. Force default language for logged-in users
107
108
(WIP)
109
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
(WIP)
135
136 1 Jean-Philippe Lang
h3. Users display format
137
138
Lets you choose how usernames are displayed. The following combinations are provided:
139
140
  * _Firstname_
141
  * _Firstname Surname_
142
  * _Surname Firstname_
143
  * _Surname, Firstname_
144
  * _Username_
145
146
h3. Use Gravatar user icons
147
148
If enabled, users "Gravatars":http://en.gravatar.com/ (globally recognized avatar) will be displayed in several places.
149
150
h3. Default Gravatar image
151
152
The image to use for users who don't have a Gravatar.
153
154 50 Go MAEDA
h3. Display attachment thumbnails
155
156
(WIP)
157
158
h3. Thumbnails size
159
160
(WIP)
161
162
h3. Project menu tab for creating new objects
163
164
(WIP)
165
166 12 Jean-Philippe Lang
h2. Authentication
167
168
h3. Authentication required
169
170 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_
171 12 Jean-Philippe Lang
172 1 Jean-Philippe Lang
h3. Autologin
173
174
This option let users use the auto-login feature. _Default: Disabled_
175
176
h3. Self-registration
177
178
This option lets you enable/disable new users self registration:
179
180 12 Jean-Philippe Lang
* *disabled*: users are not allowed to register
181
* *account activation by email*: new users receive an email containing a link used to activate their accounts (users must provide a valid email address).
182
* *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.
183
* *automatic account activation*: new users can log in as soon as they have registered.
184
185 50 Go MAEDA
h3. Show custom fields on registration
186
187
(WIP)
188
189
h3. Allow users to delete their own account
190
191
(WIP)
192
193 25 Michael Bishop
h3. Minimum password length
194 1 Jean-Philippe Lang
195
Let's the admin decide on the minimum length of the chosen passwords.
196
197
_Default: 8_
198
199 50 Go MAEDA
h3. Require password change after
200
201
(WIP)
202
203 35 Mischa The Evil
h3. Lost password
204 18 Mischa The Evil
205 34 Mischa The Evil
If this option is checked, [[RedmineAccounts#Password-lost|lost password functionality]] is available. _Default: Yes_
206 1 Jean-Philippe Lang
207 50 Go MAEDA
h3. Maximum number of additional email addresses
208
209
(WIP)
210
211 1 Jean-Philippe Lang
h3. Allow OpenID login and registration
212
213
Provides the admin a way to disable OpenID logins and registrations.
214
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.
215
216
h3. Session expiration
217
218
Session maximum lifetime: Lets the administrator set the maximum lifetime of the session
219
Session inactivity timeout: Lets the administrator specify after how many hours of inactivity the session times out.
220
%{color:red}Warning 1%: Changing these settings may expire the current sessions (including your own).
221 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.
222
223 50 Go MAEDA
h2. API
224
225
h3. Enable REST web service
226
227
(WIP)
228
229
h3. Enable JSONP support
230
231
(WIP)
232
233 1 Jean-Philippe Lang
h2. Projects
234 37 Jan Niggemann (redmine.org team member)
235
h3. New projects are public by default
236
237 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.
238 37 Jan Niggemann (redmine.org team member)
239 50 Go MAEDA
h3. Default enabled modules for new projects
240
241
(WIP)
242
243
h3. Default trackers for new projects
244
245
(WIP)
246
247 18 Mischa The Evil
h3. Generate sequential project identifiers
248 1 Jean-Philippe Lang
249
This setting will let Redmine propose sequential project identifiers for you. This can still be manually changed only while creating the project, not afterward.
250
251
h3. Role given to a non-admin user who creates a project
252 18 Mischa The Evil
253
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).
254
255
h2. Issue tracking
256
257 23 Jean-Philippe Lang
h3. Allow cross-project issue relations
258 18 Mischa The Evil
259
If set to Yes, relations between issues from different projects can be created. _Default: No_
260
261 50 Go MAEDA
h3. Link issues on copy
262
263
(WIP)
264
265 1 Jean-Philippe Lang
h3. Allow cross-project subtasks
266
267
Define some limits for subtasking. Definitions used are the same as version sharing, documented in [[RedmineProjectSettings#Versions]]. _Default: With project tree_
268
269
Options are:
270
* @disabled@ : a parent task can only have subtasks in the same project.
271
* @With all projects@ : a parent task can have subtasks in any other project.
272
* @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.).
273
* @With project hierarchy@ : a parent task can have subtasks in the same project, subprojects, or ancestor projects.
274
* @With subprojects@ : a parent task can only have subtasks in the same project or subprojects (not in parent projects or unrelated projects).
275 31 Jean-Baptiste Barth
276 50 Go MAEDA
h3. Close duplicate issues automatically
277
278
(WIP)
279
280
h3. Allow issue assignment to groups
281
282
(WIP)
283
284
h3. Use current date as start date for new issues
285
286
(WIP)
287
288 1 Jean-Philippe Lang
h3. Display subprojects issues on main projects by default
289
290 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_
291
292
h3. Calculate the issue done ratio
293
294 1 Jean-Philippe Lang
Defines how the Issue Done Percentage is set.
295
296
* *Use the issue field* _(default)_: Users can manually set % done.
297
* *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]].
298
299 50 Go MAEDA
h3. Non-working days
300
301
(WIP)
302
303 12 Jean-Philippe Lang
h3. Issues export limit
304
305
Maximum number of issues contained in CSV and PDF exports. _Default: 500_
306
307 50 Go MAEDA
h3. Maximum number of items displayed on the gantt chart
308
309
(WIP)
310
311
h3. Parent tasks attributes
312
313
(WIP)
314
315 1 Jean-Philippe Lang
h3. Default columns displayed on the issue list
316
317
This setting lets you define which columns are displayed on the issue lists by default.
318
Only custom fields that are marked as 'For all projects' can be selected here.
319
320 50 Go MAEDA
h2. Time tracking
321
322
h3. Required fields for time logs
323
324
(WIP)
325
326
h2. Files
327
328
h3. Attachment max. size
329
330
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 )_
331
332
h3. Allowed extensions
333
334
(WIP)
335
336
h3. Disallowed extensions
337
338
(WIP)
339
340
341
h3. Max size of text files displayed inline KB
342
343
It provides a way to limit the maximum size of text files which are display inline.
344
345
h3. Max number of diff lines displayed
346
347
It provides a way to limit the maximum number of diff lines which are displayed by Redmine.
348
349
350
h3. Repositories encodings
351
352
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.
353
When entering multiple encodings, the first valid encoding regarding the file content is used.
354
355
For French users, this option can be for example set to:
356
357
  UTF-8, ISO 8859-15, CP1252
358
359
For Japanese users:
360
361
  UTF-8, CP932, EUC-JP
362
363 15 Jean-Philippe Lang
h2. Email notifications
364 1 Jean-Philippe Lang
365
h3. Emission mail address
366
367
Email address used in the "From" field of messages sent to users.
368
369
h3. Blind carbon copy recipients (bcc)
370
371
If set to true, email notification will be sent as Blind carbon copy. _Default: Yes_
372 15 Jean-Philippe Lang
373
h3. Plain text mail
374 12 Jean-Philippe Lang
375 1 Jean-Philippe Lang
If set to true, emails are sent in plain text only (no HTML).
376
377 50 Go MAEDA
h3. Default notification option
378
379
(WIP)
380
381
h3. Emails header
382
383
(WIP)
384
385 1 Jean-Philippe Lang
h3. Emails footer
386
387
Here you can enter some text that will be appended to the emails sent by the application.
388 18 Mischa The Evil
389
h2. Incoming emails
390
391
See for detailed instructions about these settings [[RedmineReceivingEmails]].
392
393
h3. Truncate emails after one of these lines
394
395 12 Jean-Philippe Lang
These setting can be used to remove signatures from incoming emails.
396 1 Jean-Philippe Lang
397 50 Go MAEDA
h3. Exclude attachments by name
398
399
(WIP)
400
401 28 @ go2null
h3. Enable WS for incoming emails
402 1 Jean-Philippe Lang
403 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_
404
405
h3. API key
406 14 Jean-Philippe Lang
407 3 Jean-Philippe Lang
Within this setting you can enter a secret key used for the issue creation or comments via email feature.
408 1 Jean-Philippe Lang
409 14 Jean-Philippe Lang
h2. Repositories
410
411 33 Alexander Menk
h3. Enabled SCM
412
413
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).
414
415 42 Sebastian Paluch
h3. Fetch commits automatically
416 1 Jean-Philippe Lang
417
If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.
418
419
_Default: Yes_
420 42 Sebastian Paluch
421
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.
422
Example:
423 14 Jean-Philippe Lang
<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>
424 36 Mischa The Evil
425 3 Jean-Philippe Lang
For Redmine 2.x:
426 18 Mischa The Evil
427
<pre>ruby script/rails runner "Repository.fetch_changesets" -e production</pre>
428 21 Nick Fischer
429 18 Mischa The Evil
For Redmine 3.x:
430 8 Jean-Philippe Lang
431 1 Jean-Philippe Lang
<pre>bin/rails runner "Repository.fetch_changesets" -e production</pre>
432 21 Nick Fischer
433 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.
434
Here is a tutorial for doing so with git: http://www.barricane.com/remine-git-post-receive.html
435
436 1 Jean-Philippe Lang
h3. Enable WS for repository management
437 8 Jean-Philippe Lang
438 1 Jean-Philippe Lang
This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_
439
440
h3. Maximum number of revisions displayed on file log
441 47 Go MAEDA
442
It provides a way to limit the amount of revisions which are retrieved from the SCM for a certain, browsed path.
443 50 Go MAEDA
444
h3. Apply text formatting to commit messages
445
446
(WIP)
447 4 Jean-Philippe Lang
448 12 Jean-Philippe Lang
h3. Referencing issues in commit messages
449 4 Jean-Philippe Lang
450 9 Jean-Philippe Lang
When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.
451
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.
452 1 Jean-Philippe Lang
453 9 Jean-Philippe Lang
Default keywords are:
454
455
* for referencing issues: refs, references, IssueID
456
* for fixing issues: fixes, closes
457
458
There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.
459 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.
460 9 Jean-Philippe Lang
461
Example of a working commit message using default keywords:
462
463
  This commit refs #1, #2 and fixes #3
464
465
This message would reference issues 1 and 2 and automatically fix issue 3.
466
After a keyword issue IDs can be separated with a space, a comma or &.
467 30 Jean-Baptiste Barth
468 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 
469
a match. More examples that will produce the same result as the example above:<pre>
470
This commit refs:#1, #2 and fixes #3
471
This commit Refs  #1, #2 and fixes #3
472
This commit REFS: #1, #2 and fixes #3
473
</pre>
474
475 30 Jean-Baptiste Barth
h3. Enable time logging
476
477
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.
478
479
The basic syntax for doing that is : @@<time>@, where time consists in a number of hours or minutes.
480
481
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>
482
Implement feature #1234 @2
483
484
Implement feature #1234 @2h
485
486
Implement feature #1234 @2hours
487
488
Implement feature #1234 @15m
489
490
Implement feature #1234 @15min
491
492
Implement feature #1234 @3h15
493
494
Implement feature #1234 @3h15m
495
496
Implement feature #1234 @3:15
497
498
Implement feature #1234 @3.25
499
500
Implement feature #1234 @3.25h
501
502
Implement feature #1234 @3,25
503
504
Implement feature #1234 @3,25h
505
</pre>
506
507
h3. Activity for logged time
508
509
This is the type of activity that should be used when detecting there's a log time in a commit message (see above).