Project

General

Profile

RedmineSettings » History » Version 23

Jean-Philippe Lang, 2010-02-07 22:08
more 0.9 updates

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