The Trac Configuration File

[Note To Editors] Please discuss documentation changes in the #Discussion section. Even better, send us documentation patches? against the code (i.e. where the configuration entries are documented), either on Trac-dev or on new tickets.

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 and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.

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.

Note that the [hg], [spam-filter], [translatedpages], [vote], [wikiextras] and [wikiextras-symbols] sections below are added by plugins enabled on this Trac, and therefore won't be part of a default installation.


account_changes_notify_addressesList of email addresses that get notified of user changes, ie, new user, password change and delete user.(no default)
allow_delete_accountAllow users to delete their own account.enabled
cookie_refresh_pctPersistent sessions randomly get a new session cookie ID with likelihood in percent per work hour given here (zero equals to never) to decrease vulnerability of long-lasting sessions.10
db_htdigest_realmRealm to select relevant htdigest db entries(no default)
email_regexpA validation regular expression describing new account emails.(?i)^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+\.)+[A-Z]{2,6}$
environ_auth_overwriteWhether environment variable REMOTE_USER should get overwritten after processing login form input. Otherwise it will only be set, if unset at the time of authentication.enabled
force_passwd_changeForce the user to change password when it's reset.enabled
generated_password_lengthLength of the randomly-generated passwords created when resetting the password for an account.8
hash_methodIPasswordHashMethod used to create new/updated passwordsHtDigestHashMethod
htdigest_filePath relative to Trac environment or full host machine path to password file(no default)
htdigest_realmRealm to select relevant htdigest file entries(no default)
login_attempt_max_countLock user account after specified number of login attempts. Value zero means no limit.0
login_opt_listSet to True, to switch login page style showing alternative actions in a single listing together.disabled
notify_actionsComma separated list of actions to notify of. Available actions 'new', 'change', 'delete'.
password_formatLegacy option, deprecated since acct_mgr-0.1.2(no default)
password_storeOrdered list of password stores, queried in turn.(no default)
persistent_sessionsAllow the user to be remembered across sessions without needing to re-authenticate. This is, user checks a "Remember Me" checkbox and, next time he visits the site, he'll be remembered.disabled
refresh_passwdRe-set passwords on successful authentication. This is most useful to move users to a new password store or enforce new store configuration (i.e. changed hash type), but should be disabled/unset otherwise.disabled
register_basic_tokenA string required as input to pass verification.(no default)
register_checkOrdered list of IAccountRegistrationInspector's to use for registration checks.BasicCheck, EmailCheck, BotTrapCheck, RegExpCheck, UsernamePermCheck
reset_passwordSet to False, if there is no email system setup.enabled
user_lock_max_timeLimit user account lock time to specified time (seconds). This is relevant only with user_lock_time_progression > 1.86400
user_lock_timeDrop user account lock after specified time (seconds). Value zero means unlimited lock time.0
user_lock_time_progressionExtend user account lock time incrementally. This is based on logarithmic calculation and decimal numbers accepted: Value '1' means constant lock time per failed login attempt. Value '2' means double locktime after 2nd lock activation, four times the initial locktime after 3rd, and so on.1
username_char_blacklistAlways exclude some special characters from usernames. This is enforced upon new user registration.:[]
username_regexpA validation regular expression describing new usernames.(?i)^[A-Z0-9.\-_]{5,}$
verify_emailVerify the email address of Trac users.enabled


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


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_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.(no default)
default_namespaceDefault namespace to search for named objects in.(no default)
encodingDefault encoding used by the generated documentation files.iso-8859-1
extSpace separated list of extensions for doxygen managed files.htm html png
html_outputDefault documentation project suffix, as generated by Doxygen using the HTML_OUTPUT Doxygen configuration setting.(no default)
indexDefault index page to pick in the generated documentation.main.html
pathDirectory containing doxygen generated files./var/lib/trac/doxygen
source_extSpace separated list of source files extensionsidl odl java cs py php php4 inc phtml m cpp cxx c hpp hxx h
titleTitle to use for the main navigation tab.Doxygen
wiki_indexWiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option.(no default)


