Project

General

Profile

RedmineSettings » History » Version 22

Jean-Philippe Lang, 2010-02-07 22:04
0.9 settings update

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
h3. Host name
30
31
Host name 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
33
_Will become "Host name *and path*" in Redmine version#6 which also adds support to "guess" the correct setting_
34
35
h3. Protocol
36
37
Protocol used to generate links in email notifications. _Default: http_
38
39
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).
40
41
h3. Text formatting
42
43
Formatting method applied to the "description" fields of the issues, news, documents...
44
45
h3. Wiki history compression
46
47
Lets you activate compression for wiki history storage (reduces database size). _Default: disabled_
48
49
h3. Feed content limit
50
51
Maximum number of records contained in RSS feeds. _Default: 15_
52
53
h3. Max size of text files displayed inline KB
54
55
This setting will be added in Redmine version#6. It provides a way to limit the maximum size of text files which are display inline.
56
57
h3. Max number of diff lines displayed
58
59
This setting will be added in Redmine version#6. It provides a way to limit the maximum number of diff lines which are displayed by Redmine.
60
61
h2. Display
62
63 18 Mischa The Evil
h3. Theme
64
65
This option lets you choose a custom theme.
66
Redmine is shipped with two additional themes besides the [[ThemeDefault|default]] theme:
67 1 Jean-Philippe Lang
* [[ThemeAlternate|alternate]], which mainly provides issue list colorization based on issues priority.
68 18 Mischa The Evil
* [[ThemeClassic|classic]], which is derived from the Redmine 0.5.1 design and brings a _classic_ look.
69
70
Screenshot of the [[ThemeAlternate|alternate]] theme:
71
72
!alternate_theme.png!
73
74
Themes are located in @public/themes/@. You can read more about [[Themes]].
75
76
h3. Default language
77
78 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_
79
80
h3. Date format
81
82 18 Mischa The Evil
Lets you choose how dates are displayed:
83
84 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
85
  * *Other formats*: dates will always be displayed using the specified format
86 10 Jean-Philippe Lang
87 17 Thomas Lecavelier
_Default: Based on user's language_
88
89 1 Jean-Philippe Lang
h3. Time format
90 3 Jean-Philippe Lang
91 1 Jean-Philippe Lang
Lets you choose how times are displayed:
92
93
  * *Based on user's language*: times will be displayed specifically for each user, according to the format defined for its language
94
  * *Other formats*: times will always be displayed using the specified format
95
96
_Default: Based on user's language_
97
98
h3. Users display format
99
100
Lets you choose how usernames are displayed. The following combinations are provided:
101
102
  * _Firstname_
103
  * _Firstname Surname_
104
  * _Surname Firstname_
105
  * _Surname, Firstname_
106 18 Mischa The Evil
  * _Username_
