Project

General

Profile

RedmineSettings » History » Version 61

Go MAEDA, 2018-01-07 03:01
"Welcome text" doesn't support raw HTML tags in recent versions.

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