admin_loggingDisabling this option will prevent all logged in admins from showing up on your Google Analytics reports.disabled
extensionsEnter any extensions of files you would like to be tracked as a download. For example to track all MP3s and PDFs enter: mp3,pdf Outbound link tracking must be enabled for downloads to be,tar,tar.gz,tar.bzip,egg
google_external_pathThis will be the path shown on Google Analytics regarding external links. Consider the following link:" The above link will be shown as for example: /external/ This way you will be able to track outgoing links. Outbound link tracking must be enabled for external links to be tracked./external/
outbound_link_trackingDisabling this option will turn off the tracking of outbound links. It's recommended not to disable this option unless you're a privacy advocate (now why would you be using Google Analytics in the first place?) or it's causing some kind of weird issue.enabled
tracking_domain_nameIf you're tracking multiple subdomains with the same Google Analytics profile, like what's talked about in: enter your main domain here. For more info, please visit the previous link.(no default)
uidGoogle Analytics' UID. The UID is needed for Google Analytics to log your website stats. Your UID can be found by looking in the JavaScript? Google Analytics gives you to put on your page. Look for your UID in between var pageTracker = _gat._getTracker("UA-111111-11"); in the javascript. In this example you would put UA-11111-1 in the UID box.(no default)


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


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


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.

Note that the groups can only be based on the ticket status, nothing else. In particular, it's not possible to distinguish between different closed tickets based on the resolution.

Example configuration with three groups, closed, new and active (the default only has closed and active):

# the 'closed' group correspond to the 'closed' tickets
closed = closed

# .order: sequence number in the progress bar
closed.order = 0

# .query_args: optional parameters for the corresponding
#              query.  In this example, the changes from the
#              default are two additional columns ('created' and
#              'modified'), and sorting is done 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

# .overall_completion: indicates groups that count for overall
#                      completion percentage
closed.overall_completion = true

new = new
new.order = 1
new.css_class = new
new.label = new

# Note: one catch-all group for other statuses is allowed
active = *
active.order = 2

# .css_class: CSS class for this interval
active.css_class = open

# .label: 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). Other styles can easily be added using custom CSS rule: table.progress td.<class> { background: <color> } to a site/style.css file for example.

(since 0.11)


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.*
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)
always_notify_ownerAlways send notifications to the ticket owner (since 0.9).false
always_notify_reporterAlways send notifications to any address in the reporter field.false
always_notify_updaterAlways send notifications to the person who causes the ticket property change and to any previous updater of that ticket.true
ambiguous_char_widthWhich width of ambiguous characters (e.g. 'single' or 'double') should be used in the table of notification mail. If 'single', the same width as characters in US-ASCII. This is expected by most users. If 'double', twice the width of US-ASCII characters. This is expected by CJK users. (since 0.12.2)single
batch_subject_templateLike ticket_subject_template but for batch modifications. By default, the template is $prefix Batch modify: $tickets_descr. (since 1.0)$prefix Batch modify: $tickets_descr
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)
ticket_subject_templateA Genshi text template snippet used to get the notification subject. By default, the subject template is $prefix #$ $summary. $prefix being the value of the smtp_subject_prefix option. (since 0.11)$prefix #$ $summary
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)


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)status!=closed&cc~=$USER
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)status!=closed&owner=$USER
items_per_pageNumber of tickets displayed per page in ticket queries, by default (since 0.11)100
ticketlink_queryThe base query to be used when linkifying values of ticket fields. The query is a URL query string starting with ? as used in query: Trac links. (since 0.12)?status=!closed


ticket_listList of tickets that should be considered Read-Only for users that don't have the TICKET_ADMIN priviledge.(no default)


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


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


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


