Project

General

Profile

RedmineSettings » History » Version 15

Jean-Philippe Lang, 2008-12-07 13:58
Plain text mail option

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 1 Jean-Philippe Lang
Title which appears in heading of the application.
10
11 3 Jean-Philippe Lang
h3. Welcome text
12 1 Jean-Philippe Lang
13
Text displayed on the home page of the application. This text can contain HTML tags.
14
15 5 Jean-Philippe Lang
h3. Theme
16
17 7 Jean-Philippe Lang
This option lets you choose a custom theme.
18
Redmine is shipped with one alternate theme, which mainly provides issue list colorization based on issues priority.
19 1 Jean-Philippe Lang
20 7 Jean-Philippe Lang
Screenshot:
21
22
!alternate_theme.png!
23
24
Themes are located in @public/themes/@. You can read more about [[HowTo_create_a_custom_Redmine_theme|Themes]].
25
26 3 Jean-Philippe Lang
h3. Default language
27 1 Jean-Philippe Lang
28 3 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_
29 1 Jean-Philippe Lang
30 3 Jean-Philippe Lang
h3. Date format
31 1 Jean-Philippe Lang
32
Lets you choose how dates are displayed:
33
34 10 Jean-Philippe Lang
  * *Based on user's language*: dates will be displayed specifically for each user, according to the format defined for its language
35
  * *Other formats*: dates will always be displayed using the specified format
36 1 Jean-Philippe Lang
37 10 Jean-Philippe Lang
_Default: Based on user's language_
38 1 Jean-Philippe Lang
39 3 Jean-Philippe Lang
h3. Attachment max. size
40 1 Jean-Philippe Lang
41 13 Karl Heinz Marbaise
Maximum size of uploaded files (in "kibi-bytes":http://en.wikipedia.org/wiki/Binary_prefix). _Default: 2048 (i.e. 2 "mebi-bytes":http://en.wikipedia.org/wiki/Binary_prefix )_
42 1 Jean-Philippe Lang
43
h3. Host name
44
45
Host name of the application. This name is used to write URL in emails sent to users.
46 10 Jean-Philippe Lang
47
h3. Protocol
48
49
Protocol used to generate links in email notifications. _Default: http_
50 1 Jean-Philippe Lang
51 3 Jean-Philippe Lang
h3. Text formatting
52 1 Jean-Philippe Lang
53
Formatting method applied to the "description" fields of the issues, news, documents...
54
55
h3. Wiki history compression
56
57
Lets you activate compression for wiki history storage (reduces database size). _Default: disabled_
58
59
h3. Feed content limit
60
61
Maximum number of records contained in RSS feeds. _Default: 15_
62
63 12 Jean-Philippe Lang
h2. Authentication
64
65
h3. Authentication required
66
67
If this option is checked, no page of the application is accessible to anonymous users. Users must sign to access the application. _Default: No_
68
69
h3. Autologin
70
71
This option let users use the auto-login feature. _Default: Disabled_
72
73
h3. Self-registration
74
75
This option lets you enable/disable new users self registration:
76
77
* *disabled*: users are not allowed to register
78
* *account activation by email*: new users receive an email containing a link used to active their accounts (users must provide a valid email address).
79
* *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.
80
* *automatic account activation*: new users can log in as soon as they have registered.
81
82
h3. Lost password
83
84
If this option is checked, lost password functionality is available. _Default: Yes_
85
86
h2. Issue tracking
87
88
h3. Allow cross-project issue relations
89
90
If set to true, relations between issues from different projects can be created. _Default: No_
91
92
h3. Display subprojects issues on main projects by default
93
94
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_
95
96
h3. Issues export limit
97
98
Maximum number of issues contained in CSV and PDF exports. _Default: 500_
99
100
h3. Default columns displayed on the issue list
101
102
This setting lets you define which columns are displayed on the issue lists by default.
103
Only custom fields that are marked as 'For all projects' can be selected here.
104
105
h2. Email notifications
106
107
h3. Emission mail address
108
109
Email address used in the "From" field of messages sent to users.
110
111
h3. Blind carbon copy recipients (bcc)
112
113
If set to true, email notification will be sent as Blind carbon copy. _Default: Yes_
114
115 15 Jean-Philippe Lang
h3. Plain text mail
116
117
If set to true, emails are sent in plain text only (no HTML).
118
119 12 Jean-Philippe Lang
h3. Emails footer
120
121
Here you can enter some text that will be appended to the emails sent by the application.
122
123
h2. Repositories
124
125 1 Jean-Philippe Lang
h3. Autofetch commits
126
127
If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.
128 3 Jean-Philippe Lang
129
_Default: Yes_
130
131 14 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.
132 3 Jean-Philippe Lang
Example:
133 1 Jean-Philippe Lang
<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>
134 14 Jean-Philippe Lang
135
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.
136
Here is a tutorial for doing so with git: http://finalcog.com/remine-git-post-receive
137
138 3 Jean-Philippe Lang
139
h3. Enable WS for repository management
140
141
This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_
142
143 8 Jean-Philippe Lang
h3. Repositories encodings
144 1 Jean-Philippe Lang
145 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.
146
When entering multiple encodings, the first valid encoding regarding the file content is used.
147
148
For French users, this option can be for example set to:
149
150
  UTF-8, ISO 8859-15, CP1252
151 3 Jean-Philippe Lang
152
For Japanese users:
153
154
  ISO-2022-JP, EUC-JP, UTF-8, SHIF_JIS, WINDOWS-31J
155 4 Jean-Philippe Lang
156 12 Jean-Philippe Lang
h3. Referencing issues in commit messages
157 4 Jean-Philippe Lang
158 9 Jean-Philippe Lang
When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.
159
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.
160 1 Jean-Philippe Lang
161 9 Jean-Philippe Lang
Default keywords are:
162
163
* for referencing issues: refs, references, IssueID
164
* for fixing issues: fixes, closes
165
166
There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.
167 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.
168 9 Jean-Philippe Lang
169
Example of a working commit message using default keywords:
170
171
  This commit refs #1, #2 and fixes #3
172
173
This message would reference issues 1 and 2 and automatically fix issue 3.
174
After a keyword issue IDs can be separated with a space, a comma or &.