Version 4 (modified by trac, 5 years ago) (diff)


The Trac Configuration File

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:

file = /path/to/global/trac.ini

Multiple files can be specified using a comma-separated list.

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

There are two more entries in the [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.

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

Reference for settings

This is a brief reference of available configuration options, and their default settings.


account_changes_notify_addressesList of email addresses that get notified of user changes, ie, new user, password change and delete user.(no default)


max_sizeMaximum allowed file size (in bytes) for attachments.262144
max_zip_sizeMaximum allowed total size (in bytes) for an attachment list to be downloadable as a .zip. Set this to -1 to disable download as .zip. (since 1.0)2097152
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).false


fieldsselect fields to autocomplement(no default)
ignore_patternResource names that match this pattern will not be added to the breadcrumbs trail.(no default)
labelText label to show before breadcrumb list. If empty, 'Breadcrumbs:' is used as default.(no default)
max_crumbsIndicates maximum number of breadcrumbs to store per user.6
pathsList of URL paths to allow breadcrumb tracking. Globs are supported./wiki/,/ticket/,/milestone/


oneliner_propertiesComma-separated list of version control properties to render as oneliner wiki content in the repository browser. (since 0.11)trac:summary
wiki_propertiesComma-separated list of version control properties to render as wiki content in the repository browser. (since 0.11)trac:description


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

To view the list of active components, go to the Plugins page on About Trac (requires CONFIG_VIEW permissions).

See also: TracPlugins


default_message_displayDefault display mode for topic messages list.tree
default_topic_displayDefault display mode for forum topics list.classic
forum_sortColumn by which will be sorted forum lists. Possible values are: id, group, name, subject, time, moderators, description, topics, replies, lasttopic, lastreply.lasttopic
forum_sort_directionDirection of forum lists sorting. Possible values are: asc, desc.asc
messages_per_pageNumber of messages per page in message list.50
smtp_always_ccAlways send discussion notifications to the listed e-mail addresses.
titleMain navigation bar button title.Discussion
topic_sortColumn by which will be sorted topic lists. Possible values are: id, forum, subject, time, author, body, replies, lastreply.lastreply
topic_sort_directionDirection of topic lists sorting. Possible values are: asc, desc.asc
topics_per_pageNumber of topics per page in topic list.30


This section provides a way to add arbitrary permissions to a Trac environment. This can be useful for adding new permissions to use for workflow actions, for example.

To add new permissions, create a new section [extra-permissions] in your trac.ini. Every entry in that section defines a meta-permission and a comma-separated list of permissions. For example:


This entry will define three new permissions EXTRA_VIEW, EXTRA_MODIFY and EXTRA_DELETE, as well as a meta-permissions EXTRA_ADMIN that grants all three permissions.

The permissions are created in upper-case characters regardless of the casing of the definitions in trac.ini. For example, the definition extra_view would create the permission EXTRA_VIEW.

If you don't want a meta-permission, start the meta-name with an underscore (_):



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(no default)
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(no default)
num_items_frontOption to specify how many recent posts to display on the front page of the Blog (and RSS feeds).20
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.disabled


cached_repositoryWrap GitRepository in CachedRepository.false
git_binPath to the git executable.git
git_fs_encodingDefine charset encoding of paths within git repositories.utf-8
persistent_cacheEnable persistent caching of commit tree.false
projects_basePath to the base of your git projects(no default)
projects_listPath to a gitweb-formatted projects.list(no default)
projects_urlTemplate for project URLs. %s will be replaced with the repo name(no default)
shortrev_lenThe length at which a sha1 should be abbreviated to (must be >= 4 and <= 40).7
trac_user_rlookupEnable reverse mapping of git email addresses to trac user ids. Performance will be reduced if there are many users and the cached_repository option is disabled. A repository resync is required after changing the value of this option.false
use_committer_idUse git-committer id instead of git-author id for the changeset Author field.true
use_committer_timeUse git-committer timestamp instead of git-author timestamp for the changeset Timestamp field.true
wikishortrev_lenThe minimum length of an hex-string for which auto-detection as sha1 is performed (must be >= 4 and <= 40).40


