Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Aug 31, 2019, 12:18:55 PM (5 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    1 = The Trac Configuration File =
    2 
    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. ''
     1= The Trac Configuration File
    42
    53[[TracGuideToc]]
    6 [[PageOutline]]
     4[[PageOutline(2-5,Contents,pullout)]]
    75
    8 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.
    97
    10 The `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.
     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.
    119
    12 == Global Configuration ==
     10== Global Configuration
    1311
    14 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.
    15 
    16 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    17 {{{
     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
    1814[inherit]
    1915file = /path/to/global/trac.ini
    2016}}}
    21 Multiple files can be specified using a comma-separated list.
     17Multiple files can be specified using a comma-separated list. Non-absolute paths are relative to the Environment `conf` directory.
    2218
    23 Note 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.
     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.
    2420
    25 There 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.
     21There are two more options in the [[#inherit-section| [inherit] ]] section, [#inherit-templates_dir-option templates_dir] for sharing global templates 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.
    2622
    27 Note 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).
     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.
    2824
    2925== Reference for settings
    3026
    31 This is a brief reference of available configuration options, and their default settings.
     27This is a reference of available configuration options, and their default settings.
    3228
    33  ''Note that the [bitten], [spam-filter] and [vote] sections below are added by plugins enabled on this Trac, and therefore won't be part of a default installation.''
     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.
    3430
    35 {{{
    36 #!comment
    37 Suggest your documentation fixes in the Discussion section at 
    38 the bottom of the page, or better send us patches against
    39 the corresponding docstrings you'll find in the code!
    40 
    41 Please don't waste your time by editing the HTML code below, changes won't be picked up.
    42 }}}
    4331[[TracIni]]
    4432
    45 == Reference for special sections
    46 [[PageOutline(3,,inline)]]
     33== Configure Error Reporting
    4734
    48 === [components] === #components-section
    49 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.
     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.
    5038
    51 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.
     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:
    5240
    53 Consider the following configuration snippet:
    54 {{{
    55 [components]
    56 trac.ticket.report.ReportModule = disabled
    57 webadmin.* = enabled
    58 }}}
     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`.
    5946
    60 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.
     47If [[#project-admin-option|"[project] admin"]] is not empty, the administrator's email address will be rendered on the error page.
    6148
    62 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
    63 
    64 See also: TracPlugins
    65 
    66 === [extra-permissions] === #extra-permissions-section
    67 ''(since 0.12)''
    68 
    69 Custom additional permissions can be defined in this section when [wiki:ExtraPermissionsProvider] is enabled.
    70 
    71 === [milestone-groups] === #milestone-groups-section
    72 ''(since 0.11)''
    73 
    74 As the workflow for tickets is now configurable, there can be many ticket states,
    75 and simply displaying closed tickets vs. all the others is maybe not appropriate
    76 in all cases. This section enables one to easily create ''groups'' of states
    77 that will be shown in different colors in the milestone progress bar.
    78 
    79 Example configuration (the default only has closed and active):
    80 {{{
    81 closed = closed
    82 # sequence number in the progress bar
    83 closed.order = 0
    84 # optional extra param for the query (two additional columns: created and modified and sort on created)
    85 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
    86 # indicates groups that count for overall completion percentage
    87 closed.overall_completion = true
    88 
    89 new = new
    90 new.order = 1
    91 new.css_class = new
    92 new.label = new
    93 
    94 # one catch-all group is allowed
    95 active = *
    96 active.order = 2
    97 # CSS class for this interval
    98 active.css_class = open
    99 # Displayed label for this group
    100 active.label = in progress
    101 }}}
    102 
    103 The definition consists in a comma-separated list of accepted status.
    104 Also, '*' means any status and could be used to associate all remaining
    105 states to one catch-all group.
    106 
    107 The CSS class can be one of: new (yellow), open (no color) or
    108 closed (green). New styles can easily be added using the following
    109 selector:  `table.progress td.<class>`
    110 
    111 === [repositories] === #repositories-section
    112 
    113 (''since 0.12'' multirepos)
    114 
    115 One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
    116 
    117 This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
    118 
    119 See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
    120 
    121 === [svn:externals] === #svn:externals-section
    122 ''(since 0.11)''
    123 
    124 The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
    125 By default, it only turns the URLs into links as Trac can't browse remote repositories.
    126 
    127 However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.
    128 
    129 This mapping is done in the `[svn:externals]` section of the TracIni
    130 
    131 Example:
    132 {{{
    133 [svn:externals]
    134 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
    135 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    136 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    137 4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
    138 }}}
    139 With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` 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 [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details).
    140 
    141 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.
    142 
    143 Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
    144 
    145 === [ticket-custom] === #ticket-custom-section
    146 
    147 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    148 
    149 === [ticket-workflow] === #ticket-workflow-section
    150 ''(since 0.11)''
    151 
    152 The workflow for tickets is controlled by plugins.
    153 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    154 That component allows the workflow to be configured via this section in the trac.ini file.
    155 See TracWorkflow for more details.
     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.
    15650
    15751----
    158 See also: TracGuide, TracAdmin, TracEnvironment
     52See also: TracAdmin, TracEnvironment