Project

General

Profile

RedmineSettings » History » Version 10

Jean-Philippe Lang, 2007-11-18 21:24

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 3 Jean-Philippe Lang
Maximum size of uploaded files (in kylo-bytes). _Default: 2048 (i.e. 2MB)_
42 1 Jean-Philippe Lang
43 3 Jean-Philippe Lang
h3. Issues export limit
44 1 Jean-Philippe Lang
45 3 Jean-Philippe Lang
Maximum number of issues contained in CSV and PDF exports. _Default: 500_
46 1 Jean-Philippe Lang
47 3 Jean-Philippe Lang
h3. Emission mail address
48 1 Jean-Philippe Lang
49
Email address used in the "From" field of messages sent to users.
50
51
h3. Host name
52
53
Host name of the application. This name is used to write URL in emails sent to users.
54 10 Jean-Philippe Lang
55
h3. Protocol
56
57
Protocol used to generate links in email notifications. _Default: http_
58 1 Jean-Philippe Lang
59 3 Jean-Philippe Lang
h3. Text formatting
60 1 Jean-Philippe Lang
61
Formatting method applied to the "description" fields of the issues, news, documents...
62
63 3 Jean-Philippe Lang
h3. Wiki history compression
64 1 Jean-Philippe Lang
65 3 Jean-Philippe Lang
Lets you activate compression for wiki history storage (reduces database size). _Default: disabled_
66 1 Jean-Philippe Lang
67 3 Jean-Philippe Lang
h3. Feed content limit
68 1 Jean-Philippe Lang
69
Maximum number of records contained in RSS feeds. _Default: 15_
70 3 Jean-Philippe Lang
71 1 Jean-Philippe Lang
h3. Autofetch commits
72
73
If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.
74
75
_Default: Yes_
76
77 7 Jean-Philippe Lang
You can disable this option and automate the call to Repository#fetch_changesets to regularly retrieve the revisions for all of the repositories in the background.
78
Example:
79 1 Jean-Philippe Lang
<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>
80
81 3 Jean-Philippe Lang
h3. Enable WS for repository management
82 1 Jean-Philippe Lang
83 3 Jean-Philippe Lang
This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_
84 1 Jean-Philippe Lang
85 3 Jean-Philippe Lang
h3. Repositories encodings
86 1 Jean-Philippe Lang
87
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.
88
When entering multiple encodings, the first valid encoding regarding the file content is used.
89
90
For French users, this option can be for example set to:
91
92
  UTF-8, ISO 8859-15, CP1252
93
94
For Japanese users:
95
96
  ISO-2022-JP, EUC-JP, UTF-8, SHIF_JIS, WINDOWS-31J
97 3 Jean-Philippe Lang
98
h2. Authentication
99
100
h3. Authentication required
101
102 6 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_
103 3 Jean-Philippe Lang
104
h3. Autologin
105
106
This option let users use the auto-login feature. _Default: Disabled_
107
108 8 Jean-Philippe Lang
h3. Self-registration
109 1 Jean-Philippe Lang
110 8 Jean-Philippe Lang
This option lets you enable/disable new users self registration:
111
112
* *disabled*: users are not allowed to register
113
* *account activation by email*: new users receive an email containing a link used to active their accounts (users must provide a valid email address).
114
* *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.
115
* *automatic account activation*: new users can log in as soon as they have registered.
116 3 Jean-Philippe Lang
117
h3. Lost password
118
119
If this option is checked, lost password functionality is available. _Default: Yes_
120 4 Jean-Philippe Lang
121
h2. Referencing issues in commit messages
122
123 9 Jean-Philippe Lang
When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.
124
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.
125 1 Jean-Philippe Lang
126 9 Jean-Philippe Lang
Default keywords are:
127
128
* for referencing issues: refs, references, IssueID
129
* for fixing issues: fixes, closes
130
131
There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.
132
133
Example of a working commit message using default keywords:
134
135
  This commit refs #1, #2 and fixes #3
136
137
This message would reference issues 1 and 2 and automatically fix issue 3.
138
After a keyword issue IDs can be separated with a space, a comma or &.