Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
02/25/11 22:52:52 (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    11= The Trac Configuration File = 
     2 
    23[[TracGuideToc]] 
    34 
    45Trac 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. 
    56 
     7The `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. 
     8 
    69== Global Configuration == 
    710 
    8 In 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. 
    9 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. 
     11In 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. 
    1012 
    1113Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
    1214{{{ 
    1315[inherit] 
    14 file = /usr/share/trac/conf/trac.ini 
     16file = /path/to/global/trac.ini 
    1517}}} 
     18Multiple files can be specified using a comma-separated list. 
    1619 
    17 Note 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. 
    19 If you would not do this but nevertheless intend to use a global option file with your new environment,  
    20 you would have to go through the newly generated conf/trac.ini file and delete the entries that would 
    21 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. 
    2221 
     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. 
    2323 
    24 == 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). 
    2525 
    26 This is a brief reference of available configuration options. 
     26== Reference for settings 
    2727 
    28 [[TracIni()]] 
     28This is a brief reference of available configuration options, and their default settings. 
    2929 
     30[[TracIni]] 
    3031 
    31 == [components] == #components-section 
     32== Reference for special sections 
     33[[PageOutline(3,,inline)]] 
     34 
     35=== [components] === #components-section 
    3236This 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. 
    3337 
    … …  
    4751See also: TracPlugins 
    4852 
    49 == [ticket-custom] == #ticket-custom-section 
    50  
    51 In 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  
    56 The workflow for tickets is controlled by plugins.  
    57 By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
    58 That component allows the workflow to be configured via this section in the trac.ini file. 
    59 See TracWorkflow for more details. 
    60  
    61 == [milestone-groups] == #milestone-groups-section 
     53=== [milestone-groups] === #milestone-groups-section 
    6254''(since 0.11)'' 
    6355 
    … …  
    7062{{{ 
    7163closed = closed 
    72 closed.order = 0                     # sequence number in the progress bar 
    73 closed.query_args = group=resolution # optional extra param for the query 
    74 closed.overall_completion = true     # indicates groups that count for overall completion percentage 
     64# sequence number in the progress bar 
     65closed.order = 0 
     66# optional extra param for the query (two additional columns: created and modified and sort on created) 
     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 
    7570 
    7671new = new 
    … …  
    7974new.label = new 
    8075 
    81 active = *                           # one catch-all group is allowed 
    82 active.order = 1 
    83 active.css_class = open              # CSS class for this interval 
    84 active.label = in progress           # Displayed label for this group 
     76# one catch-all group is allowed 
     77active = * 
     78active.order = 2 
     79# CSS class for this interval 
     80active.css_class = open 
     81# Displayed label for this group 
     82active.label = in progress 
    8583}}} 
    8684 
    … …  
    9391selector:  `table.progress td.<class>` 
    9492 
    95 == [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 
    96104''(since 0.11)'' 
    97105 
    98 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 
    99 However, 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. 
     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. 
    100110 
    101111This mapping is done in the `[svn:externals]` section of the TracIni 
    … …  
    104114{{{ 
    105115[svn:externals] 
    106 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
    107 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 
    1081183 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    109 4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev 
     1194 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
    110120}}} 
    111 With 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). 
     121With 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). 
    112122 
    113123Note 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. 
    114124 
     125Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
     126 
     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 
    115139---- 
    116140See also: TracGuide, TracAdmin, TracEnvironment