Changes between Version 1 and Version 2 of TracIni
- Timestamp:
- Jan 5, 2015 9:18:54 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracIni
v1 v2 1 1 = The Trac Configuration File = 2 2 3 [[TracGuideToc]] 3 4 … … 13 14 {{{ 14 15 [inherit] 15 file = / usr/share/trac/conf/trac.ini16 file = /path/to/global/trac.ini 16 17 }}} 18 Multiple files can be specified using a comma-separated list. 17 19 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.inifile and delete the entries that will otherwise override those set in the global file.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. 19 21 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. 20 23 21 == Reference == 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). 22 25 23 This is a brief reference of available configuration options. 26 == Reference for settings 24 27 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.'' 28 This is a brief reference of available configuration options, and their default settings. 26 29 27 [[TracIni ()]]30 [[TracIni]] 28 31 32 == Reference for special sections 33 [[PageOutline(3,,inline)]] 29 34 30 == [components]== #components-section35 === [components] === #components-section 31 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. 32 37 … … 46 51 See also: TracPlugins 47 52 48 == [ticket-custom] == #ticket-custom-section 49 50 In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 51 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 53 === [milestone-groups] === #milestone-groups-section 61 54 ''(since 0.11)'' 62 55 … … 72 65 closed.order = 0 73 66 # 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=changetime75 # indicates groups that count for overall completion 76 closed.overall_completion = true percentage67 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 77 70 78 71 new = new … … 98 91 selector: `table.progress td.<class>` 99 92 100 == [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 101 104 ''(since 0.11)'' 102 105 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. 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. 105 110 106 111 This mapping is done in the `[svn:externals]` section of the TracIni … … 109 114 {{{ 110 115 [svn:externals] 111 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev112 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev116 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 117 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 113 118 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 114 119 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=$rev … … 120 125 Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. 121 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 122 139 ---- 123 140 See also: TracGuide, TracAdmin, TracEnvironment