Changes between Initial Version and Version 1 of TracIni

Show
Ignore:
Timestamp:
01/05/12 22:59:04 (3 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 
     6The `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. 
     7 
     8== Global Configuration == 
     9 
     10In 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. 
     11 
     12Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
     13{{{ 
     14[inherit] 
     15file = /usr/share/trac/conf/trac.ini 
     16}}} 
     17 
     18Note that you can also specify a global option file when creating a new project,  by adding the option `--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.  If 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. 
     19 
     20 
     21== Reference == 
     22 
     23This is a brief reference of available configuration options. 
     24 
     25 ''Note that the [bitten], [spam-filter] and [vote] sections below are added by plugins enabled on this Trac, and therefore won't be part of a default installation.'' 
     26 
     27[[TracIni()]] 
     28 
     29 
     30== [components] == #components-section 
     31This 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. 
     32 
     33The 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. 
     34 
     35Consider the following configuration snippet: 
     36{{{ 
     37[components] 
     38trac.ticket.report.ReportModule = disabled 
     39webadmin.* = enabled 
     40}}} 
     41 
     42The 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. 
     43 
     44See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
     45 
     46See also: TracPlugins 
     47 
     48== [ticket-custom] == #ticket-custom-section 
     49 
     50In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     51 
     52== [ticket-workflow] == #ticket-workflow-section 
     53''(since 0.11)'' 
     54 
     55The workflow for tickets is controlled by plugins.  
     56By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     57That component allows the workflow to be configured via this section in the trac.ini file. 
     58See TracWorkflow for more details. 
     59 
     60== [milestone-groups] == #milestone-groups-section 
     61''(since 0.11)'' 
     62 
     63As the workflow for tickets is now configurable, there can be many ticket states, 
     64and simply displaying closed tickets vs. all the others is maybe not appropriate  
     65in all cases. This section enables one to easily create ''groups'' of states  
     66that will be shown in different colors in the milestone progress bar. 
     67 
     68Example configuration (the default only has closed and active): 
     69{{{ 
     70closed = closed 
     71# sequence number in the progress bar 
     72closed.order = 0 
     73# optional extra param for the query (two additional columns: created and modified and sort on created) 
     74group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime 
     75# indicates groups that count for overall completion  
     76closed.overall_completion = truepercentage 
     77 
     78new = new 
     79new.order = 1 
     80new.css_class = new 
     81new.label = new 
     82 
     83# one catch-all group is allowed 
     84active = * 
     85active.order = 2 
     86# CSS class for this interval 
     87active.css_class = open 
     88# Displayed label for this group 
     89active.label = in progress 
     90}}} 
     91 
     92The definition consists in a comma-separated list of accepted status. 
     93Also, '*' means any status and could be used to associate all remaining 
     94states to one catch-all group. 
     95 
     96The CSS class can be one of: new (yellow), open (no color) or 
     97closed (green). New styles can easily be added using the following 
     98selector:  `table.progress td.<class>` 
     99 
     100== [svn:externals] == #svn:externals-section 
     101''(since 0.11)'' 
     102 
     103The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 
     104However, if those externals are ''not'' using the `http:` or `https:` protocol, or if a link to a different repository browser such as 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. 
     105 
     106This mapping is done in the `[svn:externals]` section of the TracIni 
     107 
     108Example: 
     109{{{ 
     110[svn:externals] 
     1111 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
     1122 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
     1133 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
     1144 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
     115}}} 
     116With 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). 
     117 
     118Note 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. 
     119 
     120Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
     121 
     122---- 
     123See also: TracGuide, TracAdmin, TracEnvironment