Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Nov 10, 2014, 5:13:32 PM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v2  
    11= The Trac Configuration File = 
    22 
     3 ''[Note To Editors] Please discuss documentation changes in the [#Discussion] section. Even better, send us [TracDev/SubmittingPatches documentation patches] against the ''code'' (i.e. where the configuration entries are documented), either on Trac-dev or on new tickets. '' 
     4 
    35[[TracGuideToc]] 
     6[[PageOutline]] 
    47 
    58Trac 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. 
    69 
    7 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. 
     10The `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. 
    811 
    912== Global Configuration == 
     
    3033[[TracIni]] 
    3134 
    32 == Reference for special sections 
    33 [[PageOutline(3,,inline)]] 
    34  
    35 === [components] === #components-section 
    36 This 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. 
    37  
    38 The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module. 
    39  
    40 Consider the following configuration snippet: 
    41 {{{ 
    42 [components] 
    43 trac.ticket.report.ReportModule = disabled 
    44 webadmin.* = enabled 
    45 }}} 
    46  
    47 The first option tells Trac to disable the [wiki:TracReports report module]. The second option instructs Trac to enable all components in the `webadmin` package. Note that the trailing wildcard is required for module/package matching. 
    48  
    49 See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    50  
    51 See also: TracPlugins 
    52  
    53 === [milestone-groups] === #milestone-groups-section 
    54 ''(since 0.11)'' 
    55  
    56 As the workflow for tickets is now configurable, there can be many ticket states, 
    57 and simply displaying closed tickets vs. all the others is maybe not appropriate  
    58 in all cases. This section enables one to easily create ''groups'' of states  
    59 that will be shown in different colors in the milestone progress bar. 
    60  
    61 Example configuration (the default only has closed and active): 
    62 {{{ 
    63 closed = closed 
    64 # sequence number in the progress bar 
    65 closed.order = 0 
    66 # optional extra param for the query (two additional columns: created and modified and sort on created) 
    67 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 
    68 # indicates groups that count for overall completion percentage 
    69 closed.overall_completion = true 
    70  
    71 new = new 
    72 new.order = 1 
    73 new.css_class = new 
    74 new.label = new 
    75  
    76 # one catch-all group is allowed 
    77 active = * 
    78 active.order = 2 
    79 # CSS class for this interval 
    80 active.css_class = open 
    81 # Displayed label for this group 
    82 active.label = in progress 
    83 }}} 
    84  
    85 The definition consists in a comma-separated list of accepted status. 
    86 Also, '*' means any status and could be used to associate all remaining 
    87 states to one catch-all group. 
    88  
    89 The CSS class can be one of: new (yellow), open (no color) or 
    90 closed (green). New styles can easily be added using the following 
    91 selector:  `table.progress td.<class>` 
    92  
    93 === [repositories] === #repositories-section 
    94  
    95 (''since 0.12'' multirepos) 
    96  
    97 One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. 
    98  
    99 This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. 
    100  
    101 See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. 
    102  
    103 === [svn:externals] === #svn:externals-section 
    104 ''(since 0.11)'' 
    105  
    106 The TracBrowser for Subversion can interpret the `svn:externals` property of folders. 
    107 By default, it only turns the URLs into links as Trac can't browse remote repositories. 
    108  
    109 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. 
    110  
    111 This mapping is done in the `[svn:externals]` section of the TracIni 
    112  
    113 Example: 
    114 {{{ 
    115 [svn:externals] 
    116 1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 
    117 2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 
    118 3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
    119 4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev 
    120 }}} 
    121 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). 
    122  
    123 Note 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. 
    124  
    125 Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 
    126  
    127 === [ticket-custom] === #ticket-custom-section 
    128  
    129 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
    130  
    131 === [ticket-workflow] === #ticket-workflow-section 
    132 ''(since 0.11)'' 
    133  
    134 The workflow for tickets is controlled by plugins.  
    135 By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
    136 That component allows the workflow to be configured via this section in the trac.ini file. 
    137 See TracWorkflow for more details. 
    138  
    13935---- 
    14036See also: TracGuide, TracAdmin, TracEnvironment