Project

General

Profile

RedmineSettings » History » Version 58

Go MAEDA, 2017-12-19 12:06
Added explanation of "Text formatting" options.

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