Changes between Version 1 and Version 2 of TracIni

Timestamp:

Dec 21, 2009, 9:22:48 AM (15 years ago)

Author:

trac

Comment:

--

TracIni

@@ -1 +1 @@
 = The Trac Configuration File =
+[[TracGuideToc]]
 
-[[TracGuideToc]]
+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.
 
 == 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:
@@ -13 +16 @@
 }}}
 
-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/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.
 
 
@@ -23 +22 @@
 
 This is a brief reference of available configuration options.
+
+ ''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.''
 
 [[TracIni()]]
@@ -65 +66 @@
 that will be shown in different colors in the milestone progress bar.
 
-Example configuration (which is also the default):
+Example configuration (the default only has closed and active):
 {{{
 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
+# sequence number in the progress bar
+closed.order = 0
+# optional extra param for the query (two additional columns: created and modified and sort on created)
+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
 
-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
+new = new
+new.order = 1
+new.css_class = new
+new.label = new
+
+# one catch-all group is allowed
+active = *
+active.order = 2
+# CSS class for this interval
+active.css_class = open
+# Displayed label for this group
+active.label = in progress
 }}}
 
@@ -90 +102 @@
 
 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.
+However, if those externals are ''not'' using the `http:` or `https:` protocol, or if a link to a different repository browser such as 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
@@ -100 +112 @@
 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
-4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
+4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/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).
+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).
 
 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.
 
+Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
+
 ----
 See also: TracGuide, TracAdmin, TracEnvironment