Changes between Version 4 and Version 5 of TracIni


Ignore:
Timestamp:
12/23/12 14:06:38 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v4 v5  
    11= The Trac Configuration File = 
     2 
    23[[TracGuideToc]] 
    34 
     
    1314{{{ 
    1415[inherit] 
    15 file = /usr/share/trac/conf/trac.ini 
     16file = /path/to/global/trac.ini 
    1617}}} 
     18Multiple files can be specified using a comma-separated list. 
    1719 
    18 Note 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. 
     20Note that you can also specify a global option file when creating a new project,  by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command.  If you 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. 
    1921 
     22There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there. 
    2023 
    21 == Reference == 
     24Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation). 
    2225 
    23 This is a brief reference of available configuration options. 
     26== Reference for settings 
    2427 
    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.'' 
     28This is a brief reference of available configuration options, and their default settings. 
    2629 
    27 [[TracIni()]] 
     30[[TracIni]] 
    2831 
     32== Reference for special sections 
     33[[PageOutline(3,,inline)]] 
    2934 
    30 == [components] == #components-section 
     35=== [components] === #components-section 
    3136This 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. 
    3237 
     
    4651See also: TracPlugins 
    4752 
    48 == [ticket-custom] == #ticket-custom-section 
    49  
    50 In 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  
    55 The workflow for tickets is controlled by plugins.  
    56 By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
    57 That component allows the workflow to be configured via this section in the trac.ini file. 
    58 See TracWorkflow for more details. 
    59  
    60 == [milestone-groups] == #milestone-groups-section 
     53=== [milestone-groups] === #milestone-groups-section 
    6154''(since 0.11)'' 
    6255 
     
    7265closed.order = 0 
    7366# optional extra param for the query (two additional columns: created and modified and sort on created) 
    74 group=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  
    76 closed.overall_completion = truepercentage 
     67closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime 
     68# indicates groups that count for overall completion percentage 
     69closed.overall_completion = true 
    7770 
    7871new = new 
     
    9891selector:  `table.progress td.<class>` 
    9992 
    100 == [svn:externals] == #svn:externals-section 
     93=== [repositories] === #repositories-section 
     94 
     95(''since 0.12'' multirepos) 
     96 
     97One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. 
     98 
     99This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. 
     100 
     101See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. 
     102 
     103=== [svn:externals] === #svn:externals-section 
    101104''(since 0.11)'' 
    102105 
    103 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 
    104 However, 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. 
     106The TracBrowser for Subversion can interpret the `svn:externals` property of folders. 
     107By default, it only turns the URLs into links as Trac can't browse remote repositories. 
     108 
     109However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL. 
    105110 
    106111This mapping is done in the `[svn:externals]` section of the TracIni 
     
    109114{{{ 
    110115[svn:externals] 
    111 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
    112 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
     1161 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 
     1172 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 
    1131183 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    1141194 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
     
    120125Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
    121126 
     127=== [ticket-custom] === #ticket-custom-section 
     128 
     129In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     130 
     131=== [ticket-workflow] === #ticket-workflow-section 
     132''(since 0.11)'' 
     133 
     134The workflow for tickets is controlled by plugins.  
     135By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     136That component allows the workflow to be configured via this section in the trac.ini file. 
     137See TracWorkflow for more details. 
     138 
    122139---- 
    123140See also: TracGuide, TracAdmin, TracEnvironment