branchesNotify only commits on these branches to Trac(no default)
repositoryRepository name on GitHub (<user>/<project>)(no default)


change_frequencyChange frequency of URLs. Valid values: always, hourly, daily, weekly, monthly, yearly, never. Disabled if empty.(no default)
compress_sitemapSend sitemap compressed. Useful for larger sitemaps.disabled
compression_levelCompression level. Value range: 1 (low) to 9 (high). Default: 66
default_priorityDefault entry priority.0.8
ignore_usersDo not list wiki pages from this users (default: "trac")trac
ignore_wikisList of wiki pages to not be included in sitemap(no default)
increased_priorityIncreased entry priority.0.9
list_realmsWhich realms should be listed. Supported are "wiki", "ticket", "report", "roadmap", "attachment", "browser", "timeline", "homepage", "contactform" and "fullblog".wiki,ticket,report,roadmap,attachment,browser,timeline,homepage,contactform,fullblog
sitemappathPath of sitemap relative to Trac main URL (default: "sitemap.xml"). If this path ends in .gz the sidemap will automatically be compressed.sitemap.xml
wiki_auto_priorityShould top hierarchical wiki entries have increased priority automatically?disabled
wiki_auto_priority_ignoreWhich top hierarchical wiki entries should be ignored for increased priority.(no default)
wiki_priorityWiki pages with increased priority.(no default)


gravatar_defaultThe default value to pass along to gravatar to use if the email address does not match.identicon
providersGravatarHackergotchiProvider, IdenticonHackergotchiProvider


altAlternative text for the header logo.(please configure the [header_logo] section in trac.ini)
heightHeight of the header logo image in pixels.-1
linkURL to link to, from the header logo.(no default)
srcURL of the image to use as header logo. It can be absolute, server relative or relative. If relative, it is relative to one of the /chrome locations: site/your-logo.png if your-logo.png is located in the htdocs folder within your TracEnvironment; common/your-logo.png if your-logo.png is located in the folder mapped to the htdocs_location URL. Only specifying your-logo.png is equivalent to the
widthWidth of the header logo image in pixels.-1


htdocs_dirPath to the shared htdocs directory. Static resources in that directory are mapped to /chrome/shared under the environment URL, in addition to common and site locations. This can be useful in site.html for common interface customization of multiple Trac environments. (since 1.0)(no default)
plugins_dirPath to the shared plugins directory. 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)(no default)
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)(no default)


This section configures InterTrac prefixes. Options in this section whose name contain a "." define aspects of the InterTrac prefix corresponding to the option name up to the ".". Options whose name don't contain a "." define an alias.

The .url is mandatory and is used for locating the other Trac. This can be a relative URL in case that Trac environment is located on the same server.

The .title information is used for providing a useful tooltip when moving the cursor over an InterTrac link.

The .compat option can be used to activate or disable a compatibility mode:

  • If the targeted Trac is running a version below 0.10 (r3526 to be precise), then it doesn't know how to dispatch an InterTrac link, and it's up to the local Trac to prepare the correct link. Not all links will work that way, but the most common do. This is called the compatibility mode, and is false by default.
  • If you know that the remote Trac knows how to dispatch InterTrac links, you can explicitly disable this compatibility mode and then any TracLinks can become InterTrac links.

Example configuration:

# -- Example of setting up an alias:
t = trac

# -- Link to an external Trac:
trac.title = Edgewall's Trac for Trac
trac.url =


Every option in the [interwiki] section defines one InterWiki prefix. The option name defines the prefix. The option value defines the URL, optionally followed by a description separated from the URL by whitespace. Parametric URLs are supported as well.


MeatBall =
PEP =$1.html Python Enhancement Proposal $1
tsvn = tsvn: Interact with TortoiseSvn


