Project

General

Profile

RedmineSettings » History » Version 40

Ulf Renman, 2014-06-04 13:03
According to my interpretation of http://www.redmine.org/projects/redmine/repository/entry/trunk/app/models/changeset.rb#L127

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