| 1 | = The Trac Configuration File = |
| 2 | |
| 3 | [[TracGuideToc]] |
| 4 | [[PageOutline]] |
| 5 | |
| 6 | 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. |
| 7 | |
| 8 | The `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. |
| 9 | |
| 10 | == Global Configuration == |
| 11 | |
| 12 | 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. |
| 13 | |
| 14 | Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: |
| 15 | {{{ |
| 16 | [inherit] |
| 17 | file = /path/to/global/trac.ini |
| 18 | }}} |
| 19 | Multiple files can be specified using a comma-separated list. |
| 20 | |
| 21 | 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. |
| 22 | |
| 23 | 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. |
| 24 | |
| 25 | 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). |
| 26 | |
| 27 | == Reference for settings |
| 28 | |
| 29 | This is a brief reference of available configuration options, and their default settings. |
| 30 | |
| 31 | [[TracIni]] |
| 32 | |
| 33 | == Reference for special sections |
| 34 | [[PageOutline(3,,inline)]] |
| 35 | |
| 36 | === [components] === #components-section |
| 37 | 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. |
| 38 | |
| 39 | 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. |
| 40 | |
| 41 | Consider the following configuration snippet: |
| 42 | {{{ |
| 43 | [components] |
| 44 | trac.ticket.report.ReportModule = disabled |
| 45 | webadmin.* = enabled |
| 46 | }}} |
| 47 | |
| 48 | 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. |
| 49 | |
| 50 | See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) |
| 51 | |
| 52 | See also: TracPlugins |
| 53 | |
| 54 | === [extra-permissions] === #extra-permissions-section |
| 55 | ''(since 0.12)'' |
| 56 | |
| 57 | Custom additional permissions can be defined in this section when [wiki:ExtraPermissionsProvider] is enabled. |
| 58 | |
| 59 | === [milestone-groups] === #milestone-groups-section |
| 60 | ''(since 0.11)'' |
| 61 | |
| 62 | As the workflow for tickets is now configurable, there can be many ticket states, |
| 63 | and simply displaying closed tickets vs. all the others is maybe not appropriate |
| 64 | in all cases. This section enables one to easily create ''groups'' of states |
| 65 | that will be shown in different colors in the milestone progress bar. |
| 66 | |
| 67 | Example configuration (the default only has closed and active): |
| 68 | {{{ |
| 69 | closed = closed |
| 70 | # sequence number in the progress bar |
| 71 | closed.order = 0 |
| 72 | # optional extra param for the query (two additional columns: created and modified and sort on created) |
| 73 | 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 |
| 74 | # indicates groups that count for overall completion percentage |
| 75 | closed.overall_completion = true |
| 76 | |
| 77 | new = new |
| 78 | new.order = 1 |
| 79 | new.css_class = new |
| 80 | new.label = new |
| 81 | |
| 82 | # one catch-all group is allowed |
| 83 | active = * |
| 84 | active.order = 2 |
| 85 | # CSS class for this interval |
| 86 | active.css_class = open |
| 87 | # Displayed label for this group |
| 88 | active.label = in progress |
| 89 | }}} |
| 90 | |
| 91 | The definition consists in a comma-separated list of accepted status. |
| 92 | Also, '*' means any status and could be used to associate all remaining |
| 93 | states to one catch-all group. |
| 94 | |
| 95 | The CSS class can be one of: new (yellow), open (no color) or |
| 96 | closed (green). New styles can easily be added using the following |
| 97 | selector: `table.progress td.<class>` |
| 98 | |
| 99 | === [repositories] === #repositories-section |
| 100 | |
| 101 | (''since 0.12'' multirepos) |
| 102 | |
| 103 | One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. |
| 104 | |
| 105 | This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. |
| 106 | |
| 107 | See [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 |
| 110 | ''(since 0.11)'' |
| 111 | |
| 112 | The TracBrowser for Subversion can interpret the `svn:externals` property of folders. |
| 113 | By default, it only turns the URLs into links as Trac can't browse remote repositories. |
| 114 | |
| 115 | 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. |
| 116 | |
| 117 | This mapping is done in the `[svn:externals]` section of the TracIni |
| 118 | |
| 119 | Example: |
| 120 | {{{ |
| 121 | [svn:externals] |
| 122 | 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev |
| 123 | 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev |
| 124 | 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 |
| 125 | 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=$rev |
| 126 | }}} |
| 127 | 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). |
| 128 | |
| 129 | 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. |
| 130 | |
| 131 | Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. |
| 132 | |
| 133 | === [ticket-custom] === #ticket-custom-section |
| 134 | |
| 135 | In 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 | |
| 140 | The workflow for tickets is controlled by plugins. |
| 141 | By default, there's only a `ConfigurableTicketWorkflow` component in charge. |
| 142 | That component allows the workflow to be configured via this section in the trac.ini file. |
| 143 | See TracWorkflow for more details. |
| 144 | |
| 145 | ---- |
| 146 | See also: TracGuide, TracAdmin, TracEnvironment |