Edgewall Software

The Trac Configuration File

Trac configuration is done by editing the trac.ini config file, located in <projectenv>/conf/trac.ini.

Global Configuration

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.

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.

Reference

This is a brief reference of available configuration options.

[attachment]

max_sizeMaximum allowed file size (in bytes) for ticket and wiki attachments.
render_unsafe_contentWhether 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).

[bitten]

adjust_timestampsWhether the timestamps of builds should be adjusted to be close to the timestamps of the corresponding changesets.
build_allWhether to request builds of older revisions even if a younger revision has already been built.
chart_styleStyle attribute for charts. Mostly useful for setting the height and width.
logs_dirThe directory on the server in which client log files will be stored.
quick_statusWhether to show the current build status within the Trac main navigation bar. Note: The feature requires expensive database and repository checks for every page request, and should not be enabled if the project has a large repository or uses a non-Subversion repository such as Mercurial or Git.
slave_timeoutThe time in seconds after which a build is cancelled if the slave does not report progress.
stabilize_waitThe time in seconds to wait for the repository to stabilize before queuing up a new build. This allows time for developers to check in a group of related changes back to back without spawning multiple builds.

[browser]

color_scaleEnable colorization of the age column. This uses the same color scale as the source code annotation: blue is older, red is newer. (since 0.11)
downloadable_pathsList 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)
hide_propertiesComma-separated list of version control properties to hide from the repository browser. (since 0.9)
intermediate_color(r,g,b) color triple to use for the color corresponding to the intermediate color, if two linear interpolations are used for the color scale (see intermediate_point). If not set, the intermediate color between oldest_color and newest_color will be used. (since 0.11)
intermediate_pointIf set to a value between 0 and 1 (exclusive), this will be the point chosen to set the intermediate_color for interpolating the color value. (since 0.11)
newest_color(r,g,b) color triple to use for the color corresponding to the newest color, for the color scale used in blame or the browser age column if color_scale is enabled. (since 0.11)
oldest_color(r,g,b) color triple to use for the color corresponding to the oldest color, for the color scale used in blame or the browser age column if color_scale is enabled. (since 0.11)
oneliner_propertiesComma-separated list of version control properties to render as oneliner wiki content in the repository browser. (since 0.11)
render_unsafe_contentWhether raw files 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 create a file containing cross-site scripting attacks. For open repositories where anyone can check-in a file, it is recommended to leave this option disabled (which is the default).
wiki_propertiesComma-separated list of version control properties to render as wiki content in the repository browser. (since 0.11)

[changeset]

max_diff_bytesMaximum 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).
max_diff_filesMaximum number of modified files for which the changeset view will attempt to show the diffs inlined (since 0.10).
wiki_format_messagesWhether wiki formatting should be applied to changeset messages. If this option is disabled, changeset messages will be rendered as pre-formatted text.

[header_logo]

altAlternative text for the header logo.
heightHeight of the header logo image in pixels.
linkURL to link to from header logo.
srcURL of the image to use as header logo.
widthWidth of the header logo image in pixels.

[inherit]

plugins_dirPath of the directory containing additional plugins. Plugins in that directory are loaded in addition to those in the directory of the environment plugins, with this one taking precedence. (since 0.11)
templates_dirPath to the shared templates directory. Templates in that directory are loaded in addition to those in the environments templates directory, but the latter take precedence. (since 0.11)

[logging]

log_fileIf log_type is file, this should be a path to the log-file.
log_formatCustom 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 Config Parser? itself. Example: ($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s (since 0.10.5)
log_levelLevel of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG).
log_typeLogging facility to use. Should be one of (none, file, stderr, syslog, winlog).

[milestone]

stats_providerName of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the milestone views.

[mimeviewer]

enscript_modesList 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).
enscript_pathPath to the Enscript executable.
max_preview_sizeMaximum file size for HTML preview. (since 0.9)
mime_mapList 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)
php_pathPath to the PHP executable (since 0.9).
pygments_default_styleThe default style to use for Pygments syntax highlighting.
pygments_modesList of additional MIME types known by Pygments. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding Pygments 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 Pygments render.
tab_widthDisplayed tab width in file preview. (since 0.9)
treat_as_binaryComma-separated list of MIME types that should be treated as binary data. (since 0.11.5)

[notification]

