Changes between Version 1 and Version 2 of TracIni

Sep 9, 2011, 8:09:18 PM (10 years ago)



  • TracIni

    v1 v2  
    11= The Trac Configuration File =
    4 Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`.
     5Trac 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.
     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.
    69== Global Configuration ==
    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.
     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.
    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/` which gets created when Trac is installed.
     13Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     16file = /path/to/global/trac.ini
     18Multiple files can be specified using a comma-separated list.
    12 == Reference ==
     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.
    14 This is a brief reference of available configuration options.
     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.
     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).
     26== Reference for settings
     28This is a brief reference of available configuration options, and their default settings.
    18 == [components] ==
    19 (''since 0.9'')
     32== Reference for special sections
     35=== [components] === #components-section
    2136This 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.
    3651See also: TracPlugins
    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 [ previous version] of this page for the details.''
     53=== [milestone-groups] === #milestone-groups-section
     54''(since 0.11)''
     56As the workflow for tickets is now configurable, there can be many ticket states,
     57and simply displaying closed tickets vs. all the others is maybe not appropriate
     58in all cases. This section enables one to easily create ''groups'' of states
     59that will be shown in different colors in the milestone progress bar.
     61Example configuration (the default only has closed and active):
     63closed = closed
     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
     71new = new
     72new.order = 1
     73new.css_class = new
     74new.label = new
     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
     85The definition consists in a comma-separated list of accepted status.
     86Also, '*' means any status and could be used to associate all remaining
     87states to one catch-all group.
     89The CSS class can be one of: new (yellow), open (no color) or
     90closed (green). New styles can easily be added using the following
     91selector:  `table.progress td.<class>`
     93=== [repositories] === #repositories-section
     95(''since 0.12'' multirepos)
     97One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     99This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     101See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     103=== [svn:externals] === #svn:externals-section
     104''(since 0.11)''
     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.
     109However, if you have another Trac instance (or an other repository browser like [ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.
     111This mapping is done in the `[svn:externals]` section of the TracIni
     1161 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1172 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
     1183 =       http://ourserver/viewvc/svn/$path/?pathrev=25914
     1194 = svn://  http://ourserver/tracs/tools/browser/$path?rev=$rev
     121With the above, the `svn://` 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 [ SVN Book on externals] for more details).
     123Note 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.
     125Finally, the relative URLs introduced in [ Subversion 1.5] are not yet supported.
     127=== [ticket-custom] === #ticket-custom-section
     129In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     131=== [ticket-workflow] === #ticket-workflow-section
     132''(since 0.11)''
     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.
    41140See also: TracGuide, TracAdmin, TracEnvironment