Changes between Version 1 and Version 2 of TracIni
- Timestamp:
- Oct 20, 2012 6:38:57 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracIni
v1 v2 1 1 = The Trac Configuration File = 2 2 3 [[TracGuideToc]] 3 4 4 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. 5 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. 8 6 9 == Global Configuration == 7 10 8 In previous versions, 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.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 13 Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 11 14 {{{ 12 15 [inherit] 13 file = / usr/share/trac/conf/trac.ini16 file = /path/to/global/trac.ini 14 17 }}} 18 Multiple files can be specified using a comma-separated list. 15 19 16 == 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. 17 21 18 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. 19 29 20 30 [[TracIni]] 21 31 22 == [components] == #components-section 32 == Reference for special sections 33 [[PageOutline(3,,inline)]] 34 35 === [components] === #components-section 23 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. 24 37 … … 38 51 See also: TracPlugins 39 52 40 == [ticket-custom] == #ticket-custom-section 41 42 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 43 44 == [ticket-workflow] == #ticket-workflow-section 45 ''(since 0.11)'' 46 47 The workflow for tickets is controlled by plugins. 48 By default, there's only a `ConfigurableTicketWorkflow` component in charge. 49 That component allows the workflow to be configured via this section in the trac.ini file. 50 See TracWorkflow for more details. 51 52 == [milestone-groups] == #milestone-groups-section 53 === [milestone-groups] === #milestone-groups-section 53 54 ''(since 0.11)'' 54 55 … … 58 59 that will be shown in different colors in the milestone progress bar. 59 60 60 Example configuration ( which is also the default):61 Example configuration (the default only has closed and active): 61 62 {{{ 62 63 closed = closed 63 closed.order = 0 # sequence number in the progress bar 64 closed.query_args = group=resolution # optional extra param for the query 65 closed.overall_completion = true # count for overall completion 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 66 70 67 active = * # one catch-all group is allowed 68 active.order = 1 69 active.css_class = open # CSS class for this interval 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 70 83 }}} 71 84 … … 78 91 selector: `table.progress td.<class>` 79 92 80 == [svn:externals] == #svn:externals-section 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 81 104 ''(since 0.11)'' 82 105 83 The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 84 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. 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. 85 110 86 111 This mapping is done in the `[svn:externals]` section of the TracIni … … 89 114 {{{ 90 115 [svn:externals] 91 http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 92 svn://anotherserver.com/tools_repository http://ourserver/trac/support/browser/$path?rev=$rev 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 93 120 }}} 94 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).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). 95 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. 96 138 97 139 ----
