Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Apr 22, 2013, 6:19:02 PM (12 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    11= The Trac Configuration File =
     2
    23[[TracGuideToc]]
     4[[PageOutline]]
    35
    46Trac 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.
    57
     8The `trac.ini` configuration file and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.
     9
    610== Global Configuration ==
    711
    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.
     12In 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.
    1013
    1114Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
    1215{{{
    1316[inherit]
    14 file = /usr/share/trac/conf/trac.ini
     17file = /path/to/global/trac.ini
    1518}}}
     19Multiple files can be specified using a comma-separated list.
    1620
    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.
     21Note 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.
    2222
     23There 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.
    2324
    24 == Reference ==
     25Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation).
    2526
    26 This is a brief reference of available configuration options.
     27== Reference for settings
    2728
    28 [[TracIni()]]
     29This is a brief reference of available configuration options, and their default settings.
    2930
     31[[TracIni]]
    3032
    31 == [components] == #components-section
     33== Reference for special sections
     34[[PageOutline(3,,inline)]]
     35
     36=== [components] === #components-section
    3237This 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.
    3338
    … …  
    4752See also: TracPlugins
    4853
    49 == [ticket-custom] == #ticket-custom-section
     54=== [extra-permissions] === #extra-permissions-section
     55''(since 0.12)''
    5056
    51 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     57Custom additional permissions can be defined in this section when [wiki:ExtraPermissionsProvider] is enabled.
    5258
    53 == [ticket-workflow] == #ticket-workflow-section
    54 ''(since 0.11)''
    55 
    56 The workflow for tickets is controlled by plugins.
    57 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    58 That component allows the workflow to be configured via this section in the trac.ini file.
    59 See TracWorkflow for more details.
    60 
    61 == [milestone-groups] == #milestone-groups-section
     59=== [milestone-groups] === #milestone-groups-section
    6260''(since 0.11)''
    6361
    … …  
    7068{{{
    7169closed = 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
     70# sequence number in the progress bar
     71closed.order = 0
     72# optional extra param for the query (two additional columns: created and modified and sort on created)
     73closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     74# indicates groups that count for overall completion percentage
     75closed.overall_completion = true
    7576
    7677new = new
    … …  
    7980new.label = new
    8081
    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
     82# one catch-all group is allowed
     83active = *
     84active.order = 2
     85# CSS class for this interval
     86active.css_class = open
     87# Displayed label for this group
     88active.label = in progress
    8589}}}
    8690
    … …  
    9397selector:  `table.progress td.<class>`
    9498
    95 == [svn:externals] == #svn:externals-section
     99=== [repositories] === #repositories-section
     100
     101(''since 0.12'' multirepos)
     102
     103One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     104
     105This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     106
     107See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     108
     109=== [svn:externals] === #svn:externals-section
    96110''(since 0.11)''
    97111
    98 The 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.
     112The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
     113By default, it only turns the URLs into links as Trac can't browse remote repositories.
     114
     115However, 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.
    100116
    101117This mapping is done in the `[svn:externals]` section of the TracIni
    … …  
    104120{{{
    105121[svn:externals]
    106 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
    107 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
     1221 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1232 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    1081243 = 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
     1254 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
    110126}}}
    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).
     127With 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).
    112128
    113129Note 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.
    114130
     131Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
     132
     133=== [ticket-custom] === #ticket-custom-section
     134
     135In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     136
     137=== [ticket-workflow] === #ticket-workflow-section
     138''(since 0.11)''
     139
     140The workflow for tickets is controlled by plugins.
     141By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     142That component allows the workflow to be configured via this section in the trac.ini file.
     143See TracWorkflow for more details.
     144
    115145----
    116146See also: TracGuide, TracAdmin, TracEnvironment