Project

General

Profile

RedmineSettings » History » Version 19

Mischa The Evil, 2009-06-12 01:40
Added note about OpenID-gem dependency for allowing OpenID logins/registrations

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