RedmineSettings » History » Version 25

Michael Bishop, 2010-05-15 18:27
fixing minor grammer error

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