Changes between Version 1 and Version 2 of TracIni
- Timestamp:
- Nov 27, 2011, 9:53:35 PM (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracIni
v1 v2 1 1 = The Trac Configuration File = 2 2 3 [[TracGuideToc]] 3 4 4 Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. 5 Trac 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. 6 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. 5 8 6 9 == Global Configuration == 7 10 8 Since version 0.9, Trac can also read the configuration from a global `trac.ini` file. These global options will then be merged with the environment-specific options, where local options override global options.11 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. 9 12 10 The global configuration is by default localted in `$prefix/share/trac/conf/trac.ini`. It can be moved to a different location (for example, `/etc/trac.ini`), but that requires changing the file `trac/siteconfig.py` which gets created when Trac is installed. 13 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 14 {{{ 15 [inherit] 16 file = /path/to/global/trac.ini 17 }}} 18 Multiple files can be specified using a comma-separated list. 11 19 12 == Reference == 20 Note 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. 13 21 14 This is a brief reference of available configuration options. 22 There 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. 23 24 Note 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). 25 26 == Reference for settings 27 28 This is a brief reference of available configuration options, and their default settings. 15 29 16 30 [[TracIni]] 17 31 18 == [components] ==19 (''since 0.9'') 32 == Reference for special sections 33 [[PageOutline(3,,inline)]] 20 34 35 === [components] === #components-section 21 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. 22 37 … … 36 51 See also: TracPlugins 37 52 38 ''Note that prior to Trac r2335 (that applies to 0.9b1 and 0.9b2), you would use a `[disabled_components]` section instead. See a [http://projects.edgewall.com/trac/wiki/TracIni?version=42 previous version] of this page for the details.'' 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. 39 138 40 139 ---- 41 140 See also: TracGuide, TracAdmin, TracEnvironment 42