Changes between Initial Version and Version 1 of TracIni

Dec 23, 2012, 2:31:47 PM (5 years ago)



  • TracIni

    v1 v1  
     1= The Trac Configuration File =
     6Trac 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.
     8The `trac.ini` configuration file and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.
     10== Global Configuration ==
     12In 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.
     14Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     17file = /path/to/global/trac.ini
     19Multiple files can be specified using a comma-separated list.
     21Note 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.
     23There 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.
     25Note 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).
     27== Reference for settings
     29This is a brief reference of available configuration options, and their default settings.
     33== Reference for special sections
     36=== [components] === #components-section
     37This 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.
     39The 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.
     41Consider the following configuration snippet:
     43[components] = disabled
     45webadmin.* = enabled
     48The 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.
     50See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
     52See also: TracPlugins
     54=== [extra-permissions] === #extra-permissions-section
     55''(since 0.12)''
     57Custom additional permissions can be defined in this section when [wiki:ExtraPermissionsProvider] is enabled.
     59=== [milestone-groups] === #milestone-groups-section
     60''(since 0.11)''
     62As the workflow for tickets is now configurable, there can be many ticket states,
     63and simply displaying closed tickets vs. all the others is maybe not appropriate
     64in all cases. This section enables one to easily create ''groups'' of states
     65that will be shown in different colors in the milestone progress bar.
     67Example configuration (the default only has closed and active):
     69closed = closed
     70# sequence number in the progress bar
     71closed.order = 0
     72# optional extra param for the query (two additional columns: created and modified and sort on created)
     73closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     74# indicates groups that count for overall completion percentage
     75closed.overall_completion = true
     77new = new
     78new.order = 1
     79new.css_class = new
     80new.label = new
     82# one catch-all group is allowed
     83active = *
     84active.order = 2
     85# CSS class for this interval
     86active.css_class = open
     87# Displayed label for this group
     88active.label = in progress
     91The definition consists in a comma-separated list of accepted status.
     92Also, '*' means any status and could be used to associate all remaining
     93states to one catch-all group.
     95The CSS class can be one of: new (yellow), open (no color) or
     96closed (green). New styles can easily be added using the following
     97selector:  `table.progress td.<class>`
     99=== [repositories] === #repositories-section
     101(''since 0.12'' multirepos)
     103One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     105This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     107See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     109=== [svn:externals] === #svn:externals-section
     110''(since 0.11)''
     112The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
     113By default, it only turns the URLs into links as Trac can't browse remote repositories.
     115However, 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.
     117This mapping is done in the `[svn:externals]` section of the TracIni
     1221 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1232 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
     1243 =       http://ourserver/viewvc/svn/$path/?pathrev=25914
     1254 = svn://  http://ourserver/tracs/tools/browser/$path?rev=$rev
     127With 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).
     129Note 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.
     131Finally, the relative URLs introduced in [ Subversion 1.5] are not yet supported.
     133=== [ticket-custom] === #ticket-custom-section
     135In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     137=== [ticket-workflow] === #ticket-workflow-section
     138''(since 0.11)''
     140The workflow for tickets is controlled by plugins.
     141By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     142That component allows the workflow to be configured via this section in the trac.ini file.
     143See TracWorkflow for more details.
     146See also: TracGuide, TracAdmin, TracEnvironment