Redmine

h1. Project Settings

{{>toc}}

Members who have necessary permissions in the project can configure the project on the projects' settings tab.

h2. Information

In this screen you can configure the basic (though important) settings for the selected project.

!project-settings_information-tab.jpg!

h3. General settings

The following general settings are available:

* *Name*: project display name.

* *Description*: description that appears on the project overview.

* *Identifier*: used by the application for various things (eg. in URLs). It must be unique and cannot be composed of only numbers. Once the project is created, this identifier cannot be modified.

* *Homepage*: homepage-link that appears on the [[RedmineProjectOverview|project overview]].

* *Public*: if checked, the project can be viewed by all the users, including those who are not members of the project. If unchecked, only the project members have access to it, according to their [[RedmineRoles|role]].

* *Subproject of*: lets you define a parent project to the project being created. Projects can be unlimitedly nested.

If there are any [[RedmineCustomFields#Fields-for-Projects|projects custom fields]] configured by the administrator, they'll show up behind the "Public"-setting noted above.

h3. Trackers

Redmine lets you define which of the [[RedmineIssueTrackingSetup#Trackers|configured trackers]] (thus also their respective [[RedmineIssueTrackingSetup#Workflow|workflows]]) you are able to use within this specific project.

* *Trackers*: select the trackers that you want to use for issues of the project. Only the administrator can define new trackers.

h3. Custom fields

* *Custom fields*: select the [[RedmineCustomFields#Fields-for-Issues|issues custom fields]] that you want to use for issues of the project. Only the administrator can define new [[RedmineCustomFields|custom fields]].

Note that some of these custom fields can be only configured (e.g. unchecked) if the issue custom field is _not_ defined as a _global_ issue custom field (which can be done by the administrator by checking the "For all projects" checkbox in the custom field create/edit view).

h2. Modules

This screen lets you choose the modules you want to use for the project.

Disabling a module doesn't delete the associated data. It only prevents users from accessing it. After a module was disabled, it can be re-enabled with all its data.

You can for example disable 'Issue tracking' module for a single project. Existing issues are not deleted. You will be able to access them if you re-enable the module.

h3. Core modules

* Issue tracking: provides [[RedmineIssues|Issue tracking]] feature, including [[RedmineProjectSettings#Issue-categories|issue categories]], [[RedmineProjectSettings#Versions|versions]], the [[RedmineRoadmap|Roadmap]] and [[RedmineVersion|version overviews]]

* Time tracking: provides [[RedmineTimeTracking|Time tracking]] feature

* News: provides [[RedmineNews|News]] feature

* Documents: provides [[RedmineDocuments|Documents]] feature

* Files: provides [[RedmineFiles|Files]] feature

* Wiki: provides [[RedmineWikis|Wiki]] feature

* Repository: provides [[RedmineRepository|Repository]] feature

* Boards: provides [[RedmineForums|Forum]] feature

* Calendar: provides [[RedmineCalendar|Calendar]] feature

* Gantt: provides [[RedmineGantt|Gantt]] feature

Additional modules can be added to the system using [[Plugins|Redmine plugins]]. Plugins can only be installed by the administrator.

h2. Members

This screen lets you define project members and their roles. You can add a user or a group, with one or multiple role(s) in a given project.

h2. Versions

Projects versions allow you to track and plan changes. You can assign issues to versions and then view the list of assigned issues for each version on the [[RedmineRoadmap|roadmap]].

You can also assign a wikipage to a version which will be added to the [[RedmineRoadmap|roadmap]] and the [[RedmineVersion|version overview]].

_Note: the [[RedmineRoadmap|roadmap]] menu-item shows up in the project-menu only when the issue tracking [[RedmineProjectSettings#Core-modules|module]] is enabled for the project and at least one [[RedmineProjectSettings#Versions|version]] is configured in the [[RedmineProjectSettings|projects settings]]._

The following properties are configurable for (each of the) versions:

* *Name*: The text you want to be displayed to identify the version. _This field is required._

* *Description*: A short description to describe the version. _This field is optional._

* *Status*: the status lets you control how issues can be assigned to the version:

  * open: no restriction (default)

  * locked: can not assign new issues to the version

  * closed: can not assign new issues and can not reopen assigned issues

* *Wiki Page*: The name of a wikipage assigned to the version. _This field is optional._

* *Due date*: The due date for the version to be completed. _This field is optional._

* *Sharing*: this option lets you share the version with other projects, so that issues from these other projects can be assigned to the shared versions. Each version can be shared with:

  * subprojects: all the descendant projects

  * projects in the project hierarchy: ancestors + descendants (needs versions management permission on the root project)

  * projects in the project tree: root project + all its descendants (same as above)

  * all projects (can be set by admin users only)

<pre>

---------------------------------------------------------------------------------

| None          | Subprojects   | Hierarchy     | Tree          | All projects  |

|               |               |               |               |               |

|      X     X  |      X     X  |      o     X  |      o     X  |      o     o  |

|      |     |  |      |     |  |      |     |  |      |     |  |      |     |  |

|    --X--   X  |    --X--   X  |    --o--   X  |    --o--   X  |    --o--   o  |

|   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |   /  |  \     |

|  X   V   X    |  X   V   X    |  X   V   X    |  o   V   o    |  o   V   o    |

|     / \       |     / \       |     / \       |     / \       |     / \       |

|    X   X      |    o   o      |    o   o      |    o   o      |    o   o      |

|   /           |   /           |   /           |   /           |   /           |

|  X            |  o            |  o            |  o            |  o            |

---------------------------------------------------------------------------------

V = project with the shared version

o = projects that can assign issues to the shared version

X = projects that can't assign issues to the shared version

</pre> Sharing a version of a private project with public projects will make its name visible to everyone.

From the versions list, you can click on *Close completed versions* to automatically set the status of all the completed versions (due date reached and no open issues) to _closed_.

h2. Issue categories

Issue categories let you to organize issues. Categories can for example correspond to the different components of your project.

You are able to configure your own set of issue categories for each individual project. It is also possible to auto-assign new issues to a specific user based on the chosen category of the newly created issues.

The following properties are configurable for (each of the) issue categories:

* *Name*: The text you want to be displayed to identify the issue category. _This field is required._

* *Assigned to*: The project member to who you want to auto-assign newly created issues in this category. _This field is optional._

h2. Wiki

Each project can have its own wiki. Enable the [[RedmineProjectSettings#Modules|module]] on the desired project to activate it.

* *Start page*: This page is used as the start page for the wiki in both the project menu wiki link as well as in the start page link in the [[RedmineWikis#Sidebar|wiki sidebar]] (default: 'Wiki'). _This field is required._

h2. Repository

A SCM repository can be associated with each project. Once the repository is configured, you can browse it and view the changesets. The changesets also appear in the [[RedmineProjectActivity|Activity view]].

See [[RedmineRepositories|the following page]] for details about how to configure your repository in Redmine.

h2. Forums

Each project can have one or more discussion forums. Each forum has the following properties:

* *Name*: The text you want to be displayed to identify the discussion forum. _This field is required._

* *Description*: A short description to describe the subject of the specific forum. _This field is required._

h2. Activities (time tracking)

TODO