Project

General

Profile

RedmineSettings » History » Version 48

Go MAEDA, 2017-08-31 11:25
ruby-openid gem is now managed by Bundler.

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
h3. Attachment max. size
16
17
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 )_
18
19
h3. Objects per page options
20
21
Here you can configure the fixed values which users can select for the amount of objects (issues, commits etc.) which are displayed per page.
22
23
_Default: 25, 50, 100_
24
25
h3. Days displayed on project activity
26
27
The initial (and recurring while browsing) amount of days of which the project(s)-activity is shown in the [[RedmineProjectActivity|activity]]-tab.
28
29 23 Jean-Philippe Lang
h3. Host name and path
30 22 Jean-Philippe Lang
31 23 Jean-Philippe Lang
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.
32 22 Jean-Philippe Lang
33
h3. Protocol
34
35
Protocol used to generate links in email notifications. _Default: http_
36
37
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).
38
39
h3. Text formatting
40
41
Formatting method applied to the "description" fields of the issues, news, documents...
42
43 24 Jean-Philippe Lang
h3. Cache formatted text (1.0)
44
45 43 Ben Blanco
Text formatting tranforms 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.
46 24 Jean-Philippe Lang
47 43 Ben Blanco
This setting lets you enable caching of formatted text.
48 1 Jean-Philippe Lang
49 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:
50
51
<pre>
52 45 Ben Blanco
# config/environments/production.rb
53
54
  ...
55
56 43 Ben Blanco
  config.consider_all_requests_local = false
57
  config.action_controller.perform_caching = true
58
59 44 Ben Blanco
  # Specify which cache store redmine should use:
60
61 43 Ben Blanco
  config.action_controller.cache_store = :memory_store
62
</pre>
63
64
By default, this cache store is "MemoryStore":http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html.
65
66
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.
67 24 Jean-Philippe Lang
68
You can read more about cache stores in the Rails guides:
69
http://guides.rubyonrails.org/caching_with_rails.html#cache-stores
70
71 22 Jean-Philippe Lang
h3. Wiki history compression
72
73
Lets you activate compression for wiki history storage (reduces database size). _Default: disabled_
74
75
h3. Feed content limit
76
77 1 Jean-Philippe Lang
Maximum number of records contained in RSS feeds. _Default: 15_
78 22 Jean-Philippe Lang
79
h3. Max size of text files displayed inline KB
80 1 Jean-Philippe Lang
81 23 Jean-Philippe Lang
It provides a way to limit the maximum size of text files which are display inline.
82 22 Jean-Philippe Lang
83
h3. Max number of diff lines displayed
84
85 23 Jean-Philippe Lang
It provides a way to limit the maximum number of diff lines which are displayed by Redmine.
86 22 Jean-Philippe Lang
87
h2. Display
88
89 18 Mischa The Evil
h3. Theme
90
91
This option lets you choose a custom theme.
92
Redmine is shipped with two additional themes besides the [[ThemeDefault|default]] theme:
93 1 Jean-Philippe Lang
* [[ThemeAlternate|alternate]], which mainly provides issue list colorization based on issues priority.
94 18 Mischa The Evil
* [[ThemeClassic|classic]], which is derived from the Redmine 0.5.1 design and brings a _classic_ look.
95
96
Screenshot of the [[ThemeAlternate|alternate]] theme:
97
98
!alternate_theme.png!
99
100
Themes are located in @public/themes/@. You can read more about [[Themes]].
101
102
h3. Default language
103
104 1 Jean-Philippe Lang
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_
105
106
h3. Date format
107
108 18 Mischa The Evil
Lets you choose how dates are displayed:
109
110 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
111
  * *Other formats*: dates will always be displayed using the specified format
112 10 Jean-Philippe Lang
113 17 Thomas Lecavelier
_Default: Based on user's language_
114
115 1 Jean-Philippe Lang
h3. Time format
116 3 Jean-Philippe Lang
117 1 Jean-Philippe Lang
Lets you choose how times are displayed:
118
119
  * *Based on user's language*: times will be displayed specifically for each user, according to the format defined for its language
120
  * *Other formats*: times will always be displayed using the specified format
121
122
_Default: Based on user's language_
123
124
h3. Users display format
125
126
Lets you choose how usernames are displayed. The following combinations are provided:
127
128
  * _Firstname_
129
  * _Firstname Surname_
130
  * _Surname Firstname_
131
  * _Surname, Firstname_
132 18 Mischa The Evil
  * _Username_
