Legend:

''[Note To Editors] Please discuss documentation changes in the [#Discussion] section. Even better, send us [TracDev/SubmittingPatches documentation patches] against the ''code'' (i.e. where the configuration entries are documented), either on Trac-dev or on new tickets. ''

4

3

5

[[TracGuideToc]]

6

[[PageOutline]]

4

7

5

8

Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. Changes to the configuration are usually reflected immediately, though changes to the `[components]` or `[logging]` sections will require restarting the web server. You may also need to restart the web server after creating a global configuration file when none was previously present.

6

9

7

The `trac.ini` configuration file should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.

10

The `trac.ini` configuration file and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.

This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to `enabled` or `on` will enable the component, any other value (typically `disabled` or `off`) will disable the component.

37

38

The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.

39

40

Consider the following configuration snippet:

41

{{{

42

[components]

43

trac.ticket.report.ReportModule = disabled

44

webadmin.* = enabled

45

}}}

46

47

The first option tells Trac to disable the [wiki:TracReports report module]. The second option instructs Trac to enable all components in the `webadmin` package. Note that the trailing wildcard is required for module/package matching.

48

49

See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)

50

51

See also: TracPlugins

52

53

=== [milestone-groups] === #milestone-groups-section

54

''(since 0.11)''

55

56

As the workflow for tickets is now configurable, there can be many ticket states,

57

and simply displaying closed tickets vs. all the others is maybe not appropriate

58

in all cases. This section enables one to easily create ''groups'' of states

59

that will be shown in different colors in the milestone progress bar.

60

61

Example configuration (the default only has closed and active):

62

{{{

63

closed = closed

64

# sequence number in the progress bar

65

closed.order = 0

66

# optional extra param for the query (two additional columns: created and modified and sort on created)

Also, '*' means any status and could be used to associate all remaining

87

states to one catch-all group.

88

89

The CSS class can be one of: new (yellow), open (no color) or

90

closed (green). New styles can easily be added using the following

91

selector: `table.progress td.<class>`

92

93

=== [repositories] === #repositories-section

94

95

(''since 0.12'' multirepos)

96

97

One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.

98

99

This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.

100

101

See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.

102

103

=== [svn:externals] === #svn:externals-section

104

''(since 0.11)''

105

106

The TracBrowser for Subversion can interpret the `svn:externals` property of folders.

107

By default, it only turns the URLs into links as Trac can't browse remote repositories.

108

109

However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.

With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` external will be mapped to `http://ourserver/tracs/tools/browser/tags/1.1/tools?rev=` (and `rev` will be set to the appropriate revision number if the external additionally specifies a revision, see the [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details).

122

123

Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser.

124

125

Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.

126

127

=== [ticket-custom] === #ticket-custom-section

128

129

In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.

130

131

=== [ticket-workflow] === #ticket-workflow-section

132

''(since 0.11)''

133

134

The workflow for tickets is controlled by plugins.

135

By default, there's only a `ConfigurableTicketWorkflow` component in charge.

136

That component allows the workflow to be configured via this section in the trac.ini file.