log_fileIf log_type is file, this should be a path to the log-file. Relative paths are resolved relative to the log directory of the environment.trac.log
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 (see, 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)(no default)
log_levelLevel of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG).DEBUG
log_typeLogging facility to use. Should be one of (none, file, stderr, syslog, winlog).none


acceptable_formatsThe formats that may be chosen; execute dot -T? for a list of options.png,cmapx
closed_colorColor of closed ticketsgreen
closed_textText for key showing closed ticketsDone
dot_pathPath to the dot
full_graphShow full dep. graph, not just direct blocking linksdisabled
graph_directionDirection of the dependency graph (TD = Top Down, DT = Down Top, LR = Left Right, RL = Right Left)TD
gs_pathPath to the ghostscript
highlight_targetHighlight target tickets in graphdisabled
opened_colorColor of opened ticketsred
opened_textText for key showing opened ticketsToDo
show_keyShow a key for open/closed nodesdisabled
use_gsIf enabled, use ghostscript to produce nicer output.disabled


max_preview_sizeMaximum file size for HTML preview. (since 0.9)262144
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)text/x-dylan:dylan, text/x-idl:ice, text/x-ada:ads:adb
mime_map_patternsList of additional MIME types associated to filename patterns. Mappings are comma-separated, and each mapping consists of a MIME type and a Python regexp used for matching filenames, separated by a colon (":"). (since 1.0)text/plain:README|INSTALL|COPYING.*
pygments_default_styleThe default style to use for Pygments syntax highlighting.trac
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.(no default)
tab_widthDisplayed tab width in file preview. (since 0.9)8
treat_as_binaryComma-separated list of MIME types that should be treated as binary data. (since 0.11.5)application/octet-stream, application/pdf, application/postscript, application/msword, application/rtf


admit_domainsComma-separated list of domains that should be considered as valid for email addresses (such as localdomain).(no default)
email_senderName of the component implementing IEmailSender. This component is used by the notification system to send emails. Trac currently provides SmtpEmailSender for connecting to an SMTP server, and SendmailEmailSender for running a sendmail-compatible executable. (since 0.12)SmtpEmailSender
ignore_domainsComma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).(no default)
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)none
sendmail_pathPath to the sendmail executable. The sendmail program must accept the -i and -f options. (since 0.12)sendmail
smtp_always_bccEmail address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10)(no default)
smtp_always_ccEmail address(es) to always send notifications to, addresses can be seen by all recipients (Cc:).(no default)
smtp_default_domainDefault host/domain to append to address that do not specify one.(no default)
smtp_enabledEnable email notification.false
smtp_fromSender address to use in notification emails.trac@localhost
smtp_from_authorUse the action author as the sender of notification emails. (since 1.0)false
smtp_from_nameSender name to use in notification emails.(no default)
smtp_passwordPassword for SMTP server. (since 0.9)(no default)
smtp_portSMTP server port to use for email notification.25
smtp_replytoReply-To address to use in notification emails.trac@localhost
smtp_serverSMTP server hostname to use for email notifications.localhost
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)__default__
smtp_userUsername for SMTP server. (since 0.9)(no default)
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)false
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)false
use_tlsUse SSL/TLS to send notifications over SMTP. (since 0.10)false


adminE-Mail address of the project's administrator.(no default)
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.My example project
footerPage footer text (right-aligned).Visit the Trac open source project at<br /><a href=""></a>
iconURL of the icon of the project.common/trac.ico
nameName of the project.My Project
urlURL of the main project web site, usually the website in which the base_url resides. This is used in notification e-mails.(no default)


enter_labelEnter Quiet Mode
leave_labelLeave Quiet Mode


One of the alternatives for registering new repositories is to populate the [repositories] section of the trac.ini.

This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.

See TracRepositoryAdmin for details about the format adopted for this section and the rest of that page for the other alternatives.

(since 0.12)