107
108
h3. Use Gravatar user icons
109
110
If enabled, users "Gravatars":http://en.gravatar.com/ (globally recognized avatar) will be displayed in several places.
111
112 22 Jean-Philippe Lang
h3. Default Gravatar image
113 18 Mischa The Evil
114 22 Jean-Philippe Lang
The image to use for users who don't have a Gravatar.
115 18 Mischa The Evil
116 12 Jean-Philippe Lang
h2. Authentication
117
118
h3. Authentication required
119
120
If this option is checked, no page of the application is accessible to anonymous users. Users must sign to access the application. _Default: No_
121
122
h3. Autologin
123
124
This option let users use the auto-login feature. _Default: Disabled_
125
126
h3. Self-registration
127
128
This option lets you enable/disable new users self registration:
129
130
* *disabled*: users are not allowed to register
131 1 Jean-Philippe Lang
* *account activation by email*: new users receive an email containing a link used to active their accounts (users must provide a valid email address).
132
* *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.
133
* *automatic account activation*: new users can log in as soon as they have registered.
134
135 21 Nick Fischer
h3. Minimum password length
136 18 Mischa The Evil
137 21 Nick Fischer
This setting will be added in Redmine version#6. Let's the admin decide on the minimum length of the chosen passwords.
138 18 Mischa The Evil
139
_Default: 4_
140
141 1 Jean-Philippe Lang
h3. Lost password
142
143
If this option is checked, lost password functionality is available. _Default: Yes_
144
145 18 Mischa The Evil
h3. Allow OpenID login and registration
146
147
This setting will be added in Redmine version#6. Will provide the admin a way to disable OpenID logins and registrations.
148 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@.
149
150
h2. Projects
151
152 20 Mischa The Evil
h3. New projects are public by default
153 18 Mischa The Evil
154
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.
155
156
h3. Generate sequential project identifiers
157
158
This setting will let Redmine propose sequential project identifiers for you. This can still be manually changed only while creating the project, not afterward.
159
160
h3. Role given to a non-admin user who creates a project
161
162 21 Nick Fischer
This setting will be added in Redmine version#6. It adds a setting to choose 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).
163 18 Mischa The Evil
164
h2. Issue tracking
165
166 21 Nick Fischer
h3. Allow cross-project issue relations
167 18 Mischa The Evil
168 12 Jean-Philippe Lang
If set to true, relations between issues from different projects can be created. _Default: No_
169
170
h3. Display subprojects issues on main projects by default
171
172
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_
173
174
h3. Issues export limit
175
176
Maximum number of issues contained in CSV and PDF exports. _Default: 500_
177
178
h3. Default columns displayed on the issue list
179
180
This setting lets you define which columns are displayed on the issue lists by default.
181
Only custom fields that are marked as 'For all projects' can be selected here.
182
183
h2. Email notifications
184
185
h3. Emission mail address
186
187
Email address used in the "From" field of messages sent to users.
188
189
h3. Blind carbon copy recipients (bcc)
190
191
If set to true, email notification will be sent as Blind carbon copy. _Default: Yes_
192
193
h3. Plain text mail
194
195
If set to true, emails are sent in plain text only (no HTML).
196 15 Jean-Philippe Lang
197
h3. Emails footer
198
199
Here you can enter some text that will be appended to the emails sent by the application.
200 12 Jean-Philippe Lang
201 1 Jean-Philippe Lang
h2. Incoming emails
202
203
See for detailed instructions about these settings [[RedmineReceivingEmails]].
204 22 Jean-Philippe Lang
205
h3. Truncate emails after one of these lines
206
207
These setting can be used to remove signatures from incoming emails.
208 18 Mischa The Evil
209
h3. Enable WS for incoming emails
210
211
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_
212
213
h3. API key
214
215
Within this setting you can enter a secret key used for the issue creation or comments via email feature.
216
217 12 Jean-Philippe Lang
h2. Repositories
218 1 Jean-Philippe Lang
219
h3. Autofetch commits
220
221 3 Jean-Philippe Lang
If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.
222
223
_Default: Yes_
224 14 Jean-Philippe Lang
225 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.
226 1 Jean-Philippe Lang
Example:
227 14 Jean-Philippe Lang
<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>
228
229
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.
230
Here is a tutorial for doing so with git: http://finalcog.com/remine-git-post-receive
231 1 Jean-Philippe Lang
232
h3. Enable WS for repository management
233
234
This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_
235 3 Jean-Philippe Lang
236 18 Mischa The Evil
h3. Enabled SCM
237
238 21 Nick Fischer
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).
239 18 Mischa The Evil
240 8 Jean-Philippe Lang
h3. Repositories encodings
241 1 Jean-Philippe Lang
242 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.
243 8 Jean-Philippe Lang
When entering multiple encodings, the first valid encoding regarding the file content is used.
244
245
For French users, this option can be for example set to:
246
247 1 Jean-Philippe Lang
  UTF-8, ISO 8859-15, CP1252
248
249
For Japanese users:
250
251 8 Jean-Philippe Lang
  ISO-2022-JP, EUC-JP, UTF-8, SHIF_JIS, WINDOWS-31J
252 18 Mischa The Evil
253
h3. Maximum number of revisions displayed on file log
254
255
This setting will be added in Redmine version#6. It provides a way to limit the amount of revisions which are retrieved from the SCM for a certain, browsed path.
256 4 Jean-Philippe Lang
257 12 Jean-Philippe Lang
h3. Referencing issues in commit messages
258 4 Jean-Philippe Lang
259 9 Jean-Philippe Lang
When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.
260
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.
261 1 Jean-Philippe Lang
262 9 Jean-Philippe Lang
Default keywords are:
263
264
* for referencing issues: refs, references, IssueID
265
* for fixing issues: fixes, closes
266
267
There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.
268 11 Jean-Philippe Lang
If you want to reference issues without using keywords, enter a single star: * in the *Referencing keywords* setting. In this case, any issue ID found in the message will be linked to the changeset.
269 9 Jean-Philippe Lang
270
Example of a working commit message using default keywords:
271
272
  This commit refs #1, #2 and fixes #3
273
274
This message would reference issues 1 and 2 and automatically fix issue 3.
275
After a keyword issue IDs can be separated with a space, a comma or &.