Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
2023-04-20T18:47:43Z (13 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v2 v3  
    1 = The Trac Configuration File =
     1= The Trac Configuration File
     2
    23[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
    35
    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 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.
    57
    6 == Global Configuration ==
     8Trac monitors the timestamp of the file to trigger an environment reload 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.
    79
    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.
     10== Global Configuration
    911
    10 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    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
    1214[inherit]
    13 file = /usr/share/trac/conf/trac.ini
     15file = /path/to/global/trac.ini
    1416}}}
     17Multiple files can be specified using a comma-separated list. Non-absolute paths are relative to the Environment `conf` directory.
    1518
    16 == Reference ==
     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 specify `--inherit` 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 in the global file.
    1720
    18 This is a brief reference of available configuration options.
     21There are three more options in the [#inherit-section "[inherit]"] section, [#inherit-templates_dir-option templates_dir] for sharing global templates, [#inherit-htdocs_dir-option htdocs_dir] for sharing global htdocs and [TracIni#inherit-plugins_dir-option plugins_dir], for sharing plugins. Those options can be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there.
     22
     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 to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation.
     24
     25== Reference for settings
     26
     27This is a reference of available configuration options, and their default settings.
     28
     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.
    1930
    2031[[TracIni]]
    2132
    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.
     33== Configure Error Reporting
    2434
    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.
     35The error reporting page has a //Create// button for reporting
     36issues. The site to which issues are reported depends on the
     37configuration of the Trac site and the user’s permissions.
    2638
    27 Consider the following configuration snippet:
    28 {{{
    29 [components]
    30 trac.ticket.report.ReportModule = disabled
    31 webadmin.* = enabled
    32 }}}
     39If the user doesn’t possess TRAC_ADMIN, the site to which a user is directed to create a ticket is determined by the [[#project-admin_trac_url-option|"[trac] admin_trac_url"]] setting:
    3340
    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.
     41* If empty, there will be no //Create// button.
     42* If set to the default value (`.`), the ticket will be
     43  created on the site which the error occurred.
     44* Otherwise the ticket will be created at the site pointed
     45  to by `admin_trac_url`.
    3546
    36 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
     47If [[#project-admin-option|"[project] admin"]] is not empty, the administrator's email address will be rendered on the error page.
    3748
    38 See also: TracPlugins
    39 
    40 == [ticket-custom] == #ticket-custom-section
    41 
    42 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    43 
    44 == [ticket-workflow] == #ticket-workflow-section
    45 ''(since 0.11)''
    46 
    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.
    51 
    52 == [milestone-groups] == #milestone-groups-section
    53 ''(since 0.11)''
    54 
    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.
    59 
    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
    66 
    67 active = *                           # one catch-all group is allowed
    68 active.order = 1
    69 active.css_class = open              # CSS class for this interval
    70 }}}
    71 
    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.
    75 
    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>`
    79 
    80 == [svn:externals] == #svn:externals-section
    81 ''(since 0.11)''
    82 
    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 [http://www.viewvc.org/ ViewVC]) is desired, then Trac needs to be able to map an external prefix to this other URL.
    85 
    86 This mapping is done in the `[svn:externals]` section of the TracIni
    87 
    88 Example:
    89 {{{
    90 [svn:externals]
    91 http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    92 svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
    93 }}}
    94 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).
    95 
     49If the user possesses TRAC_ADMIN, the //Create// button will direct the user to report the issue on trac.edgewall.org. If the error was generated in a plugin, the error will be reported to the project URL provided that the plugin author has included the project URL in the plugin installation data. The user possessing TRAC_ADMIN also sees a traceback and system information on the error page.
    9650
    9751----
    98 See also: TracGuide, TracAdmin, TracEnvironment
     52See also: TracAdmin, TracEnvironment