additional_tagsAdditional tags that will be created for submitted screenshots. Possible values are: author, components, versions, name,,components,versions,name
default_componentsList of components enabled by default.all
default_descriptionTemplate for embended image description.$description
default_filter_relationLogical relation between component and version part of screenshots filter.or
default_formatDefault format for screenshot download links.html
default_list_itemDefault format of list item description of [[ScreenshotsList()]] macro.$id - $name - $description
default_order_directionsList of ordering directions for fields specified in default_orders configuration option.asc
default_ordersList of names of database fields that are used to sort
default_versionsList of versions enabled by default.all
extList of screenshot file extensions that can be uploaded. Must be supported by PIL.jpg,png
formatsList of allowed formats for screenshot download.raw,html,jpg,png
mainnav_titleMain navigation bar button title.Screenshots
metanav_titleMeta navigation bar link title.(no default)
pathPath where to store uploaded screenshots.../screenshots


columnsNumber of screenshot columns.3
heightHeight of screenshot preview.120
rowsNumber of screenshot preview rows.3
widthWidth of screenshot preview.160


default_disabled_filtersSpecifies which search filters should be disabled by default on the search page. This will also restrict the filters for the quick search function. The filter names defined by default components are: wiki, ticket, milestone and changeset. For plugins, look for their implementation of the ISearchSource interface, in the get_search_filters() method, the first member of returned tuple. Once disabled, search filters can still be manually enabled by the user on the search page. (since 0.12)(no default)
min_query_lengthMinimum length of query string allowed when performing a search.3


fieldsFields to hide for the simple ticket entry form.(no default)
show_onlyIf True, show only the specified fields rather than hiding the specified fieldsdisabled


This section is used to handle all configurations used by spam filter plugin.

