Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
4 Nov 2010, 08:13:08 (7 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:
    1013{{{
    1114[inherit]
    12 file = /usr/share/trac/conf/trac.ini
     15file = /path/to/global/trac.ini
    1316}}}
     17Multiple files can be specified using a comma-separated list.
    1418
    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.
     19Note 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.
    2020
     21There 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.
    2122
    22 == Reference ==
     23== Reference for settings
    2324
    2425This is a brief reference of available configuration options.
    2526
    26 [[TracIni()]]
     27[[TracIni]]
    2728
     29== Reference for special sections
     30[[PageOutline(3,,inline)]]
    2831
    29 == [components] == #components-section
     32=== [components] === #components-section
    3033This 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.
    3134
     
    4548See also: TracPlugins
    4649
    47 == [ticket-custom] == #ticket-custom-section
    48 
    49 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    50 
    51 == [ticket-workflow] == #ticket-workflow-section
    52 ''(since 0.11)''
    53 
    54 The workflow for tickets is controlled by plugins.
    55 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    56 That component allows the workflow to be configured via this section in the trac.ini file.
    57 See TracWorkflow for more details.
    58 
    59 == [milestone-groups] == #milestone-groups-section
     50=== [milestone-groups] === #milestone-groups-section
    6051''(since 0.11)''
    6152
     
    6556that will be shown in different colors in the milestone progress bar.
    6657
    67 Example configuration (which is also the default):
     58Example configuration (the default only has closed and active):
    6859{{{
    6960closed = 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
     61# sequence number in the progress bar
     62closed.order = 0
     63# optional extra param for the query (two additional columns: created and modified and sort on created)
     64closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     65# indicates groups that count for overall completion
     66closed.overall_completion = truepercentage
    7367
    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
     68new = new
     69new.order = 1
     70new.css_class = new
     71new.label = new
     72
     73# one catch-all group is allowed
     74active = *
     75active.order = 2
     76# CSS class for this interval
     77active.css_class = open
     78# Displayed label for this group
     79active.label = in progress
    7880}}}
    7981
     
    8688selector:  `table.progress td.<class>`
    8789
    88 == [svn:externals] == #svn:externals-section
     90=== [repositories] === #repositories-section
     91
     92(''since 0.12'' multirepos)
     93
     94One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     95
     96This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     97
     98See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     99
     100=== [svn:externals] === #svn:externals-section
    89101''(since 0.11)''
    90102
    91 The 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.
     103The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
     104By default, it only turns the URLs into links as Trac can't browse remote repositories.
     105
     106However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.
    93107
    94108This mapping is done in the `[svn:externals]` section of the TracIni
     
    97111{{{
    98112[svn:externals]
    99 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
    100 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
     1131 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1142 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    1011153 = 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
     1164 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
    103117}}}
    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).
     118With 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).
    105119
    106120Note 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.
    107121
     122Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
     123
     124=== [ticket-custom] === #ticket-custom-section
     125
     126In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     127
     128=== [ticket-workflow] === #ticket-workflow-section
     129''(since 0.11)''
     130
     131The workflow for tickets is controlled by plugins.
     132By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     133That component allows the workflow to be configured via this section in the trac.ini file.
     134See TracWorkflow for more details.
     135
     136
    108137----
    109138See also: TracGuide, TracAdmin, TracEnvironment