Legend:

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.

5

6

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.

8

6

9

== Global Configuration ==

7

10

8

In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or sometimes /etc/trac/trac.ini depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.

9

Literally, when you're upgrading to 0.11, you have to add an `inherit`-section to your project's `trac.ini` file. Additionally you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location.

11

In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from. Literally, when you're upgrading to 0.11, you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location.

10

12

11

13

Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:

12

14

{{{

13

15

[inherit]

14

file = /usr/share/trac/conf/trac.ini

16

file = /path/to/global/trac.ini

15

17

}}}

18

Multiple files can be specified using a comma-separated list.

16

19

17

Note that you can also specify a global option file when creating a new project, by adding the option

If you would not do this but nevertheless intend to use a global option file with your new environment,

20

you would have to go through the newly generated conf/trac.ini file and delete the entries that would

21

otherwise override those set in the global file.

20

Note that you can also specify a global option file when creating a new project, by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command. If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those set in the global file.

22

21

22

There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there.

23

23

24

== Reference ==

24

Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation).

25

25

26

This is a brief reference of available configuration options.

26

== Reference for settings

27

27

28

[[TracIni()]]

28

This is a brief reference of available configuration options, and their default settings.

29

29

30

[[TracIni]]

30

31

31

== [components] == #components-section

32

== Reference for special sections

33

[[PageOutline(3,,inline)]]

34

35

=== [components] === #components-section

32

36

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.

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

96

104

''(since 0.11)''

97

105

98

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

99

However, if those externals are ''not'' using the `http:` protocol, or if a link to a different repository browser (such another Trac or [http://www.viewvc.org/ ViewVC]) is desired, then Trac needs to be able to map an external prefix to this other URL.

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/trac/support/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).

121

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

112

122

113

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.

114

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.