133
134
h3. Use Gravatar user icons
135
136
If enabled, users "Gravatars":http://en.gravatar.com/ (globally recognized avatar) will be displayed in several places.
137
138 22 Jean-Philippe Lang
h3. Default Gravatar image
139 18 Mischa The Evil
140 22 Jean-Philippe Lang
The image to use for users who don't have a Gravatar.
141 18 Mischa The Evil
142 12 Jean-Philippe Lang
h2. Authentication
143
144
h3. Authentication required
145
146 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_
147 12 Jean-Philippe Lang
148
h3. Autologin
149
150
This option let users use the auto-login feature. _Default: Disabled_
151
152
h3. Self-registration
153
154
This option lets you enable/disable new users self registration:
155
156
* *disabled*: users are not allowed to register
157 25 Michael Bishop
* *account activation by email*: new users receive an email containing a link used to activate their accounts (users must provide a valid email address).
158 1 Jean-Philippe Lang
* *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.
159
* *automatic account activation*: new users can log in as soon as they have registered.
160
161 21 Nick Fischer
h3. Minimum password length
162 18 Mischa The Evil
163 35 Mischa The Evil
Let's the admin decide on the minimum length of the chosen passwords.
164 18 Mischa The Evil
165 34 Mischa The Evil
_Default: 8_
166 1 Jean-Philippe Lang
167 18 Mischa The Evil
h3. Lost password
168 1 Jean-Philippe Lang
169
If this option is checked, lost password functionality is available. _Default: Yes_
170
171 18 Mischa The Evil
h3. Allow OpenID login and registration
172
173 23 Jean-Philippe Lang
Provides the admin a way to disable OpenID logins and registrations.
174 48 Go MAEDA
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.
175 1 Jean-Philippe Lang
176 37 Jan Niggemann (redmine.org team member)
h3. Session expiration
177
178
Session maximum lifetime: Lets the administrator set the maximum lifetime of the session
179 46 Jacob Jones
Session inactivity timeout: Lets the administrator specify after how many hours of inactivity the session times out.
180 37 Jan Niggemann (redmine.org team member)
%{color:red}Warning 1%: Changing these settings may expire the current sessions (including your own).
181 38 Daniel Felix
%{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.
182 37 Jan Niggemann (redmine.org team member)
183 1 Jean-Philippe Lang
h2. Projects
184
185 20 Mischa The Evil
h3. New projects are public by default
186 18 Mischa The Evil
187 1 Jean-Philippe Lang
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.
188 18 Mischa The Evil
189
h3. Generate sequential project identifiers
190
191
This setting will let Redmine propose sequential project identifiers for you. This can still be manually changed only while creating the project, not afterward.
192
193
h3. Role given to a non-admin user who creates a project
194
195 23 Jean-Philippe Lang
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).
196 18 Mischa The Evil
197
h2. Issue tracking
198
199 21 Nick Fischer
h3. Allow cross-project issue relations
200 18 Mischa The Evil
201 31 Jean-Baptiste Barth
If set to Yes, relations between issues from different projects can be created. _Default: No_
202
203 32 Jean-Baptiste Barth
h3. Allow cross-project subtasks
204
205
Define some limits for subtasking. Definitions used are the same as version sharing, documented in [[RedmineProjectSettings#Versions]]. _Default: With project tree_
206
207
Options are:
208
* @disabled@ : a parent task can only have subtasks in the same project.
209
* @With all projects@ : a parent task can have subtasks in any other project.
210
* @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.).
211
* @With project hierarchy@ : a parent task can have subtasks in the same project, subprojects, or ancestor projects.
212
* @With subprojects@ : a parent task can only have subtasks in the same project or subprojects (not in parent projects or unrelated projects).
213 12 Jean-Philippe Lang
214
h3. Display subprojects issues on main projects by default
215
216
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_
217
218 26 Tharuka Pathirana
h3. Calculate the issue done ratio
219
220
Defines how the Issue Done Percentage is set.
221
222
* *Use the issue field* _(default)_: Users can manually set % done.
223
* *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]].
224
225 12 Jean-Philippe Lang
h3. Issues export limit
226
227
Maximum number of issues contained in CSV and PDF exports. _Default: 500_
228
229
h3. Default columns displayed on the issue list
230
231
This setting lets you define which columns are displayed on the issue lists by default.
232
Only custom fields that are marked as 'For all projects' can be selected here.
233
234
h2. Email notifications
235
236
h3. Emission mail address
237
238
Email address used in the "From" field of messages sent to users.
239
240
h3. Blind carbon copy recipients (bcc)
241
242
If set to true, email notification will be sent as Blind carbon copy. _Default: Yes_
243
244
h3. Plain text mail
245
246
If set to true, emails are sent in plain text only (no HTML).
247 15 Jean-Philippe Lang
248
h3. Emails footer
249
250
Here you can enter some text that will be appended to the emails sent by the application.
251 12 Jean-Philippe Lang
252 1 Jean-Philippe Lang
h2. Incoming emails
253
254
See for detailed instructions about these settings [[RedmineReceivingEmails]].
255 22 Jean-Philippe Lang
256
h3. Truncate emails after one of these lines
257
258
These setting can be used to remove signatures from incoming emails.
259 18 Mischa The Evil
260
h3. Enable WS for incoming emails
261
262
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_
263
264
h3. API key
265
266
Within this setting you can enter a secret key used for the issue creation or comments via email feature.
267
268 12 Jean-Philippe Lang
h2. Repositories
269 1 Jean-Philippe Lang
270 29 @ go2null
h3. Enabled SCM
271
272
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).
273
274 28 @ go2null
h3. Fetch commits automatically
275 1 Jean-Philippe Lang
276 3 Jean-Philippe Lang
If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.
277
278
_Default: Yes_
279 14 Jean-Philippe Lang
280 3 Jean-Philippe Lang
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.
281 1 Jean-Philippe Lang
Example:
282 14 Jean-Philippe Lang
<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>
283
284 33 Alexander Menk
For Redmine 2.x:
285
286
<pre>ruby script/rails runner "Repository.fetch_changesets" -e production</pre>
287
288 42 Sebastian Paluch
For Redmine 3.x:
289
290
<pre>bin/rails runner "Repository.fetch_changesets" -e production</pre>
291
292 14 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.
293 36 Mischa The Evil
Here is a tutorial for doing so with git: http://www.barricane.com/remine-git-post-receive.html
294 3 Jean-Philippe Lang
295 18 Mischa The Evil
h3. Enable WS for repository management
296
297 21 Nick Fischer
This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_
298 18 Mischa The Evil
299 8 Jean-Philippe Lang
h3. Repositories encodings
300 1 Jean-Philippe Lang
301 21 Nick Fischer
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.
302 8 Jean-Philippe Lang
When entering multiple encodings, the first valid encoding regarding the file content is used.
303
304
For French users, this option can be for example set to:
305 1 Jean-Philippe Lang
306 8 Jean-Philippe Lang
  UTF-8, ISO 8859-15, CP1252
