Changes between Version 2 and Version 3 of TracIni

Apr 20, 2015 8:51:57 PM (5 years ago)



  • TracIni

    v2 v3  
    1 = The Trac Configuration File =
     1= The Trac Configuration File
    4 Trac 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.
     6Trac is configured by editing the **`trac.ini`** file, located in the `<projectenv>/conf` directory. The `trac.ini` configuration file and its parent directory should be writable by the web server.
    6 The `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.
     8Trac monitors the timestamp of the file to trigger a complete environment reload and flush its caches when the timestamp changes. Most changes to the configuration will be 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 [#GlobalConfiguration global configuration] file when none was previously present.
    8 == Global Configuration ==
     10== Global Configuration
    10 In 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.
    12 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    13 {{{
     12Configuration can be shared among environments using one or more global configuration files. Options in the global configuration will be merged with the environment-specific options, with local options overriding global options. The global configuration file is specified as follows:
    1515file = /path/to/global/trac.ini
    2121There 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.
     23Note 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, refresh your modifications when you upgrade to a new version of Trac. The preferred way to perform TracInterfaceCustomization is still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation.
    2325== Reference for settings
    25 This is a brief reference of available configuration options.
     27This is a brief reference of available configuration options, and their default settings.
     29Documentation improvements should be discussed on the [trac:MailingList#Trac-dev trac-dev mailing list] or described in a [trac:NewTicket ticket]. Even better, [trac:TracDev/SubmittingPatches submit a patch] against the docstrings in the code.
     30{{{ #!comment
     31Please don't waste your time by editing the HTML code below, changes won't be picked up. Instead, follow the above guidance for suggesting documentation improvements.
    29 == Reference for special sections
    30 [[PageOutline(3,,inline)]]
    32 === [components] === #components-section
    33 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.
    35 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.
    37 Consider the following configuration snippet:
    38 {{{
    39 [components]
    40 = disabled
    41 webadmin.* = enabled
    42 }}}
    44 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.
    46 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
    48 See also: TracPlugins
    50 === [milestone-groups] === #milestone-groups-section
    51 ''(since 0.11)''
    53 As the workflow for tickets is now configurable, there can be many ticket states,
    54 and simply displaying closed tickets vs. all the others is maybe not appropriate
    55 in all cases. This section enables one to easily create ''groups'' of states
    56 that will be shown in different colors in the milestone progress bar.
    58 Example configuration (the default only has closed and active):
    59 {{{
    60 closed = closed
    61 # sequence number in the progress bar
    62 closed.order = 0
    63 # optional extra param for the query (two additional columns: created and modified and sort on created)
    64 closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
    65 # indicates groups that count for overall completion
    66 closed.overall_completion = truepercentage
    68 new = new
    69 new.order = 1
    70 new.css_class = new
    71 new.label = new
    73 # one catch-all group is allowed
    74 active = *
    75 active.order = 2
    76 # CSS class for this interval
    77 active.css_class = open
    78 # Displayed label for this group
    79 active.label = in progress
    80 }}}
    82 The definition consists in a comma-separated list of accepted status.
    83 Also, '*' means any status and could be used to associate all remaining
    84 states to one catch-all group.
    86 The CSS class can be one of: new (yellow), open (no color) or
    87 closed (green). New styles can easily be added using the following
    88 selector:  `table.progress td.<class>`
    90 === [repositories] === #repositories-section
    92 (''since 0.12'' multirepos)
    94 One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
    96 This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
    98 See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
    100 === [svn:externals] === #svn:externals-section
    101 ''(since 0.11)''
    103 The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
    104 By default, it only turns the URLs into links as Trac can't browse remote repositories.
    106 However, 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.
    108 This mapping is done in the `[svn:externals]` section of the TracIni
    110 Example:
    111 {{{
    112 [svn:externals]
    113 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
    114 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    115 3 =       http://ourserver/viewvc/svn/$path/?pathrev=25914
    116 4 = svn://  http://ourserver/tracs/tools/browser/$path?rev=$rev
    117 }}}
    118 With 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).
    120 Note 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.
    122 Finally, the relative URLs introduced in [ Subversion 1.5] are not yet supported.
    124 === [ticket-custom] === #ticket-custom-section
    126 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    128 === [ticket-workflow] === #ticket-workflow-section
    129 ''(since 0.11)''
    131 The workflow for tickets is controlled by plugins.
    132 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    133 That component allows the workflow to be configured via this section in the trac.ini file.
    134 See TracWorkflow for more details.