akismet_api_keyWordpress key required to use the Akismet API.(no default)
akismet_api_urlURL of the Akismet
akismet_karmaBy how many points an Akismet reject impacts the overall karma of a submission.10
attachment_karmaThe karma given to attachments.0
attachment_sample_sizeThe maximum number of bytes from an attachment to pass through the spam filters.16384
authenticated_karmaThe karma given to authenticated users, in case trust_authenticated is false.20
badcontent_fileLocal file to be loaded to get BadContent. Can be used in addition to BadContent wiki page.(no default)
bayes_karmaBy what factor Bayesian spam probability score affects the overall karma of a submission.15
bayes_min_trainingThe minimum number of submissions in the training database required for the filter to start impacting the karma of submissions.25
blogspam_api_urlURL of the BlogSpam
blogspam_karmaBy how many points an BlogSpam reject impacts the overall karma of a submission.5
blogspam_skip_testsComma separated list of tests to skip.bayesian, linksleeve, sfs
botscout_api_keyAPI key required to use BotScout.(no default)
botscout_karmaBy how many points a BotScout reject impacts the overall karma of a submission.3
captchaCAPTCHA method to use for verifying humans.ExpressionCaptcha
captcha_areyouahuman_hostHost name for AreYouAHuman
captcha_areyouahuman_publisher_keyPublisher key for AreYouAHuman usage.(no default)
captcha_areyouahuman_scoring_keyScoring key for AreYouAHuman usage.(no default)
captcha_expression_ceilingMaximum value of individual terms in numeric CAPTCHA expression.10
captcha_expression_termsNumber of terms in numeric CAPTCHA expression.3
captcha_failed_karmaBy how many points a failed CAPTCHA impacts the overall score.1
captcha_image_alphabetAlphabet to choose image CAPTCHA challenge from.abcdefghkmnopqrstuvwxyz
captcha_image_font_sizeFont size to use in image CAPTCHA.25
captcha_image_fontsSet of fonts to choose from when generating image CAPTCHA.vera.ttf
captcha_image_lettersNumber of letters to use in image CAPTCHA challenge.6
captcha_karmaBy how many points a successful CAPTCHA response increases the overall score.20
captcha_karma_lifetimeTime in seconds that a successful CAPTCHA response increases karma.86400
captcha_keycaptcha_private_keyPrivate key for KeyCaptcha usage.(no default)
captcha_keycaptcha_user_idUser id for KeyCaptcha usage.(no default)
captcha_lifetimeTime in seconds before database cleanup is called.3600
captcha_recaptcha_private_keyPrivate key for reCaptcha usage.(no default)
captcha_recaptcha_public_keyPublic key for reCaptcha usage.(no default)
defensio_api_keyDefensio key required to use the API.(no default)
defensio_api_urlURL of the Defensio
defensio_karmaBy how many points a Defensio reject impacts the overall karma of a submission.2
extlinks_allowed_domainsList of domains that should be allowed in external,
extlinks_karmaBy how many points too many external links in a submission impact the overall score.2
fspamlist_api_keyAPI key required to use FSpamList.(no default)
fspamlist_karmaBy how many points a FSpamList reject impacts the overall karma of a submission.3
httpbl_api_keyHttp:BL API key required for use.(no default)
httpbl_spammer_karmaBy how many points listing as "comment spammer" impacts the overall karma of a submission.6
ip_blacklist_karmaBy how many points blacklisting by a single server impacts the overall karma of a submission.5
ip_blacklist_serversServers used for IP,,
ip_throttle_karmaBy how many points exceeding the configured maximum number of posts per hour impacts the overall score.3
ipbadcontent_fileLocal file to be loaded to get BadIP. Can be used in addition to BadIP wiki page.(no default)
ipregex_karmaBy how many points a match with a pattern on the BadIP page impacts the overall karma of a submission.20
is_forwardedInterpret X-Forwarded-For header for IP checks.false
linksleeve_karmaBy how many points a LinkSleeve reject impacts the overall karma of a submission.3
logging_enabledWhether all content submissions and spam filtering activity should be logged to the database.true
max_external_linksThe maximum number of external links allowed in a submission until that submission gets negative karma.4
max_posts_by_ipThe maximum allowed number of submissions per hour from a single IP address. If this limit is exceeded, subsequent submissions get negative karma.10
min_karmaThe minimum score required for a submission to be allowed.0
purge_ageThe number of days after which log entries should be purged.7
regex_karmaBy how many points a match with a pattern on the BadContent page impacts the overall karma of a submission.5
reject_handlerThe handler used to reject content.FilterSystem
report_pagesList of page types to add spam report linkwiki, attachment, ticket
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.9
show_blacklistedShow the matched bad content patterns in rejection message.true
show_blacklisted_ipShow the matched bad IP patterns in rejection message.true
show_train_onlyShow the buttons for training without deleting entry.disabled
skip_externalSkip external calls when this negative karma is already reached by internal tests.20
skip_externalhamSkip external calls when this positive karma is already reached by internal tests.30
spam_monitor_entriesHow many monitor entries are displayed by default (between 5 and 10000).100
spam_report_entriesHow many report entries are displayed by default (between 5 and 10000).100
spam_user_defaultmodeDefault mode for spam user admin panel.overview
spam_user_maxageHow many days no login are considered for dead accounts.200
spam_user_minwikiHow many wiki edits are still an unused account.0
stop_externalStop external calls when this negative karma is reached.50
stop_externalhamStop external calls when this positive karma is reached.50
stopforumspam_api_keyAPI key used to report SPAM.(no default)
stopforumspam_karmaBy how many points a StopForumSpam reject impacts the overall karma of a submission.4
train_externalAllow training of external services.true
trap_karmaBy how many points a trap reject impacts the overall karma of a submission.10
trap_nameName of the invisible trap field, should contain some reference to e-mail for better results.sfp_email
trap_name_hiddenName of the hidden trap field, should contain some reference to e-mail for better results.sfph_mail
trust_authenticatedWhether content submissions by authenticated users should be trusted without checking for potential spam or other abuse.false
use_externalAllow usage of external services.true