307 1 Jean-Philippe Lang
308
For Japanese users:
309
310 47 Go MAEDA
  UTF-8, CP932, EUC-JP
311
312 18 Mischa The Evil
313
h3. Maximum number of revisions displayed on file log
314
315 23 Jean-Philippe Lang
It provides a way to limit the amount of revisions which are retrieved from the SCM for a certain, browsed path.
316 4 Jean-Philippe Lang
317 12 Jean-Philippe Lang
h3. Referencing issues in commit messages
318 4 Jean-Philippe Lang
319 9 Jean-Philippe Lang
When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.
320
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.
321 1 Jean-Philippe Lang
322 9 Jean-Philippe Lang
Default keywords are:
323
324
* for referencing issues: refs, references, IssueID
325
* for fixing issues: fixes, closes
326
327
There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.
328 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.
329 9 Jean-Philippe Lang
330
Example of a working commit message using default keywords:
331
332
  This commit refs #1, #2 and fixes #3
333
334
This message would reference issues 1 and 2 and automatically fix issue 3.
335
After a keyword issue IDs can be separated with a space, a comma or &.
336 30 Jean-Baptiste Barth
337 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 
338
a match. More examples that will produce the same result as the example above:<pre>
339
This commit refs:#1, #2 and fixes #3
340
This commit Refs  #1, #2 and fixes #3
341
This commit REFS: #1, #2 and fixes #3
342
</pre>
343
344 30 Jean-Baptiste Barth
h3. Enable time logging
345
346
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.
347
348
The basic syntax for doing that is : @@<time>@, where time consists in a number of hours or minutes.
349
350
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>
351
Implement feature #1234 @2
352
353
Implement feature #1234 @2h
354
355
Implement feature #1234 @2hours
356
357
Implement feature #1234 @15m
358
359
Implement feature #1234 @15min
360
361
Implement feature #1234 @3h15
362
363
Implement feature #1234 @3h15m
364
365
Implement feature #1234 @3:15
366
367
Implement feature #1234 @3.25
368
369
Implement feature #1234 @3.25h
370
371
Implement feature #1234 @3,25
372
373
Implement feature #1234 @3,25h
374
</pre>
375
376
h3. Activity for logged time
377
378
This is the type of activity that should be used when detecting there's a log time in a commit message (see above).