Redmine

h1. Application Settings

{{>TOC}}

h2. General settings

h3. Application title

Title which appears in heading of the application.

h3. Welcome text

Text displayed on the home page of the application. This text can contain HTML tags.

h3. Theme

This option lets you choose a custom theme.

Redmine is shipped with one alternate theme, which mainly provides issue list colorization based on issues priority.

Screenshot:

!alternate_theme.png!

Themes are located in @public/themes/@. You can read more about [[HowTo_create_a_custom_Redmine_theme|Themes]].

h3. Default language

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_

h3. Date format

Lets you choose how dates are displayed:

  * *Based on user's language*: dates will be displayed specifically for each user, according to the format defined for its language

  * *Other formats*: dates will always be displayed using the specified format

_Default: Based on user's language_

h3. Attachment max. size

Maximum size of uploaded files (in kylo-bytes). _Default: 2048 (i.e. 2MB)_

h3. Issues export limit

Maximum number of issues contained in CSV and PDF exports. _Default: 500_

h3. Emission mail address

Email address used in the "From" field of messages sent to users.

h3. Host name

Host name of the application. This name is used to write URL in emails sent to users.

h3. Protocol

Protocol used to generate links in email notifications. _Default: http_

h3. Text formatting

Formatting method applied to the "description" fields of the issues, news, documents...

h3. Wiki history compression

Lets you activate compression for wiki history storage (reduces database size). _Default: disabled_

h3. Feed content limit

Maximum number of records contained in RSS feeds. _Default: 15_

h3. Autofetch commits

If this option is activated, the application automatically retrieves the new revisions when a user consults the repository.

_Default: Yes_

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.

Example:

<pre>ruby script/runner "Repository.fetch_changesets" -e production</pre>

h3. Enable WS for repository management

This option should be activated only if you installed the script for automatic SVN repository creation. _Default: No_

h3. Repositories encodings

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.

When entering multiple encodings, the first valid encoding regarding the file content is used.

For French users, this option can be for example set to:

  UTF-8, ISO 8859-15, CP1252

For Japanese users:

  ISO-2022-JP, EUC-JP, UTF-8, SHIF_JIS, WINDOWS-31J

h2. Authentication

h3. Authentication required

If this option is checked, no page of the application is accessible to anonymous users. Users must sign to access the application. _Default: No_

h3. Autologin

This option let users use the auto-login feature. _Default: Disabled_

h3. Self-registration

This option lets you enable/disable new users self registration:

* *disabled*: users are not allowed to register

* *account activation by email*: new users receive an email containing a link used to active their accounts (users must provide a valid email address).

* *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.

* *automatic account activation*: new users can log in as soon as they have registered.

h3. Lost password

If this option is checked, lost password functionality is available. _Default: Yes_

h2. Referencing issues in commit messages

When fetched from the repositories, commit messages are scanned for referenced or fixed issue IDs.

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.

Default keywords are:

* for referencing issues: refs, references, IssueID

* for fixing issues: fixes, closes

There's no default status defined for fixed issue. You'll have to specify it if you want to enable auto closure of issues.

Example of a working commit message using default keywords:

  This commit refs #1, #2 and fixes #3

This message would reference issues 1 and 2 and automatically fix issue 3.

After a keyword issue IDs can be separated with a space, a comma or &.