duplicateSpecify what to do if a file is uploaded with an already existing file name. To deny the upload, set it to 'deny' (default), set it to 'allow' to allow two files with the same name. Note that this applies only to local downloads, remote downloads are not restricted.deny
extensionsComma separated list of allowed file extensions (without leading dot). Leave this empty to not restrict the file types. The default is 'zip,gz,bz2,rar'. See also the 'no_extension',gz,bz2,rar
lighty_prefixMust be set to the Lighttpd 'secdownload-uri-prefix' configuration value if mod_secdownload is used. The final download URL will be constructed using this value as the first part after the root path, followed by the protected part of the URL. If regular downloads are enabled, the URL will be the same but without the protected part. Note that if you do not start the value for this option with a '/', an URL relative to the Trac environment root will be created. This is in most cases not what you want!/download/
lighty_secretThe secret key to protect the downloads (Lighttpd 'secdownload.secret' configuration value). The downloads using mod_secdownload are disabled if this is left empty (default).(no default)
max_filesMaximum number of uploaded files. If this limit is reached, no more uploads are allowed. Set this to '0' to allow an unlimited number of uploads (default). Note that this applies to local files only.0
max_sizeMaximum allowed file size for uploaded files in bytes. Note that a file has to be uploaded completely before this can be checked. Set 'max_size' to '0' to not restrict the file size. The default value is '524288' (512 KiB). See also the 'max_total' configuration option. Note that this applies to local files only.524288
max_totalMaximum total size of uploaded files in bytes. If a new file upload would exceed this limit it will be denied. Note that a file has to be uploaded completely before this can be checked (unless the limit is already reached). Set this to '0' to disable this feature (default). This applies to local files only.0
no_extensionIn addition to the allowed file extensions specified by the 'extensions' option, allow files with no extension to be uploaded if this option is set to True. The default value is False.disabled
orderDefault order of the downloads table, specified as comma separated list of field names. See 'show_fields' for a list of allowed field names. You may prepend a '!' to change the sort order of a given field (eg. use '!name' to sort by file name in a descending order). Note that the fields used here have to be included in the 'show_fields' list, too. The default value is '!time', so latest downloads will be shown at the top of the table.!time
regular_downloadsEnable regular downloads not using mod_secdownload. Note that the webserver has to be configured to serve the files in 'upload_dir'. This option will be ignored unless 'lighty_secret' is empty and 'use_xsendfile' is disabled. Regular downloads may be used on other servers than Lighttpd, too, but keep in mind that there are no further restrictions to access these files.disabled
schemesComma separated list of allowed schemes for the remote downloads. A remote download with another scheme can not be created. To not restrict the remote URLs leave this option empty. Note that URLs without a scheme are always denied. The default is 'http,https'.http,https
show_fieldsComma separated list of fields to show on the downloads index page. Valid options are: 'id', 'name', 'url', 'description', 'size', 'time', 'last_request', 'count', 'author', 'ip', 'component', 'version', 'milestone', 'platform', 'architecture', 'type', 'hidden', 'checksum_md5', 'checksum_sha'. Note that some options are not displayed in a separate column but will force a new table row, and some options are not displayed at all (though they are valid). The order does not,size,description,url,time,checksum_md5,checksum_sha
temp_dirTemporary directory for uploaded files. If this is empty (default) 'upload_dir' will be used. Note that it is highly recommended to use a directory on the same physical partition as 'upload_dir'. The directory must exist and the user running Trac must have write access to this directory.(no default)
titleMain navigation link title, and title of the downloads index page. Defaults to 'Downloads'.Downloads
trac_downloadsIf 'lighty_secret' is not set and 'regular_downloads' is disabled, too, this option can be enabled to allow downloads to be handled by Trac itself. This is disabled by default.disabled
unmanaged_file_external_prefixIf using a 'unmanaged_file_prefix' and 'regular' file serving, this needs to be set to the prefix the files stored under 'unmanaged_file_prefix' are being exposed via the web server.(no default)
unmanaged_file_prefixIf you are going to use unmanaged locally hosted files not uploaded using the admin interface, this must be set to a prefix relative to which these local files can be found. Don't set this to / - that'll cause potential leakage!!!/dev/null/
upload_dirDirectory to store uploaded files. The directory must exist and the user running Trac must have write access to this directory. The user running Lighttpd (or any other webserver if regular downloads are used) must have read permissions. The default value is '/var/lib/trac/files'. Note that you can safely use the same upload directory for multiple environments, the uploaded files are automatically stored in subdirectories for each environment./var/lib/trac/files
urlURL of the downloads page relative to the Trac environment root (one word, no slashes). Defaults to 'download'.download
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.disabled
wiki_prefixComma separated list of prefixes used in the wiki to link to the downloads. The default value is 'download,secdownload'.download,secdownload


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.

