Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
09/22/11 13:47:54 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    11= The Trac Configuration File = 
     2[[TracGuideToc]] 
    23 
    3 [[TracGuideToc]] 
     4Trac 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. 
     5 
     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. 
    47 
    58== Global Configuration == 
    69 
    7 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. 
     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. 
    811 
    912Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
    … …  
    1316}}} 
    1417 
    15 Note that you can also specify a global option file when creating a new project,  by adding the option 
    16 `--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command. 
    17 If you would not do this but nevertheless intend to use a global option file with your new environment,  
    18 you would have to go through the newly generated conf/trac.ini file and delete the entries that would 
    19 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. 
    2019 
    2120 
    … …  
    2322 
    2423This 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.'' 
    2526 
    2627[[TracIni()]] 
    … …  
    6566that will be shown in different colors in the milestone progress bar. 
    6667 
    67 Example configuration (which is also the default): 
     68Example configuration (the default only has closed and active): 
    6869{{{ 
    6970closed = closed 
    70 closed.order = 0                     # sequence number in the progress bar 
    71 closed.query_args = group=resolution # optional extra param for the query 
    72 closed.overall_completion = true     # count for overall completion 
     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 
    7377 
    74 active = *                           # one catch-all group is allowed 
    75 active.order = 1 
    76 active.css_class = open              # CSS class for this interval 
    77 active.label = in progress           # Displayed label for this group 
     78new = new 
     79new.order = 1 
     80new.css_class = new 
     81new.label = new 
     82 
     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 
    7890}}} 
    7991 
    … …  
    90102 
    91103The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 
    92 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. 
    93105 
    94106This mapping is done in the `[svn:externals]` section of the TracIni 
    … …  
    1001122 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
    1011133 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    102 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 
    103115}}} 
    104 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). 
    105117 
    106118Note 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. 
    107119 
     120Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
     121 
    108122---- 
    109123See also: TracGuide, TracAdmin, TracEnvironment