Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
2010-06-13T20:31:26Z (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v2 v3  
    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 previous versions, 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.
    911
    1012Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    … …  
    1416}}}
    1517
    16 == Reference ==
     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.
     19
     20
     21== Reference for settings
    1722
    1823This is a brief reference of available configuration options.
    … …  
    2025[[TracIni]]
    2126
    22 == [components] == #components-section
     27== Reference for special sections
     28[[PageOutline(3,,inline)]]
     29
     30=== [components] === #components-section
    2331This 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.
    2432
    … …  
    3846See also: TracPlugins
    3947
    40 == [ticket-custom] == #ticket-custom-section
    41 
    42 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
    43 
    44 == [ticket-workflow] == #ticket-workflow-section
    45 ''(since 0.11)''
    46 
    47 The workflow for tickets is controlled by plugins.
    48 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    49 That component allows the workflow to be configured via this section in the trac.ini file.
    50 See TracWorkflow for more details.
    51 
    52 == [milestone-groups] == #milestone-groups-section
     48=== [milestone-groups] === #milestone-groups-section
    5349''(since 0.11)''
    5450
    … …  
    5854that will be shown in different colors in the milestone progress bar.
    5955
    60 Example configuration (which is also the default):
     56Example configuration (the default only has closed and active):
    6157{{{
    6258closed = closed
    63 closed.order = 0                     # sequence number in the progress bar
    64 closed.query_args = group=resolution # optional extra param for the query
    65 closed.overall_completion = true     # count for overall completion
     59# sequence number in the progress bar
     60closed.order = 0
     61# optional extra param for the query (two additional columns: created and modified and sort on created)
     62closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     63# indicates groups that count for overall completion
     64closed.overall_completion = truepercentage
    6665
    67 active = *                           # one catch-all group is allowed
    68 active.order = 1
    69 active.css_class = open              # CSS class for this interval
     66new = new
     67new.order = 1
     68new.css_class = new
     69new.label = new
     70
     71# one catch-all group is allowed
     72active = *
     73active.order = 2
     74# CSS class for this interval
     75active.css_class = open
     76# Displayed label for this group
     77active.label = in progress
    7078}}}
    7179
    … …  
    7886selector:  `table.progress td.<class>`
    7987
    80 == [svn:externals] == #svn:externals-section
     88=== [repositories] === #repositories-section
     89
     90(''since 0.12'' multirepos)
     91
     92One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     93
     94This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     95
     96See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     97
     98=== [svn:externals] === #svn:externals-section
    8199''(since 0.11)''
    82100
    83 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
    84 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.
     101The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
     102By default, it only turns the URLs into links as Trac can't browse remote repositories.
     103
     104However, 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.
    85105
    86106This mapping is done in the `[svn:externals]` section of the TracIni
    … …  
    89109{{{
    90110[svn:externals]
    91 http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    92 svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
     1111 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1122 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
     1133 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
     1144 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
    93115}}}
    94 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).
     117
     118Note 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.
     119
     120Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
     121
     122=== [ticket-custom] === #ticket-custom-section
     123
     124In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     125
     126=== [ticket-workflow] === #ticket-workflow-section
     127''(since 0.11)''
     128
     129The workflow for tickets is controlled by plugins.
     130By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     131That component allows the workflow to be configured via this section in the trac.ini file.
     132See TracWorkflow for more details.
    95133
    96134