account_karmaBy how many points a failed registration check impacts the overall score.5
account_replace_checksReplace checks in account manager totally.false
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)
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
captchaCAPTCHA method to use for verifying humans.ExpressionCaptcha
captcha_failed_karmaBy how many points a failed CAPTCHA impacts the overall score.1
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_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)
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
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
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
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 1000).100
stop_externalStop external calls when this negative karma is reached.50
stop_externalhamStop external calls when this positive karma is reached.50
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


default_ccDefault cc: list for newly created tickets.(no default)
default_componentDefault component for newly created tickets.(no default)
default_descriptionDefault description for newly created tickets.(no default)
default_keywordsDefault keywords for newly created tickets.(no default)
default_milestoneDefault milestone for newly created tickets.(no default)
default_ownerDefault owner for newly created tickets.< default >
default_priorityDefault priority for newly created tickets.major
default_resolutionDefault resolution for resolving (closing) tickets (since 0.11).fixed
default_severityDefault severity for newly created tickets.(no default)
default_summaryDefault summary (title) for newly created tickets.(no default)
default_typeDefault type for newly created tickets (since 0.9).defect
default_versionDefault version for newly created tickets.(no default)
max_comment_sizeMaximum allowed comment size in characters. (since 0.11.2).262144
max_description_sizeMaximum allowed description size in characters. (since 0.11).262144
max_summary_sizeMaximum allowed summary size in characters. (since 1.0.2).262144
pending_removal_statusStatus to apply when removing 'Pending' status
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).default
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. Please note that e-mail addresses are not obfuscated in the resulting drop-down menu, so this option should not be used if e-mail addresses must remain protected. (since 0.9)false
workflowOrdered list of workflow controllers to use for ticket actions (since 0.11).ConfigurableTicketWorkflow


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


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.

(since 0.11)


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
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).oneliner
ticket_show_detailsEnable the display of all ticket changes in the timeline, not only open / close operations (since 0.9).false


auth_cookie_lifetimeLifetime of the authentication cookie, in seconds. This value determines how long the browser will cache authentication information, and therefore, after how much inactivity a user will have to log in again. The default value of 0 makes the cookie expire at the end of the browsing session. (since 0.12)0
auth_cookie_pathPath for the authentication cookie. Set this to the common base path of several Trac instances if you want them to share the cookie. (since 0.12)(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)
check_auth_ipWhether the IP address of the user should be checked for authentication (since 0.9).false
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_charsetCharset to be used when in doubt.utf-8
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)
ignore_auth_caseWhether login names should be converted to lower case (since 0.9).false
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
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).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
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, we obfuscate email addresses. (since 0.11)false
show_ip_addressesShow IP addresses for resource edits (e.g. wiki). (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_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


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


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


attach_diffSend diff's as an attachment instead of inline in email body.disabled
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.(no default)
redirect_timeThe default seconds a redirect should take when watching/un-watching a wiki page5
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.trac+wiki@localhost
subject_templateA Genshi text template snippet used to get the notification subject.$prefix $pagename $action
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)disabled


Please discuss documentation changes here. Even better, send us documentation patches against the code, either on Trac-dev or on new tickets.

See also: TracGuide, TracAdmin, TracEnvironment

Last modified 5 years ago Last modified on 10/26/14 13:01:55
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!