Context Navigation

Changes between Version 1 and Version 2 of TracIni

Timestamp:: Jun 23, 2015, 6:04:32 PM (9 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracIni

-              v1
+              v2
 = The Trac Configuration File =
+ ''[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. ''
 [[TracGuideToc]]
+[[PageOutline]]
+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.
+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.
 == Global Configuration ==
 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.
+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.
 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
 {{{
 [inherit]
 file = /usr/share/trac/conf/trac.ini
+file = /path/to/global/trac.ini
 }}}
+Multiple files can be specified using a comma-separated list.
+Note that you can also specify a global option file when creating a new project,  by adding the option
+`--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.
+If you would not do this but nevertheless intend to use a global option file with your new environment,
+you would have to go through the newly generated conf/trac.ini file and delete the entries that would
+otherwise override those set in the global file.
+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.
+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.
+== Reference ==
+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).
+This is a brief reference of available configuration options.
+== Reference for settings
+[[TracIni()]]
+This is a brief reference of available configuration options, and their default settings.
+ ''Note that the [hg], [spam-filter], [translatedpages], [vote], [wikiextras] and [wikiextras-symbols] sections below are added by plugins enabled on this Trac, and therefore won't be part of a default installation.''
+== [components] == #components-section
+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.
+{{{
+#!comment
+Suggest your documentation fixes in the Discussion section at
+the bottom of the page, or better send us patches against
+the corresponding docstrings you'll find in the code!
+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.
+Please don't waste your time by editing the HTML code below, changes won't be picked up.
+}}}
+[[TracIni]]
+Consider the following configuration snippet:
+{{{
+[components]
+trac.ticket.report.ReportModule = disabled
+webadmin.* = enabled
+}}}
+== Discussion ==
+''Please discuss documentation changes here. Even better, send us documentation patches against the code, either on Trac-dev or on new tickets.''
-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.
-See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
-See also: TracPlugins
-== [ticket-custom] == #ticket-custom-section
-In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
-== [ticket-workflow] == #ticket-workflow-section
-''(since 0.11)''
-The workflow for tickets is controlled by plugins.
-By default, there's only a `ConfigurableTicketWorkflow` component in charge.
-That component allows the workflow to be configured via this section in the trac.ini file.
-See TracWorkflow for more details.
-== [milestone-groups] == #milestone-groups-section
-''(since 0.11)''
-As the workflow for tickets is now configurable, there can be many ticket states,
-and simply displaying closed tickets vs. all the others is maybe not appropriate
-in all cases. This section enables one to easily create ''groups'' of states
-that will be shown in different colors in the milestone progress bar.
-Example configuration (which is also the default):
-{{{
-closed = closed
-closed.order = 0                     # sequence number in the progress bar
-closed.query_args = group=resolution # optional extra param for the query
-closed.overall_completion = true     # count for overall completion
-active = *                           # one catch-all group is allowed
-active.order = 1
-active.css_class = open              # CSS class for this interval
-active.label = in progress           # Displayed label for this group
-}}}
-The definition consists in a comma-separated list of accepted status.
-Also, '*' means any status and could be used to associate all remaining
-states to one catch-all group.
-The CSS class can be one of: new (yellow), open (no color) or
-closed (green). New styles can easily be added using the following
-selector:  `table.progress td.<class>`
-== [svn:externals] == #svn:externals-section
-''(since 0.11)''
-The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
-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.
-This mapping is done in the `[svn:externals]` section of the TracIni
-Example:
-{{{
-[svn:externals]
-= svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
-= svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
-= http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
-= svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
-}}}
-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).
-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.
 ----