The Trac Configuration File

Global Configuration

In versions prior to 0.11, 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.

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 you would not do this but nevertheless intend to use a global option file with your new environment, you would have to go through the newly generated conf/trac.ini file and delete the entries that would otherwise override those set in the global file.

Reference

This is a brief reference of available configuration options.

[account-manager]

account_changes_notify_addressesList of email addresses that get notified of user changes, ie, new user, password change and delete user.
authentication_url
force_passwd_changeForge the user to change password when it's reset.
generated_password_lengthLength of the randomly-generated passwords created when resetting the password for an account.
hash_method
htdigest_realm
notify_actionsComma separated list of actions to notify of. Available actions 'new', 'change', 'delete'.
password_filePath to the users file. Leave blank to locate the users file by reading svnserve.conf
password_format
password_store

[announcer]

admit_domainsComma-separated list of domains that should be considered as valid for email addresses (such as localdomain)
always_notify_component_ownerWhether or not to notify the owner of the ticket's component.
always_notify_ownerThe always_notify_owner option mimics the option of the same name in the notification section, except users can opt-out in their preferences. Used only if LegacyTicketSubscriber is enabled.
always_notify_reporterThe always_notify_reporter option mimics the option of the same name in the notification section, except users can opt-out in their preferences. Used only if LegacyTicketSubscriber is enabled.
always_notify_updaterThe always_notify_updater option mimics the option of the same name in the notification section, except users can opt-out in their preferences. Used only if LegacyTicketSubscriber is enabled.
ctxtnav_namesText of context navigation entries. An empty list removes them from the context navigation bar.
default_email_formatThe default mime type of the email notifications. This can be overriden on a per user basis through the announcer preferences panel.
email_address_resolversComma seperated list of email resolver components in the order they will be called. If an email address is resolved, the remaining resolvers will no be called.
ignore_cc_changesWhen true, the system will not send out announcement events if the only field that was changed was CC. A change to the CC field that happens at the same as another field will still result in an event being created.
ignore_domainsComma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains)
joinable_groupsJoinable groups represent 'opt-in' groups that users may freely join. The name of the groups should be a simple alphanumeric string. By adding the group name preceeded by @ (such as @sec for the sec group) to the CC field of a ticket, everyone in that group will receive an announcement when that ticket is changed.
mime_encodingSpecifies 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).
never_notify_updaterThe never_notify_updater option mimics the plugin of the same name in the notification section, except users can opt-out in their preferences. Used only if LegacyTicketSubscriber is enabled.
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 see 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_toDefault To: field
smtp_userUsername for SMTP server. (since 0.9).
ticket_email_header_fieldsComma seperated list of fields to appear in tickets. Use * to include all headers.
ticket_email_subjectFormat string for ticket email subject. This is a mini genshi template that is passed the ticket event and action objects.
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_threaded_deliveryIf true, the actual delivery of the message will occur in a separate thread. Enabling this will improve responsiveness for requests that end up with an announcement being sent over email. It requires building Python with threading support enabled-- which is usually the case. To test, start Python and type 'import threading' to see if it raises an error.
use_tlsUse SSL/TLS to send notifications (since 0.10).
watchable_pathsList of URL paths to allow watching. Globs are supported.
wiki_email_diffShould a wiki diff be sent with emails?
wiki_email_subjectFormat string for the wiki email subject. This is a mini genshi template and it is passed the page, event and action objects.

[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).

[autocomplete]

fieldsselect fields to transform to autocomplete text boxes

[autoquery]

excluded_fieldsfields to exclude from AutoQuery markup
query_argsadditional arguments to the query string