extensionsPaths to sqlite extensions, relative to Trac environment's directory or absolute. (since 0.12)(no default)


repository_urlbase URL of svn repository(no default)


cloud_caseless_sortWhether the tag cloud should be sorted case-sensitive.disabled
cloud_mincountInteger threshold to hide tags with smaller count.1
complete_fieldTicket field to which a drop-down tag list should be attached.keywords
complete_matchcontainsInclude partial matches in suggestion list. Default is true.enabled
complete_sticky_tagsA list of comma separated values available for input.(no default)
default_formatSet the default format for the handler of the /tags domain. || oldlist (default value) || The original format with a bulleted-list of "linked-id description (tags)" || || compact || bulleted-list of "linked-description" || || table || table... (see corresponding column option) ||oldlist
default_table_colsSelect columns and order for table format using a "|"-separated list of column names. Supported columns: realm, id, description, tagsid|description|tags
exclude_realmsComma-separated list of realms to exclude from tags queries by default, unless specifically included using "realm:realm-name" in a query.
ignore_closed_ticketsDo not collect tags from closed tickets.enabled
listtagged_default_formatSet default format for the handler of the /tags domain. See ListTagged description (WikiMacros) for supported values.oldlist
listtagged_default_table_colsSelect columns and column order for table format. See ListTagged description (WikiMacros) for supported|description|tags
listtagged_exclude_realmsComma-separated list of realms to exclude from tags queries by default, unless specifically included using 'realm:<realm>' in a query.
listtagged_items_per_pageNumber of tagged resources displayed per page of tag query results requested by ListTagged macros and from /tags.100
query_exclude_wiki_templatesWhether tagged wiki page templates should be queried.enabled
revisable_realmsComma-separated list of realms requiring tag change
separatorCharacter(s) to use as separators between tags. Default is a single whitespace.
ticket_fieldsList of ticket fields to expose as tags.keywords
ticket_helpIf specified, 'keywords' label on ticket view will be turned into a link to this URL.(no default)
ticket_help_newwindowIf true and keywords_help specified, wiki page will open in a new window. Default is false.disabled
wiki_page_linkLink a tag to the wiki page with same name, if it exists.enabled
wiki_page_prefixPrefix for tag wiki page names.(no default)


pending_removal_statusStatus to apply when removing 'Pending' status


default_moderatorThe default moderator for ticket modifications that require moderation, used if the ticket owner and default component owner are not Moderators (since 0.2).(no default)
ignore_smtp_alwaysIf true (default) email sent to the ticket moderator will not be sent to the smtp_always_cc or smtp_always_bcc addresses (since 0.5).enabled
moderation_noticeNotice displayed to users who will be subject to moderation when creating or editing tickets (since 0.6.4).$submission_type you submit will be routed for moderation.$login_request
review_promiseText displayed as part of the default confirmation indicating the moderators expected response time (since 0.6).We make every effort to review submissions within one working day.
show_moderator_emailPublish the assigned Moderator's e-mail address as part of the response to the submitter (since 0.2).disabled
subject_templateA Genshi text template snippet used to get the notification subject (since 0.2).$prefix [Moderate] ${new and 'New Ticket' or 'Comment'}: $summary
unmoderated_attachmentsAllow users requiring moderation to submit ticket attachments without moderation (since 0.3; deprecated in 0.4, use MODERATOR_PASS_ATTACH permission).disabled


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)enabled
default_daysbackDefault number of days displayed in the Timeline, in days. (since 0.9.)30
max_daysbackMaximum number of days (-1 for unlimited) displayable in the Timeline. (since 0.11)90


