Context Navigation

Changes between Version 3 and Version 4 of TracIni

Timestamp:: Jan 21, 2013, 6:46:40 PM (12 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracIni

-              v3
+              v4
 = The Trac Configuration File =
 [[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 should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.
+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 ==
 …
 {{{
 [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 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.
+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
+ ''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.''
+This is a brief reference of available configuration options, and their default settings.
 [[TracIni()]]
+[[TracIni]]
+== Reference for special sections
+[[PageOutline(3,,inline)]]
 === [components] === #components-section
 …
 See also: TracPlugins
+=== [ticket-custom] === #ticket-custom-section
+=== [extra-permissions] === #extra-permissions-section
+''(since 0.12)''
+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.
+Custom additional permissions can be defined in this section when [wiki:ExtraPermissionsProvider] is enabled.
 === [milestone-groups] === #milestone-groups-section
 …
 # optional extra param for the query (two additional columns: created and modified and sort on created)
 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
 # indicates groups that count for overall completion
 closed.overall_completion = truepercentage
+# indicates groups that count for overall completion percentage
+closed.overall_completion = true
 new = new
 …
 closed (green). New styles can easily be added using the following
 selector:  `table.progress td.<class>`
+=== [repositories] === #repositories-section
+(''since 0.12'' multirepos)
+One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
+This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
+See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
 === [svn:externals] === #svn:externals-section
 …
 Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
+=== [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.
 ----
 See also: TracGuide, TracAdmin, TracEnvironment