Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
Jul 6, 2013 6:47:50 PM (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v2 v3  
    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
    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.
     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.
    79
    810== Global Configuration ==
     
    1315{{{
    1416[inherit]
    15 file = /usr/share/trac/conf/trac.ini
     17file = /path/to/global/trac.ini
    1618}}}
     19Multiple files can be specified using a comma-separated list.
    1720
    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.
     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.
    1922
     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.
    2024
    21 == 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).
    2226
    23 This is a brief reference of available configuration options.
     27== Reference for settings
    2428
    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.''
     29This is a brief reference of available configuration options, and their default settings.
    2630
    27 [[TracIni()]]
     31[[TracIni]]
    2832
     33== Reference for special sections
     34[[PageOutline(3,,inline)]]
    2935
    30 == [components] == #components-section
     36=== [components] === #components-section
    3137This 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.
    3238
     
    4652See also: TracPlugins
    4753
    48 == [ticket-custom] == #ticket-custom-section
     54=== [extra-permissions] === #extra-permissions-section
     55''(since 0.12)''
    4956
    50 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.
    5158
    52 == [ticket-workflow] == #ticket-workflow-section
    53 ''(since 0.11)''
    54 
    55 The workflow for tickets is controlled by plugins.
    56 By default, there's only a `ConfigurableTicketWorkflow` component in charge.
    57 That component allows the workflow to be configured via this section in the trac.ini file.
    58 See TracWorkflow for more details.
    59 
    60 == [milestone-groups] == #milestone-groups-section
     59=== [milestone-groups] === #milestone-groups-section
    6160''(since 0.11)''
    6261
     
    7271closed.order = 0
    7372# optional extra param for the query (two additional columns: created and modified and sort on created)
    74 group=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
    76 closed.overall_completion = truepercentage
     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
    7776
    7877new = new
     
    9897selector:  `table.progress td.<class>`
    9998
    100 == [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
    101110''(since 0.11)''
    102111
    103 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
    104 However, 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.
     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.
    105116
    106117This mapping is done in the `[svn:externals]` section of the TracIni
     
    109120{{{
    110121[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
     1221 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1232 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
    1131243 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
    1141254 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
     
    120131Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
    121132
     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
    122145----
    123146See also: TracGuide, TracAdmin, TracEnvironment