admit_domainsComma-separated list of domains that should be considered as valid for email addresses (such as localdomain)
always_notify_ownerAlways send notifications to the ticket owner (since 0.9).
always_notify_reporterAlways send notifications to any address in the reporter field.
always_notify_updaterAlways send notifications to the person who causes the ticket property change and to any previous updater of that ticket.
ignore_domainsComma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains)
mime_encodingSpecifies the MIME encoding scheme for emails. Valid options are 'base64' for Base64 encoding, 'qp' for Quoted-Printable, and 'none' for no encoding, in which case mails will be sent as 7bit if the content is all ASCII, or 8bit otherwise. (since 0.10)
notify_on_failed_buildNotify if bitten build fails.
notify_on_successful_buildNotify if bitten build succeeds.
smtp_always_bccEmail address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10).
smtp_always_ccEmail address(es) to always send notifications to, addresses can be seen by all recipients (Cc:).
smtp_default_domainDefault host/domain to append to address that do not specify one
smtp_enabledEnable SMTP (email) notification.
smtp_fromSender address to use in notification emails.
smtp_from_nameSender name to use in notification emails.
smtp_passwordPassword for SMTP server. (since 0.9).
smtp_portSMTP server port to use for email notification.
smtp_replytoReply-To address to use in notification emails.
smtp_serverSMTP server hostname to use for email notifications.
smtp_subject_prefixText 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_userUsername for SMTP server. (since 0.9).
ticket_subject_templateA Genshi text template snippet used to get the notification subject. By default, the subject template is $prefix #$ticket.id: $summary. $prefix being the value of the smtp_subject_prefix option. (since 0.11)
use_public_ccRecipients can see email addresses of other CC'ed recipients. If this option is disabled (the default), recipients are put on BCC (since 0.10).
use_short_addrPermit 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_tlsUse SSL/TLS to send notifications (since 0.10).

[project]

adminE-Mail address of the project's administrator.
admin_trac_urlBase URL of a Trac instance where errors in this Trac should be reported. This can be an absolute or relative URL, or '.' to reference this Trac instance. An empty value will disable the reporting buttons. (since 0.11.3)
descrShort description of the project.
footerPage footer text (right-aligned).
iconURL of the icon of the project.
nameName of the project.
urlURL of the main project web site, usually the website in which the base_url resides.

[query]

default_anonymous_queryThe default query for anonymous users. The query is either in query language syntax, or a URL query string starting with ? as used in query: Trac links. (since 0.11.2)
default_queryThe default query for authenticated users. The query is either in query language syntax, or a URL query string starting with ? as used in query: Trac links. (since 0.11.2)
items_per_pageNumber of tickets displayed per page in ticket queries, by default (since 0.11)

[report]

items_per_pageNumber of tickets displayed per page in ticket reports, by default (since 0.11)
items_per_page_rssNumber of tickets displayed in the rss feeds for reports (since 0.11)

[revisionlog]

default_log_limitDefault value for the limit argument in the Trac Revision Log (since 0.11).

[roadmap]

stats_providerName of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the roadmap views.

[search]

min_query_lengthMinimum length of query string allowed when performing a search.

[spam-filter]

akismet_api_keyWordpress key required to use the Akismet API.
akismet_api_urlURL of the Akismet service.
akismet_karmaBy how many points an Akismet reject impacts the overall karma of a submission.
attachment_sample_sizeThe number of bytes from an attachment to pass through the spam filters.
bayes_karmaBy what factor Bayesian spam probability score affects the overall karma of a submission.
bayes_min_trainingThe minimum number of submissions in the training database required for the filter to start impacting the karma of submissions.
extlinks_karmaBy how many points too many external links in a submission impact the overall score.
ip_blacklist_karmaBy how many points blacklisting by a single server impacts the overall karma of a submission.
ip_blacklist_serversServers used for IP blacklisting.
ip_throttle_karmaBy how many points exceeding the configured maximum number of posts per hour impacts the overall score.
logging_enabledWhether all content submissions and spam filtering activity should be logged to the database.
max_external_linksThe maximum number of external links allowed in a submission until that submission gets negative karma.
max_posts_by_ipThe maximum allowed number of submissions per hour form a single IP address. If this limit is exceeded, subsequent permissions get negative karma.
min_karmaThe minimum score required for a submission to be allowed.
purge_ageThe number of days after which log entries should be purged.
regex_karmaBy how many points a match with a pattern on the Bad Content page impacts the overall karma of a submission.
session_karmaBy how many points an existing and configured session improves the overall karma of the submission. A third of the points is granted for having an existing session at all, the other two thirds are granted when the user has his name and/or email address set in the session, respectively.
trust_authenticatedWhether content submissions by authenticated users should be trusted without checking for potential spam or other abuse.

[svn]

