Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
12/31/09 13:17:06 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    44Trac 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.
    55
     6The `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.
     7
    68== Global Configuration ==
    79
    8 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.
    9 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.
     10In 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.
    1011
    1112Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    … …  
    1516}}}
    1617
    17 Note that you can also specify a global option file when creating a new project,  by adding the option
    18 `--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.
    19 If you would not do this but nevertheless intend to use a global option file with your new environment,
    20 you would have to go through the newly generated conf/trac.ini file and delete the entries that would
    21 otherwise override those set in the global file.
     18Note 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.
    2219
    2320
    … …  
    2522
    2623This is a brief reference of available configuration options.
     24
     25 ''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.''
    2726
    2827[[TracIni()]]
    … …  
    7069{{{
    7170closed = closed
    72 closed.order = 0                     # sequence number in the progress bar
    73 closed.query_args = group=resolution # optional extra param for the query
    74 closed.overall_completion = true     # indicates groups that count for overall completion percentage
     71# sequence number in the progress bar
     72closed.order = 0
     73# optional extra param for the query (two additional columns: created and modified and sort on created)
     74group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     75# indicates groups that count for overall completion
     76closed.overall_completion = truepercentage
    7577
    7678new = new
    … …  
    7981new.label = new
    8082
    81 active = *                           # one catch-all group is allowed
    82 active.order = 1
    83 active.css_class = open              # CSS class for this interval
    84 active.label = in progress           # Displayed label for this group
     83# one catch-all group is allowed
     84active = *
     85active.order = 2
     86# CSS class for this interval
     87active.css_class = open
     88# Displayed label for this group
     89active.label = in progress
    8590}}}
    8691
    … …  
    97102
    98103The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
    99 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.
     104However, 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.
    100105
    101106This mapping is done in the `[svn:externals]` section of the TracIni
    … …  
    1071122 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
    1081133 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    109 4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
     1144 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
    110115}}}
    111 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).
     116With 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).
    112117
    113118Note 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.
    114119
     120Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
     121
    115122----
    116123See also: TracGuide, TracAdmin, TracEnvironment