authz_fileThe path to the Subversion authorization (authz) file. To enable authz permission checking, the AuthzSourcePolicy permission policy must be added to [trac] permission_policies.(no default)
authz_module_nameThe module prefix used in the authz_file for the default repository. If left empty, the global section is used.(no default)
auto_preview_timeoutInactivity timeout in seconds after which the automatic wiki preview triggers an update. This option can contain floating-point values. The lower the setting, the more requests will be made to the server. Set this to 0 to disable automatic preview. The default is 2.0 seconds. (since 0.12)2.0
auto_reloadAutomatically reload template files after modification.disabled
backup_dirDatabase backup locationdb
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.(no default)
databaseDatabase connection string for this projectsqlite:db/trac.db
debug_sqlShow the SQL queries in the Trac log, at DEBUG level. (Since 0.11.5)disabled
default_date_formatThe date format. Valid options are 'iso8601' for selecting ISO 8601 format, or leave it empty which means the default date format will be inferred from the browser's default language. (since 1.0)(no default)
default_dateinfo_formatThe date information format. Valid options are 'relative' for displaying relative format and 'absolute' for displaying absolute format. (since 1.0)relative
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)WikiModule
default_languageThe preferred language to use if no user preference has been set. (since 0.12.1)(no default)
default_timezoneThe default timezone to use(no default)
genshi_cache_sizeThe maximum number of templates that the template loader will cache in memory. The default value is 128. You may want to choose a higher value if your site uses a larger number of templates, and you have enough memory to spare, or you can reduce it if you are short on memory.128
htdocs_locationBase URL for serving the core static resources below /chrome/common/. It can be left empty, and Trac will simply serve those resources itself. Advanced users can use this together with trac-admin ... deploy <deploydir> to allow serving the static resources for Trac directly from the web server. Note however that this only applies to the <deploydir>/htdocs/common directory, the other deployed resources (i.e. those from plugins) will not be made available this way and additional rewrite rules will be needed in the web server.(no default)
jquery_locationLocation of the jQuery JavaScript library (version 1.7.2). An empty value loads jQuery from the copy bundled with Trac. Alternatively, jQuery could be loaded from a CDN, for example:, or (since 1.0)(no default)
jquery_ui_locationLocation of the jQuery UI JavaScript library (version 1.8.21). An empty value loads jQuery UI from the copy bundled with Trac. Alternatively, jQuery UI could be loaded from a CDN, for example: or (since 1.0)(no default)
jquery_ui_theme_locationLocation of the theme to be used with the jQuery UI JavaScript library (version 1.8.21). An empty value loads the custom Trac jQuery UI theme from the copy bundled with Trac. Alternatively, a jQuery UI theme could be loaded from a CDN, for example: or (since 1.0)(no default)
mainnavOrder of the items to display in the mainnav navigation bar, listed by IDs. See also, timeline, roadmap, browser, tickets, newticket, search
metanavOrder of the items to display in the metanav navigation bar, listed by IDs. See also TracNavigation.login, logout, prefs, help, about
mysqldump_pathLocation of mysqldump for MySQL database backupsmysqldump
never_obfuscate_mailtoNever obfuscate mailto: links explicitly written in the wiki, even if show_email_addresses is false or the user doesn't have EMAIL_VIEW permission (since 0.11.6).false
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)DefaultPermissionPolicy, LegacyAttachmentPolicy
permission_storeName of the component implementing IPermissionStore, which is used for managing user and group permissions.DefaultPermissionStore
pg_dump_pathLocation of pg_dump for Postgres database backupspg_dump
repository_dirPath to the default repository. This can also be a relative path (since 0.11). This option is deprecated, and repositories should be defined in the repositories section, or using the "Repositories" admin panel. (since 0.12)(no default)
repository_sync_per_requestList of repositories that should be synchronized on every page request. Leave this option empty if you have set up post-commit hooks calling trac-admin $ENV changeset added on all your repositories (recommended). Otherwise, set it to a comma-separated list of repository names. Note that this will negatively affect performance, and will prevent changeset listeners from receiving events from the repositories specified here. The default is to synchronize the default repository, for backward compatibility. (since 0.12)(default)
repository_typeDefault repository connector type. (since 0.10) This is also used as the default repository type for repositories defined in TracIni#repositories-section repositories or using the "Repositories" admin panel. (since 0.12)svn
request_filtersOrdered list of filters to apply to all requests (since 0.10).(no default)
resizable_textareasMake <textarea> fields resizable. Requires JavaScript. (since 0.12)true
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)disabled
show_email_addressesShow email addresses instead of usernames. If false, email addresses are obfuscated for users that don't have EMAIL_VIEW permission. (since 0.11)false
show_ip_addressesShow IP addresses for resource edits (e.g. wiki). Since 1.0.5 this option is deprecated and will be removed in 1.3.1. (since 0.11.3)false
timeoutTimeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11)20
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)disabled
use_chunked_encodingIf enabled, send contents as chunked encoding in HTTP/1.1. Otherwise, send contents with Content-Length header after entire of the contents are rendered. (since 1.0.6)false
use_xsendfileWhen true, send a X-Sendfile header and no content when sending files from the filesystem, so that the web server handles the content. This requires a web server that knows how to handle such a header, like Apache with mod_xsendfile or lighttpd. (since 1.0)false
wiki_toolbarsAdd a simple toolbar on top of Wiki <textarea>s. (since 1.0.2)true
xsendfile_headerThe header to use if use_xsendfile is enabled. If Nginx is used, set X-Accel-Redirect. (since 1.0.6)X-Sendfile


