Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
11/17/17 12:56:09 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    1 = The Trac Configuration File =
     1= The Trac Configuration File
    22
    33[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
    45
    5 == Global Configuration ==
     6Trac is configured through 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.
    67
    7 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.
     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.
    89
    9 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    10 {{{
     10== Global Configuration
     11
     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:
     13{{{#!ini
    1114[inherit]
    12 file = /usr/share/trac/conf/trac.ini
     15file = /path/to/global/trac.ini
    1316}}}
     17Multiple files can be specified using a comma-separated list.
    1418
    15 Note that you can also specify a global option file when creating a new project,  by adding the option
    16 `--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.
    17 If you would not do this but nevertheless intend to use a global option file with your new environment,
    18 you would have to go through the newly generated conf/trac.ini file and delete the entries that would
    19 otherwise override those set in the global file.
     19Note 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.
    2020
     21There 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.
    2122
    22 == Reference ==
     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.
    2324
    24 This is a brief reference of available configuration options.
     25== Reference for settings
    2526
    26 [[TracIni()]]
     27This is a brief reference of available configuration options, and their default settings.
    2728
    28 
    29 == [components] == #components-section
    30 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.
    31 
    32 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.
    33 
    34 Consider the following configuration snippet:
    35 {{{
    36 [components]
    37 trac.ticket.report.ReportModule = disabled
    38 webadmin.* = enabled
     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.
    3932}}}
    40 
    41 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.
    42 
    43 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
    44 
    45 See also: TracPlugins
    46 
    47 == [ticket-custom] == #ticket-custom-section
    48 
    49 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    50 
    51 == [ticket-workflow] == #ticket-workflow-section
    52 ''(since 0.11)''
    53 
    54 The workflow for tickets is controlled by plugins.
    55 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    56 That component allows the workflow to be configured via this section in the trac.ini file.
    57 See TracWorkflow for more details.
    58 
    59 == [milestone-groups] == #milestone-groups-section
    60 ''(since 0.11)''
    61 
    62 As the workflow for tickets is now configurable, there can be many ticket states,
    63 and simply displaying closed tickets vs. all the others is maybe not appropriate
    64 in all cases. This section enables one to easily create ''groups'' of states
    65 that will be shown in different colors in the milestone progress bar.
    66 
    67 Example configuration (which is also the default):
    68 {{{
    69 closed = closed
    70 closed.order = 0                     # sequence number in the progress bar
    71 closed.query_args = group=resolution # optional extra param for the query
    72 closed.overall_completion = true     # count for overall completion
    73 
    74 active = *                           # one catch-all group is allowed
    75 active.order = 1
    76 active.css_class = open              # CSS class for this interval
    77 active.label = in progress           # Displayed label for this group
    78 }}}
    79 
    80 The definition consists in a comma-separated list of accepted status.
    81 Also, '*' means any status and could be used to associate all remaining
    82 states to one catch-all group.
    83 
    84 The CSS class can be one of: new (yellow), open (no color) or
    85 closed (green). New styles can easily be added using the following
    86 selector:  `table.progress td.<class>`
    87 
    88 == [svn:externals] == #svn:externals-section
    89 ''(since 0.11)''
    90 
    91 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
    92 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.
    93 
    94 This mapping is done in the `[svn:externals]` section of the TracIni
    95 
    96 Example:
    97 {{{
    98 [svn:externals]
    99 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
    100 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
    101 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    102 4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
    103 }}}
    104 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).
    105 
    106 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.
     33[[TracIni]]
    10734
    10835----