Changes between Version 2 and Version 3 of TracIni

18/06/13 12:48:03 (10 years ago)



  • TracIni

    v2 v3  
    11= The Trac Configuration File =
     3 ''[Note To Editors] Please discuss documentation changes in the [#Discussion] section. Even better, send us [TracDev/SubmittingPatches documentation patches] against the ''code'' (i.e. where the configuration entries are documented), either on Trac-dev or on new tickets. ''
    48Trac 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.
     10The `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.
    612== Global Configuration ==
    8 In previous versions, 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.
     14In 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.
    1016Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    13 file = /usr/share/trac/conf/trac.ini
     19file = /path/to/global/trac.ini
     21Multiple files can be specified using a comma-separated list.
    16 == Reference ==
     23Note 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.
    18 This is a brief reference of available configuration options.
     25There 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.
     27Note 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).
     29== Reference for settings
     31This is a brief reference of available configuration options, and their default settings.
    22 == [components] == #components-section
    23 This 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.
    25 The 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.
    27 Consider the following configuration snippet:
    28 {{{
    29 [components]
    30 = disabled
    31 webadmin.* = enabled
    32 }}}
    34 The 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.
    36 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
    38 See also: TracPlugins
    40 == [ticket-custom] == #ticket-custom-section
    42 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    44 == [ticket-workflow] == #ticket-workflow-section
    45 ''(since 0.11)''
    47 The workflow for tickets is controlled by plugins.
    48 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    49 That component allows the workflow to be configured via this section in the trac.ini file.
    50 See TracWorkflow for more details.
    52 == [milestone-groups] == #milestone-groups-section
    53 ''(since 0.11)''
    55 As the workflow for tickets is now configurable, there can be many ticket states,
    56 and simply displaying closed tickets vs. all the others is maybe not appropriate
    57 in all cases. This section enables one to easily create ''groups'' of states
    58 that will be shown in different colors in the milestone progress bar.
    60 Example configuration (which is also the default):
    61 {{{
    62 closed = closed
    63 closed.order = 0                     # sequence number in the progress bar
    64 closed.query_args = group=resolution # optional extra param for the query
    65 closed.overall_completion = true     # count for overall completion
    67 active = *                           # one catch-all group is allowed
    68 active.order = 1
    69 active.css_class = open              # CSS class for this interval
    70 }}}
    72 The definition consists in a comma-separated list of accepted status.
    73 Also, '*' means any status and could be used to associate all remaining
    74 states to one catch-all group.
    76 The CSS class can be one of: new (yellow), open (no color) or
    77 closed (green). New styles can easily be added using the following
    78 selector:  `table.progress td.<class>`
    80 == [svn:externals] == #svn:externals-section
    81 ''(since 0.11)''
    83 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
    84 However, if those externals are ''not'' using the `http:` protocol, or if a link to a different repository browser (such another Trac or [ ViewVC]) is desired, then Trac needs to be able to map an external prefix to this other URL.
    86 This mapping is done in the `[svn:externals]` section of the TracIni
    88 Example:
    89 {{{
    90 [svn:externals]
    91       http://ourserver/viewvc/svn/$path/?pathrev=25914
    92 svn://  http://ourserver/trac/support/browser/$path?rev=$rev
    93 }}}
    94 With the above, the `svn://` 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 [ SVN Book on externals] for more details).
    9836See also: TracGuide, TracAdmin, TracEnvironment