templatesList of template names that the plugin will show a WYSIWYG editor on each TracWiki textarea. The plugin shows on all pages by default.(no default)
wysiwyg_stylesheetsAdd stylesheets to the WYSIWYG editor(no default)


base_languageBase language to be used without prefix/suffixEn
languages_pagePage name of table containing available languagesTracLanguages
regexpRegular expression to match a language code([A-Z][a-z]{1,2}(?:_[A-Z]{2})?)
templatePage name template of translated pages{lang}:{page}


allowed_repository_dir_prefixesComma-separated list of allowed prefixes for repository directories when adding and editing repositories in the repository admin panel. If the list is empty, all repository directories are allowed. (since 0.12.1)(no default)


pathsList of URL paths to allow voting on. Globs are supported./ticket*,/wiki*


ignore_missing_pagesEnable/disable highlighting CamelCase links to missing pages (since 0.9).false
max_sizeMaximum allowed wiki page size in characters. (since 0.11.2)262144
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).false
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)cvs, file, ftp, git, irc, http, https, news, sftp, smb, ssh, svn, svn+ssh
split_page_namesEnable/disable splitting the WikiPageNames with space characters (since 0.10).false


article_css_url(no default)
book_css_url(no default)
css_url(no default)
extracontent_url(no default)
frontpage_url(no default)
httpauth_password(no default)
httpauth_user(no default)
omit_links(no default)
omit_macros(no default)
rebase_links(no default)
toc_titleTable of Contents

Reference for special sections

  1. [components]
  2. [milestone-groups]
  3. [repositories]
  4. [svn:externals]
  5. [ticket-custom]
  6. [ticket-workflow]


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] = 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


(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)
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
# indicates groups that count for overall completion percentage
closed.overall_completion = true

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>


(since 0.12 multirepos)

One of the alternatives for registering new repositories is to populate the [repositories] section of the trac.ini.

This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.

See TracRepositoryAdmin for details about the format adopted for this section and the rest of that page for the other alternatives.


(since 0.11)

The TracBrowser for Subversion can interpret the svn:externals property of folders. By default, it only turns the URLs into links as Trac can't browse remote repositories.

However, if you have another Trac instance (or an other repository browser like ViewVC) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.

This mapping is done in the [svn:externals] section of the TracIni


1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
3 =       http://ourserver/viewvc/svn/$path/?pathrev=25914
4 = svn://  http://ourserver/tracs/tools/browser/$path?rev=$rev

With the above, the svn:// 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.


In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.


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

See also: TracGuide, TracAdmin, TracEnvironment