Changes between Version 1 and Version 2 of TracIni

Show
Ignore:
Timestamp:
12/16/08 23:34:13 (6 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v2  
    22[[TracGuideToc]] 
    33 
    4 Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. 
     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. 
    55 
    66== Global Configuration == 
    77 
    8 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. 
     8In 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. 
     9Literally, 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. 
    910 
    10 The global configuration is by default localted 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.  
     11Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
     12{{{ 
     13[inherit] 
     14file = /usr/share/trac/conf/trac.ini 
     15}}} 
     16 
     17Note that you can also specify a global option file when creating a new project,  by adding the option 
     18`--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command. 
     19If you would not do this but nevertheless intend to use a global option file with your new environment,  
     20you would have to go through the newly generated conf/trac.ini file and delete the entries that would 
     21otherwise override those set in the global file. 
     22 
    1123 
    1224== Reference == 
     
    1426This is a brief reference of available configuration options. 
    1527 
    16 [[TracIni]] 
     28[[TracIni()]] 
    1729 
    18 == [components] == 
    19 (''since 0.9'') 
    2030 
     31== [components] == #components-section 
    2132This 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. 
    2233 
     
    3647See also: TracPlugins 
    3748 
    38   ''Note that prior to Trac r2335 (that applies to 0.9b1 and 0.9b2), you would use a `[disabled_components]` section instead. See a [http://projects.edgewall.com/trac/wiki/TracIni?version=42 previous version] of this page for the details.'' 
     49== [ticket-custom] == #ticket-custom-section 
     50 
     51In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     52 
     53== [ticket-workflow] == #ticket-workflow-section 
     54''(since 0.11)'' 
     55 
     56The workflow for tickets is controlled by plugins.  
     57By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     58That component allows the workflow to be configured via this section in the trac.ini file. 
     59See TracWorkflow for more details. 
     60 
     61== [milestone-groups] == #milestone-groups-section 
     62''(since 0.11)'' 
     63 
     64As the workflow for tickets is now configurable, there can be many ticket states, 
     65and simply displaying closed tickets vs. all the others is maybe not appropriate  
     66in all cases. This section enables one to easily create ''groups'' of states  
     67that will be shown in different colors in the milestone progress bar. 
     68 
     69Example configuration (the default only has closed and active): 
     70{{{ 
     71closed = closed 
     72closed.order = 0                     # sequence number in the progress bar 
     73closed.query_args = group=resolution # optional extra param for the query 
     74closed.overall_completion = true     # indicates groups that count for overall completion percentage 
     75 
     76new = new 
     77new.order = 1 
     78new.css_class = new 
     79new.label = new 
     80 
     81active = *                           # one catch-all group is allowed 
     82active.order = 1 
     83active.css_class = open              # CSS class for this interval 
     84active.label = in progress           # Displayed label for this group 
     85}}} 
     86 
     87The definition consists in a comma-separated list of accepted status. 
     88Also, '*' means any status and could be used to associate all remaining 
     89states to one catch-all group. 
     90 
     91The CSS class can be one of: new (yellow), open (no color) or 
     92closed (green). New styles can easily be added using the following 
     93selector:  `table.progress td.<class>` 
     94 
     95== [svn:externals] == #svn:externals-section 
     96''(since 0.11)'' 
     97 
     98The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 
     99However, 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. 
     100 
     101This mapping is done in the `[svn:externals]` section of the TracIni 
     102 
     103Example: 
     104{{{ 
     105[svn:externals] 
     1061 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
     1072 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
     1083 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
     1094 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev 
     110}}} 
     111With 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). 
     112 
     113Note 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. 
    39114 
    40115---- 
    41116See also: TracGuide, TracAdmin, TracEnvironment 
    42