[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.
logs_dirThe directory on the server in which client log files will be stored.
quick_statusWhether to show the current build status withing the Trac main navigation bar
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.
ignore patternResource names that match this pattern will not be added to the breadcrumbs trail.
max_crumbsIndicates the maximum number of breadcrumbs to store per user.
pathsList of URL paths to allow breadcrumb tracking. Globs are supported.

[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.

[datefield]

first_dayFirst day of the week. 0 == Sunday.
formatThe format to use for dates. Valid values are dmy, mdy, and ymd.
separatorThe separator character to use for dates.

[discussion]

default_displayDefault display mode of topic message list.
forum_sortColumn by which will be sorted forum lists. Possible values are: id group name subject time moderators description topics replies lasttopic lastreply
forum_sort_directionDirection of forum lists sorting. Possible values are: asc desc.
titleMain navigation bar button title.
topic_sortColumn by which will be sorted topic lists. Possible values are: id forum subject time author body replies lastreply.
topic_sort_directionDirection of topic lists sorting. Possible values are: asc desc.

[downloads]

extList of file extensions allowed to upload.
pathDirectory to store uploaded downloads.
titleMain navigation bar button title.
unique_filenameIf enabled checks if uploaded file has unique name.
visible_fieldsList of downloads table fields that should be visible to users on Downloads section.

[doxygen]

default_documentationDefault documentation project, relative to [doxygen] path. When no explicit path is given in a documentation request, this path will be prepended to the request before looking for documentation files.
default_namespaceDefault namespace to search for named objects in.
encodingDefault encoding used by the generated documentation files.
extSpace separated list of extensions for doxygen managed files.
html_outputDefault documentation project suffix, as generated by Doxygen using the HTML_OUTPUT Doxygen configuration setting.
indexDefault index page to pick in the generated documentation.
pathDirectory containing doxygen generated files.
source_extSpace separated list of source files extensions
titleTitle to use for the main navigation tab.
wiki_indexWiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option.

[fullblog]

default_postnameOption for a default naming scheme for new posts. The string can include substitution markers for time (UTC) and user: %Y=year, %m=month, %d=day, %H=hour, %M=minute, %S=second, $USER. Example template string: %Y/%m/%d/my_topic
month_namesAbility to specify a list of month names for display in groupings. If empty it will make a list from default locale setting. Enter list of 12 months like: month_names = January, February, ..., December
num_items_frontOption to specify how many recent posts to display on the front page of the Blog (and RSS feeds).
personal_blogWhen using the Blog as a personal blog (only one author), setting to 'True' will disable the display of 'Browse by author:' in sidebar, and also removes various author links and references.

[fullblog-notification]

always_notify_authorAlways notify the author of a blog change Defaults to false
from_emailSender address to use in notification emails.
from_nameSender name to use in notification emails. Defaults to project name.
smtp_always_ccComma separated list of email address(es) to always send notifications to. Addresses can be seen by all recipients (Cc:).
subject_templateA Genshi text template snippet used to get the notification subject.

[graphviz]

cache_dirThe directory that will be used to cache the generated images. Note that if different than the default (gvcache), this directory must exist. If not given as an absolute path, the path will be relative to the Trac environment's directory.
cache_managerIf this entry exists and set to true in the configuration file, then the cache management logic will be invoked and the cache_max_size, cache_min_size, cache_max_count and cache_min_count must be defined.
cache_max_countThe maximum number of files that the cache should contain. This is the high watermark for the directory entry count.
cache_max_sizeThe maximum size in bytes that the cache should consume. This is the high watermark for disk space used.
cache_min_countThe minimum number of files that the cache should contain. This is the low watermark for the directory entry count.
cache_min_sizeWhen cleaning out the cache, remove files until this size in bytes is used by the cache. This is the low watermark for disk space used.
cmd_pathFull path to the directory where the graphviz programs are located. If not specified, the default is /usr/bin on Linux, C:\Program Files\ATT\Graphviz\bin on Windows and /usr/local/bin on FreeBSD 6.
default_graph_dpiDefault dpi setting for graphviz, used during SVG to PNG rasterization.
encodingThe encoding which should be used for communicating with Graphviz (should match -Gcharset if given).
out_formatGraph output format. Valid formats are: png, jpg, svg, svgz, gif. If not specified, the default is png. This setting can be overrided on a per-graph basis.
png_antialiasIf this entry exists in the configuration file, then PNG outputs will be antialiased. Note that this requires rsvg to be installed.
processorGraphviz default processor. Valid processors are: dot, neato, twopi, fdp, circo. If not specified, the default is dot. This setting can be overrided on a per-graph basis. GraphvizMacro will verify that the default processor is installed and will not work if it is missing. All other processors are optional. If any of the other processors are missing, a warning message will be sent to the trac log and GraphvizMacro will continue to work.
rsvg_pathFull path to the rsvg program (including the filename). The default is <cmd_path>/rsvg.

[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.

[httpauth]

formatsRequest formats to force HTTP authentication on
pathsPaths to force HTTP authentication on.

[hudson]

alternate_success_iconUse an alternate success icon (green ball instead of blue)
display_build_descriptionsWhether to display the build descriptions for each build instead of the canned "Build finished successfully" etc messages.
display_in_new_tabOpen hudson page in new tab/window
display_modulesDisplay status of modules in the timeline too. Note: enabling this may slow down the timeline retrieval significantly
job_urlThe url of the top-level hudson page if you want to display all jobs, or a job or module url (such as  http://localhost/hudson/job/build_foo/) if you want only display builds from a single job or module. This must be an absolute url.
main_pageThe url of the hudson main page to which the trac nav entry should link; if empty, no entry is created in the nav bar. This may be a relative url.
passwordThe password to use to access hudson
usernameThe username to use to access hudson

[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)

[iniadmin]

excludesExcludes this options. Comma separated list as section:name.
passwordsShow input-type as password instead of text. Comma separated list as section:name.

[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 ConfigParser 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).

[logviewer]

autolevelWhich log level shall be used on autoload (only applies when autoload is enabled). This integer value defaults to 3 (warnings). Possible values: 1=critical, 2=error, 3=warning, 4=info, 5=debug
autoloadWhether the log file content should be automatically loaded when the module is called, i.e. even before the form was submitted. This is a boolean option (true/false), and defaults to false.
autotailOnly applies to autoload: Restrict the evaluated lines to the last N lines. Defaults to 1000.
autoupInclude log events of higher levels than autolevel on autoload? This boolean option defaults to true - and only applies on autoload
defaultlevelPreset for the log level dropdown (if autoload is disabled). This integer value defaults to 3 (warnings). Possible values: 1=critical, 2=error, 3=warning, 4=info, 5=debug
defaulttailPreset for the Tail input (restrict query to the last N lines of the logfile to load). This must be a number (integer), and by default is empty (not set)
defaultupCheck the box to include log events of higher levels when autoload is disabled? This boolean option defaults to true.

[mastertickets]

dot_pathPath to the dot executable.
gs_pathPath to the ghostscript executable.
use_gsIf enabled, use ghostscript to produce nicer output.

[mdashboard]

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)
default_daysbackDefault number of days displayed in the Timeline, in days. (since 0.9.)
stats_providerName of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the milestone views.
tickettype_stats_providerName of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the milestone views.
managed_menusList of menus to be controlled by the Menu Manager
serve_ui_files

[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)
labelsLabels to assign to navigation items. They should be specified as navitem:label e.g wiki:My Wiki,browser:Code
mainnavItems to remove from the mainnav bar
mainnav_to_metanavItems to shift from mainnav to metanav bar
metanavItems to remove from the metanav bar
metanav_to_mainnavItems to shift from metanav to mainnav bar

[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).

[numberedheadlines]

numbered_outlineWhether or not to number the headlines in an outline (e.g. TOC)
numbering_starts_at_level_twoWhether or not to start the numbering at level two instead at level one.

[pdashboard]

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

[privatetickets]

group_blacklistGroups that do not affect the common membership check.

[progressmeter]

stats_providerName of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for meters generated by the ProgressMeterMacro plugin.

[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 TracRevisionLog (since 0.11).

[revtree]

abstimeTimeline filters start on absolute time or on the youngest revision.
branch_reRegular expression to extract branches from paths
contextsNavigation contexts where the Revtree item appears. If empty, the Revtree item appears in the main navigation bar.
optimizerName of the component implementing IRevtreeOptimizer, which is used for optimizing revtree element placements.
revbaseOldest revision to consider (older revisions are ignored)
scaleDefault rendering scale for the SVG graph
styleRevtree style, 'compact' or 'timeline'
trunksBranches that are considered as trunks

[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.

[section-edit]

preview_whole_page
serve_ui_files

[sequencediagram]

styleDiagram style

[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.
authenticated_karma The karma given to authenticated users, in case trust_authenticated is false.
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.
captchaCAPTCHA method to use for verifying humans.
captcha_expression_ceilingMaximum value of individual terms in numeric CAPTCHA expression.
captcha_expression_termsNumber of terms in numeric CAPTCHA expression.
captcha_image_alphabetAlphabet to choose image CAPTCHA challenge from.
captcha_image_font_sizeFont size to use in image CAPTCHA.
captcha_image_fontsSet of fonts to choose from when generating image CAPTCHA.
captcha_image_lettersNumber of letters to use in image CAPTCHA challenge.
captcha_karmaBy how many points a successful CAPTCHA response increases the overall score.
captcha_karma_lifetimeTime in seconds that a successful CAPTCHA response increases karma.
extlinks_karmaBy how many points too many external links in a submission impact the overall score.
httpbl_api_keyHttp:BL API key required for use.
httpbl_spammer_karmaBy how many points listing as "comment spammer" impacts the overall karma of a submission.
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.
is_forwardedInterpret X-Forwarded-For header for IP checks.
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 BadContent page impacts the overall karma of a submission.
reject_handlerThe handler used to reject content.
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/*
repository_urlbase URL of svn repository
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

[tags]

ignore_closed_ticketsDo not collect tags from closed tickets.
ticket_fieldsList of ticket fields to expose as tags.

[theme]

enable_cssEnable or disable custom CSS from theme.
themeThe theme to use to style this Trac.

[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 TracNavigation.
metanavOrder of the items to display in the metanav navigation bar, listed by IDs. See also TracNavigation.
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 DefaultPermissionPolicy (pre-0.11 behavior) and LegacyAttachmentPolicy (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)

[wiki]

ignore_missing_pagesEnable/disable highlighting CamelCase 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).
split_page_namesEnable/disable splitting the WikiPageNames with space characters (since 0.10).

[wiki-notification]

attach_diffSend diff's as an attachment instead of inline in email body.
banned_addressesA comma separated list of email addresses that should never be sent a notification email.
from_nameSender name to use in notification emails. Defaults to project name.
redirect_timeThe default seconds a redirect should take when watching/un-watching a wiki page
smtp_always_bccComma separated list of email address(es) to always send notifications to. Addresses do not appear publicly (Bcc:).
smtp_always_ccComma separated list of email address(es) to always send notifications to. Addresses can be seen by all recipients (Cc:).
smtp_fromSender address to use in notification emails.
subject_templateA Genshi text template snippet used to get the notification subject.
use_public_ccRecipients can see email addresses of other CC'ed recipients. If this option is disabled(the default), recipients are put on BCC. (values: 1, on, enabled, true or 0, off, disabled, false)

[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 (which is also the default):

closed = closed
closed.order = 0                     # sequence number in the progress bar
closed.query_args = group=resolution # optional extra param for the query
closed.overall_completion = true     # count for overall completion

active = *                           # one catch-all group is allowed
active.order = 1
active.css_class = open              # CSS class for this interval
active.label = in progress           # Displayed label for this group

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: protocol, or if a link to a different repository browser (such 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/trac/support/browser/$path?rev=$rev

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  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.


See also: TracGuide, TracAdmin, TracEnvironment