branchesComma separated list of paths categorized as branches. If a path ends with '*', then all the directory entries found below that path will be included. Example: /trunk, /branches/*, /projectAlpha/trunk, /sandbox/*
tagsComma separated list of paths categorized as tags. If a path ends with '*', then all the directory entries found below that path will be included. Example: /tags/*, /projectAlpha/tags/A-1.0, /projectAlpha/tags/A-v1.1

[ticket]

default_ccDefault cc: list for newly created tickets.
default_componentDefault component for newly created tickets.
default_descriptionDefault description for newly created tickets.
default_keywordsDefault keywords for newly created tickets.
default_milestoneDefault milestone for newly created tickets.
default_ownerDefault owner for newly created tickets.
default_priorityDefault priority for newly created tickets.
default_resolutionDefault resolution for resolving (closing) tickets (since 0.11).
default_severityDefault severity for newly created tickets.
default_summaryDefault summary (title) for newly created tickets.
default_typeDefault type for newly created tickets (since 0.9).
default_versionDefault version for newly created tickets.
max_comment_sizeDon't accept tickets with a too big comment. (since 0.11.2)
max_description_sizeDon't accept tickets with a too big description. (since 0.11).
preserve_newlinesWhether Wiki formatter should respect the new lines present in the Wiki text. If set to 'default', this is equivalent to 'yes' for new environments but keeps the old behavior for upgraded environments (i.e. 'no'). (since 0.11).
restrict_ownerMake the owner field of tickets use a drop-down menu. Be sure to understand the performance implications before activating this option. See Assign-to as Drop-Down List (since 0.9).
workflowOrdered list of workflow controllers to use for ticket actions (since 0.11).

[timeline]

abbreviated_messagesWhether wiki-formatted event messages should be truncated or not. This only affects the default rendering, and can be overriden by specific event providers, see their own documentation. (Since 0.11)
changeset_collapse_eventsWhether consecutive changesets from the same author having exactly the same message should be presented as one event. That event will link to the range of changesets in the log view. (since 0.11)
changeset_long_messagesWhether 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_filesNumber of files to show (-1 for unlimited, 0 to disable). This can also be location, for showing the common prefix for the changed files. (since 0.11).
default_daysbackDefault number of days displayed in the Timeline, in days. (since 0.9.)
max_daysbackMaximum number of days (-1 for unlimited) displayable in the Timeline. (since 0.11)
newticket_formatterWhich formatter flavor (e.g. 'html' or 'oneliner') should be used when presenting the description for new tickets. If 'oneliner', the [timeline] abbreviated_messages option applies. (since 0.11).
ticket_show_detailsEnable the display of all ticket changes in the timeline, not only open / close operations (since 0.9).

[trac]

authz_filePath to Subversion  authorization (authz) file
authz_module_nameThe module prefix used in the authz_file.
auto_reloadAutomatically reload template files after modification.
backup_dirDatabase backup location
base_urlReference URL for the Trac deployment. This is the base URL that will be used when producing documents that will be used outside of the web browsing context, like for example when inserting URLs pointing to Trac resources in notification e-mails.
check_auth_ipWhether the IP address of the user should be checked for authentication (since 0.9).
databaseDatabase connection string for this project
debug_sqlShow the SQL queries in the Trac log, at DEBUG level. (Since 0.11.5)
default_charsetCharset to be used when in doubt.
default_handlerName of the component that handles requests to the base URL. Options include TimelineModule, RoadmapModule, BrowserModule, QueryModule, ReportModule, TicketModule and WikiModule. The default is WikiModule. (since 0.9)
default_timezoneThe default timezone to use
htdocs_locationBase URL of the core static resources.
ignore_auth_caseWhether login names should be converted to lower case (since 0.9).
mainnavOrder of the items to display in the mainnav navigation bar, listed by IDs. See also Trac Navigation?.
metanavOrder of the items to display in the metanav navigation bar, listed by IDs. See also Trac Navigation?.
mysqldump_pathLocation of mysqldump for MySQL database backups
never_obfuscate_mailtoNever obfuscate mailto: links explicitly written in the wiki, even if show_email_addresses is false or the user has not the EMAIL_VIEW permission (since 0.11.6).
permission_policiesList of components implementing IPermissionPolicy, in the order in which they will be applied. These components manage fine-grained access control to Trac resources. Defaults to the Default Permission Policy? (pre-0.11 behavior) and Legacy Attachment Policy? (map ATTACHMENT_* permissions to realm specific ones)
permission_storeName of the component implementing IPermissionStore, which is used for managing user and group permissions.
pg_dump_pathLocation of pg_dump for Postgres database backups
repository_dirPath to local repository. This can also be a relative path (since 0.11).
repository_typeRepository connector type. (since 0.10)
request_filtersOrdered list of filters to apply to all requests (since 0.10).
secure_cookiesRestrict cookies to HTTPS connections. When true, set the secure flag on all cookies so that they are only sent to the server on HTTPS connections. Use this if your Trac instance is only accessible through HTTPS. (since 0.11.2)
show_email_addressesShow email addresses instead of usernames. If false, we obfuscate email addresses (since 0.11).
show_ip_addressesShow IP addresses for resource edits (e.g. wiki). (since 0.11.3).
timeoutTimeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11)
use_base_url_for_redirectOptionally use [trac] base_url for redirects. In some configurations, usually involving running Trac behind a HTTP proxy, Trac can't automatically reconstruct the URL that is used to access it. You may need to use this option to force Trac to use the base_url setting also for redirects. This introduces the obvious limitation that this environment will only be usable when accessible from that URL, as redirects are frequently used. (since 0.10.5)

[vote]

pathsList of URL paths to allow voting on. Globs are supported.

[wiki]

ignore_missing_pagesEnable/disable highlighting Camel Case links to missing pages (since 0.9).
max_sizeMaximum allowed wiki page size in bytes. (since 0.11.2)
render_unsafe_contentEnable/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).
safe_schemesList of URI schemes considered "safe", that will be rendered as external links even if [wiki] render_unsafe_content is false. (since 0.11.8)
split_page_namesEnable/disable splitting the Wiki Page Names with space characters (since 0.10).

[components]

(since 0.9)

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: Trac Plugins


See also: Trac Guide, Trac Admin, Trac Environment