Changes between Initial Version and Version 1 of TracIni


Ignore:
Timestamp:
03/04/11 04:59:24 (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

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