Project

General

Profile

RedmineSettings » History » Version 65

Go MAEDA, 2018-01-07 05:57
s/RSS/Atom/

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