The Trac Configuration File
Table of Contents
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.
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.
Global Configuration
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.
Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
[inherit] file = /usr/share/trac/conf/trac.ini
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 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.ini file and delete the entries that will otherwise override those set in the global file.
Reference
This is a brief reference of available configuration options.
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.
[attachment]
| render_unsafe_content | Whether attachments should be rendered in the browser, or only made downloadable. Pretty much any file may be interpreted as HTML by the browser, which allows a malicious user to attach a file containing cross-site scripting attacks. For public sites where anonymous users can create attachments it is recommended to leave this option disabled (which is the default). |
| max_size | Maximum allowed file size for ticket and wiki attachments. |
[browser]
| downloadable_paths | List of repository paths that can be downloaded. Leave the option empty if you want to disable all downloads, otherwise set it to a comma-separated list of authorized paths (those paths are glob patterns, i.e. "*" can be used as a wild card) (since 0.10) |
| render_unsafe_content | Whether attachments should be rendered in the browser, or only made downloadable. Pretty much any file may be interpreted as HTML by the browser, which allows a malicious user to attach a file containing cross-site scripting attacks. For public sites where anonymous users can create attachments it is recommended to leave this option disabled (which is the default). |
| hide_properties | List of subversion properties to hide from the repository browser (since 0.9) |
[changeset]
| wiki_format_messages | Whether wiki formatting should be applied to changeset messages. If this option is disabled, changeset messages will be rendered as pre-formatted text. |
| max_diff_files | Maximum number of modified files for which the changeset view will attempt to show the diffs inlined (since 0.10). |
| max_diff_bytes | Maximum total size in bytes of the modified files (their old size plus their new size) for which the changeset view will attempt to show the diffs inlined (since 0.10). |
[header_logo]
| src | URL of the image to use as header logo. |
| height | Height of the header logo image in pixels. |
| link | URL to link to from header logo. |
| alt | Alternative text for the header logo. |
| width | Width of the header logo image in pixels. |
[logging]
| log_type | Logging facility to use. Should be one of (none, file, stderr, syslog, winlog). |
| log_level | Level of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG). |
| log_format | Custom logging format. If nothing is set, the following will be used: Trac[$(module)s] $(levelname)s: $(message)s In addition to regular key names supported by the Python logger library library (see http://docs.python.org/lib/node422.html), one could use: - $(path)s the path for the current environment - $(basename)s the last path component of the current environment - $(project)s the project name Note the usage of $(...)s instead of %(...)s as the latter form would be interpreted by the ConfigParser? itself. Example: ($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s (since 0.11) |
| log_file | If log_type is file, this should be a path to the log-file. |
[mimeviewer]
| enscript_modes | List of additional MIME types known by Enscript. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding Enscript mode to be used for the conversion and quality is the quality ratio associated to this conversion. That can also be used to override the default quality ratio used by the Enscript render, which is 2 (since 0.10). |
| tab_width | Displayed tab width in file preview (since 0.9). |
| silvercity_modes | List of additional MIME types known by SilverCity?. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding SilverCity? mode to be used for the conversion and quality is the quality ratio associated to this conversion. That can also be used to override the default quality ratio used by the SilverCity? render, which is 3 (since 0.10). |
| php_path | Path to the PHP executable (since 0.9). |
| enscript_path | Path to the Enscript executable. |
| max_preview_size | Maximum file size for HTML preview. (since 0.9). |
| mime_map | List of additional MIME types and keyword mappings. Mappings are comma-separated, and for each MIME type, there's a colon (":") separated list of associated keywords or file extensions. (since 0.10). |
[notification]
| always_notify_reporter | Always send notifications to any address in the reporter field. |
| always_notify_owner | Always send notifications to the ticket owner (since 0.9). |
| smtp_subject_prefix | Text to prepend to subject line of notification emails. If the setting is not defined, then the [$project_name] prefix. If no prefix is desired, then specifying an empty option will disable it.(since 0.10.1). |
| smtp_always_bcc | Email address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10). |
| smtp_replyto | Reply-To address to use in notification emails. |
| smtp_port | SMTP server port to use for email notification. |
| use_tls | Use SSL/TLS to send notifications (since 0.10). |
| smtp_enabled | Enable SMTP (email) notification. |
| smtp_from | Sender address to use in notification emails. |
| always_notify_updater | Always send notifications to the person who causes the ticket property change. |
| mime_encoding | Specifies the MIME encoding scheme for emails. Valid options are 'base64' for Base64 encoding, 'qp' for Quoted-Printable, and 'none' for no encoding. Note that the no encoding means that non-ASCII characters in text are going to cause problems with notifications (since 0.10). |
| smtp_always_cc | Email address(es) to always send notifications to, addresses can be see by all recipients (Cc:). |
| smtp_default_domain | Default host/domain to append to address that do not specify one |
| smtp_password | Password for SMTP server. (since 0.9). |
| smtp_server | SMTP server hostname to use for email notifications. |
| smtp_user | Username for SMTP server. (since 0.9). |
| use_short_addr | Permit email address without a host/domain (i.e. username only) The SMTP server should accept those addresses, and either append a FQDN or use local delivery (since 0.10). |
| use_public_cc | Recipients can see email addresses of other CC'ed recipients. If this option is disabled (the default), recipients are put on BCC (since 0.10). |
[project]
| descr | Short description of the project. |
| url | URL of the main project web site. |
| icon | URL of the icon of the project. |
| name | Name of the project. |
| footer | Page footer text (right-aligned). |
[search]
| min_query_length | Minimum length of query string allowed when performing a search. |
[ticket]
| default_type | Default type for newly created tickets (since 0.9). |
| default_priority | Default priority for newly created tickets. |
| restrict_owner | Make the owner field of tickets use a drop-down menu. See Assign-to as Drop-Down List (since 0.9). |
| default_milestone | Default milestone for newly created tickets. |
| default_component | Default component for newly created tickets |
| default_version | Default version for newly created tickets. |
[timeline]
| ticket_show_details | Enable the display of all ticket changes in the timeline (since 0.9). |
| changeset_long_messages | Whether wiki-formatted changeset messages should be multiline or not. If this option is not specified or is false and wiki_format_messages is set to true, changeset messages will be single line only, losing some formatting (bullet points, etc). |
| changeset_show_files | Number of files to show (-1 for unlimited, 0 to disable). |
| default_daysback | Default number of days displayed in the Timeline, in days. (since 0.9.) |
[trac]
| permission_store | Name of the component implementing IPermissionStore, which is used for managing user and group permissions. |
| mainnav | List of item IDs to display in the navigation bar mainnav. |
| templates_dir | Path to the ClearSilver templates. |
| metanav | List of items IDs to display in the navigation bar metanav. |
| authz_module_name | The module prefix used in the authz_file. |
| default_handler | Name of the component that handles requests to the base URL. Options include TimelineModule, RoadmapModule, BrowserModule, QueryModule, ReportModule and NewticketModule (since 0.9). |
| htdocs_location | Base URL of the core static resources. |
| authz_file | Path to Subversion authorization (authz) file |
| repository_dir | Path to local repository |
| check_auth_ip | Whether the IP address of the user should be checked for authentication (since 0.9). |
| database | Database connection string for this project |
| repository_type | Repository connector type. (since 0.10) |
| default_charset | Charset to be used when in doubt. |
| ignore_auth_case | Whether case should be ignored for login names (since 0.9). |
| request_filters | Ordered list of filters to apply to all requests (since 0.10). |
| base_url | Base URL of the Trac deployment. In most configurations, Trac will automatically reconstruct the URL that is used to access it automatically. However, in more complex setups, usually involving running Trac behind a HTTP proxy, you may need to use this option to force Trac to use the correct URL. |
| timeout | Timeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11) |
[wiki]
| ignore_missing_pages | Enable/disable highlighting CamelCase links to missing pages (since 0.9). |
| split_page_names | Enable/disable splitting the WikiPageNames with space characters (since 0.10). |
| render_unsafe_content | Enable/disable the use of unsafe HTML tags such as <script> or <embed> with the HTML WikiProcessor (since 0.10.4). For public sites where anonymous users can edit the wiki it is recommended to leave this option disabled (which is the default). |
[components]
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.
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.
Consider the following configuration snippet:
[components] trac.ticket.report.ReportModule = disabled webadmin.* = enabled
The first option tells Trac to disable the 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.
See the Plugins page on About Trac to get the list of active components (requires CONFIG_VIEW permissions.)
See also: TracPlugins
[ticket-custom]
In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
[ticket-workflow]
(since 0.11)
The workflow for tickets is controlled by plugins. By default, there's only a ConfigurableTicketWorkflow component in charge. That component allows the workflow to be configured via this section in the trac.ini file. See TracWorkflow for more details.
[milestone-groups]
(since 0.11)
As the workflow for tickets is now configurable, there can be many ticket states, and simply displaying closed tickets vs. all the others is maybe not appropriate in all cases. This section enables one to easily create groups of states that will be shown in different colors in the milestone progress bar.
Example configuration (the default only has closed and active):
closed = closed # sequence number in the progress bar closed.order = 0 # optional extra param for the query (two additional columns: created and modified and sort on created) group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime # indicates groups that count for overall completion closed.overall_completion = truepercentage new = new new.order = 1 new.css_class = new new.label = new # one catch-all group is allowed active = * active.order = 2 # CSS class for this interval active.css_class = open # Displayed label for this group active.label = in progress
The definition consists in a comma-separated list of accepted status. Also, '*' means any status and could be used to associate all remaining states to one catch-all group.
The CSS class can be one of: new (yellow), open (no color) or closed (green). New styles can easily be added using the following selector: table.progress td.<class>
[svn:externals]
(since 0.11)
The TracBrowser for Subversion can interpret the svn:externals property of folders out of the box. 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 ViewVC is desired, then Trac needs to be able to map an external prefix to this other URL.
This mapping is done in the [svn:externals] section of the TracIni
Example:
[svn:externals] 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=$rev
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 SVN Book on externals for more details).
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.
Finally, the relative URLs introduced in Subversion 1.5 are not yet supported.
See also: TracGuide, TracAdmin, TracEnvironment
