= The Trac Configuration File =
[[TracGuideToc]]

Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`.

== Global Configuration ==

Since version 0.9, Trac can also read the configuration from a global `trac.ini` file. These global options will then be merged with the environment-specific options, where local options override global options.

The global configuration is by default located in `$prefix/share/trac/conf/trac.ini`. It can be moved to a different location (for example, `/etc/trac.ini`), but that requires changing the file `trac/siteconfig.py` which gets created when Trac is installed. 

== Reference ==

This is a brief reference of available configuration options.

[[TracIni]]

== [components] ==
(''since 0.9'')

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.

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.

Consider the following configuration snippet:
{{{
[components]
trac.ticket.report.ReportModule = disabled
webadmin.* = enabled
}}}

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.

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

See also: TracPlugins

== [ticket-custom] ==

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

----

== Discussion ==

  '''Here should go suggestions for enhancing the existing documentation for the above configuration entries.'''

 * ~~Link should be: [wiki:TracTickets#Assign-toasDrop-DownList]~~ done in [3895:3896]
 * Can anyone clarify when changed settings are read from disk? If you make a change in `trac.ini`, is it reflected immediately or do you need to restart the webserver / `tracd`?
    * If you are running trac as a CGI script, you shouldn't have to restart the webserver. That said, both client and server-side cache effects may affect some settings. I'm not sure how this affects the FCGI version, but my guess is that it at least prolongs any server-side cache effects you might otherwise see.

 * the 'downloadable_paths' desc doesn't say why I can download everything even though I left it empty (what does it apply to?)
 * [milestone], [roadmap] are missing from the reference; [spam-filter] is not present in the default configs
 * mimeviewer.pygments_default_style, project.admin, trac.auto_reload isn't documented
 * trac.request_filters and trac.default_handler is not in the config file
 * it would be better if the reference and the defaults file were ordered consistently
 * WorkFlow options for the [ticket-status] and [ticket-actions] sections should be detailed here.
 * Instructions to how to create multiple projects with only one installation
----
See also: TracGuide, TracAdmin, TracEnvironment