Changes between Version 4 and Version 5 of TracIni


Ignore:
Timestamp:
Apr 13, 2010, 3:53:03 AM (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v4 v5  
    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
    6 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.
    7 
    86== Global Configuration ==
    97
    10 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.
     8In 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.
     9Literally, 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.
    1110
    1211Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     
    1615}}}
    1716
    18 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.
     17Note 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.
     19If you would not do this but nevertheless intend to use a global option file with your new environment,
     20you would have to go through the newly generated conf/trac.ini file and delete the entries that would
     21otherwise override those set in the global file.
    1922
    2023
    21 == Reference for settings
     24== Reference ==
    2225
    2326This is a brief reference of available configuration options.
    2427
    25 [[TracIni]]
     28[[TracIni()]]
    2629
    27 == Reference for special sections
    28 [[PageOutline(3,,inline)]]
    2930
    30 === [components] === #components-section
     31== [components] == #components-section
    3132This 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.
    3233
     
    4647See also: TracPlugins
    4748
    48 === [milestone-groups] === #milestone-groups-section
     49== [ticket-custom] == #ticket-custom-section
     50
     51In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     52
     53== [ticket-workflow] == #ticket-workflow-section
     54''(since 0.11)''
     55
     56The workflow for tickets is controlled by plugins.
     57By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     58That component allows the workflow to be configured via this section in the trac.ini file.
     59See TracWorkflow for more details.
     60
     61== [milestone-groups] == #milestone-groups-section
    4962''(since 0.11)''
    5063
     
    5770{{{
    5871closed = closed
    59 # sequence number in the progress bar
    60 closed.order = 0
    61 # optional extra param for the query (two additional columns: created and modified and sort on created)
    62 closed.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
    64 closed.overall_completion = truepercentage
     72closed.order = 0                     # sequence number in the progress bar
     73closed.query_args = group=resolution # optional extra param for the query
     74closed.overall_completion = true     # indicates groups that count for overall completion percentage
    6575
    6676new = new
     
    6979new.label = new
    7080
    71 # one catch-all group is allowed
    72 active = *
    73 active.order = 2
    74 # CSS class for this interval
    75 active.css_class = open
    76 # Displayed label for this group
    77 active.label = in progress
     81active = *                           # one catch-all group is allowed
     82active.order = 1
     83active.css_class = open              # CSS class for this interval
     84active.label = in progress           # Displayed label for this group
    7885}}}
    7986
     
    8693selector:  `table.progress td.<class>`
    8794
    88 === [repositories] === #repositories-section
    89 
    90 (''since 0.12'' multirepos)
    91 
    92 One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
    93 
    94 This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
    95 
    96 See [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
     95== [svn:externals] == #svn:externals-section
    9996''(since 0.11)''
    10097
    101 The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
    102 By default, it only turns the URLs into links as Trac can't browse remote repositories.
    103 
    104 However, 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.
     98The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
     99However, 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.
    105100
    106101This mapping is done in the `[svn:externals]` section of the TracIni
     
    109104{{{
    110105[svn:externals]
    111 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
    112 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
     1061 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
     1072 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
    1131083 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    114 4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
     1094 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
    115110}}}
    116 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).
     111With 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).
    117112
    118113Note 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.
    119114
    120 Finally, 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 
    124 In 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 
    129 The workflow for tickets is controlled by plugins.
    130 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    131 That component allows the workflow to be configured via this section in the trac.ini file.
    132 See TracWorkflow for more details.
    133 
    134 
    135115----
    136116See also: TracGuide, TracAdmin, TracEnvironment

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png