Changes between Initial Version and Version 1 of TracIni


Ignore:
Timestamp:
Apr 7, 2008 7:00:21 PM (12 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v1  
     1= The Trac Configuration File =
     2[[TracGuideToc]]
     3
     4Trac 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== Global Configuration ==
     7
     8In previous versions, 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
     10Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     11{{{
     12[inherit]
     13file = /usr/share/trac/conf/trac.ini
     14}}}
     15
     16== Reference ==
     17
     18This is a brief reference of available configuration options.
     19
     20[[TracIni]]
     21
     22== [components] == #components-section
     23This 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.
     24
     25The 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.
     26
     27Consider the following configuration snippet:
     28{{{
     29[components]
     30trac.ticket.report.ReportModule = disabled
     31webadmin.* = enabled
     32}}}
     33
     34The 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.
     35
     36See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
     37
     38See also: TracPlugins
     39
     40== [ticket-custom] == #ticket-custom-section
     41
     42In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     43
     44== [ticket-workflow] == #ticket-workflow-section
     45''(since 0.11)''
     46
     47The workflow for tickets is controlled by plugins.
     48By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     49That component allows the workflow to be configured via this section in the trac.ini file.
     50See TracWorkflow for more details.
     51
     52== [milestone-groups] == #milestone-groups-section
     53''(since 0.11)''
     54
     55As the workflow for tickets is now configurable, there can be many ticket states,
     56and simply displaying closed tickets vs. all the others is maybe not appropriate
     57in all cases. This section enables one to easily create ''groups'' of states
     58that will be shown in different colors in the milestone progress bar.
     59
     60Example configuration (which is also the default):
     61{{{
     62closed = closed
     63closed.order = 0                     # sequence number in the progress bar
     64closed.query_args = group=resolution # optional extra param for the query
     65closed.overall_completion = true     # count for overall completion
     66
     67active = *                           # one catch-all group is allowed
     68active.order = 1
     69active.css_class = open              # CSS class for this interval
     70}}}
     71
     72The definition consists in a comma-separated list of accepted status.
     73Also, '*' means any status and could be used to associate all remaining
     74states to one catch-all group.
     75
     76The CSS class can be one of: new (yellow), open (no color) or
     77closed (green). New styles can easily be added using the following
     78selector:  `table.progress td.<class>`
     79
     80== [svn:externals] == #svn:externals-section
     81''(since 0.11)''
     82
     83The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
     84However, 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.
     85
     86This mapping is done in the `[svn:externals]` section of the TracIni
     87
     88Example:
     89{{{
     90[svn:externals]
     91http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
     92svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
     93}}}
     94With 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).
     95
     96
     97----
     98See also: TracGuide, TracAdmin, TracEnvironment