Edgewall Software

This page was a draft. See default TracIni page now.

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

Global Configuration

In versions prior to 0.11, the global configuration was by default located in $prefix/share/trac/conf/trac.ini or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from. Literally, when you're upgrading to 0.11, you have to add an [inherit] section to your project's trac.ini file. Additionally, you have to move your customized templates and common images from $prefix/share/trac/... to the new location.

Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:

[inherit]
file = /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 [bitten], [spam-filter] and [vote] sections below are added by plugins enabled on this Trac, and therefore won't be part of a default installation.

[attachment]

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

[browser]

color_scaleEnable colorization of the age column. This uses the same color scale as the source code annotation: blue is older, red is newer.enabled
downloadable_pathsList of repository paths that can be downloaded. Leave this option empty if you want to disable all downloads, otherwise set it to a comma-separated list of authorized paths (those paths are glob patterns, i.e. "*" can be used as a wild card). In a multi-repository environment, the path must be qualified with the repository name if the path does not point to the default repository (e.g. /reponame/trunk). Note that a simple prefix matching is performed on the paths, so aliases won't get automatically resolved./trunk, /branches/*, /tags/*
hide_propertiesComma-separated list of version control properties to hide from the repository browser.svk:merge
intermediate_color(r,g,b) color triple to use for the color corresponding to the intermediate color, if two linear interpolations are used for the color scale (see intermediate_point). If not set, the intermediate color between oldest_color and newest_color will be used.(no default)
intermediate_pointIf set to a value between 0 and 1 (exclusive), this will be the point chosen to set the intermediate_color for interpolating the color value.(no default)
newest_color(r,g,b) color triple to use for the color corresponding to the newest color, for the color scale used in blame or the browser age column if color_scale is enabled.(255, 136, 136)
oldest_color(r,g,b) color triple to use for the color corresponding to the oldest color, for the color scale used in blame or the browser age column if color_scale is enabled.(136, 136, 255)
oneliner_propertiesComma-separated list of version control properties to render as oneliner wiki content in the repository browser.trac:summary
render_unsafe_contentWhether raw files should be rendered in the browser, or only made downloadable. Pretty much any file may be interpreted as HTML by the browser, which allows a malicious user to create a file containing cross-site scripting attacks. For open repositories where anyone can check-in a file, it is recommended to leave this option disabled.false
wiki_propertiesComma-separated list of version control properties to render as wiki content in the repository browser.trac:description

[changeset]

max_diff_bytesMaximum total size in bytes of the modified files (their old size plus their new size) for which the changeset view will attempt to show the diffs inlined.10000000
max_diff_filesMaximum number of modified files for which the changeset view will attempt to show the diffs inlined.0
wiki_format_messagesWhether wiki formatting should be applied to changeset messages. If this option is disabled, changeset messages will be rendered as pre-formatted text.true

[components]

This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to enabled or on will enable the component, any other value (typically disabled or off) will disable the component.

The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.

Consider the following configuration snippet:

[components]
trac.ticket.report.ReportModule = disabled
webadmin.* = enabled

The first option tells Trac to disable the report module. The second option instructs Trac to enable all components in the webadmin package. Note that the trailing wildcard is required for module/package matching.

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

See also: TracPlugins

[git]

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 (costly if you have many users).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

[header_logo]

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 latter.site/your_project_logo.png
widthWidth of the header logo image in pixels.-1

[hg]

encodingEncoding that should be used to decode filenames, file content, and changeset metadata. If multiple encodings are used for these different situations (or even multiple encodings were used for filenames), simply specify a list of encodings which will be tried in turn (since 0.12.0.24).utf-8
hgrcOptional path to an hgrc file which will be used to specify extra Mercurial configuration options (see http://www.selenic.com/mercurial/hgrc.5.html).(no default)
node_formatSpecify how the commit SHA1 hashes should be displayed. Possible choices are: 'short', the SHA1 hash is abbreviated to its first 12 digits, or 'hex', the hash is shown in full.short
show_revShow decimal revision in front of the commit SHA1 hash. While this number is specific to the particular clone used to browse the repository, this can sometimes give an useful hint about the relative "age" of a revision.enabled

[inherit]

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.(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.(no default)

[intertrac]

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.

Example configuration:

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

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

[interwiki]

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.

Example:

[interwiki]
MeatBall = http://www.usemod.com/cgi-bin/mb.pl?
PEP = http://www.python.org/peps/pep-$1.html Python Enhancement Proposal $1
tsvn = tsvn: Interact with TortoiseSvn

[logging]

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 http://docs.python.org/library/logging.html), one could use: - $(path)s the path for the current environment - $(basename)s the last path component of the current environment - $(project)s the project name Note the usage of $(...)s instead of %(...)s as the latter form would be interpreted by the ConfigParser? itself. Example: ($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s(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

[milestone]

default_retarget_toDefault milestone to which tickets are retargeted when closing or deleting a milestone. (since 1.1.2)(no default)
stats_providerName of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the milestone views.DefaultTicketGroupStatsProvider

[milestone-groups]

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.

[mimeviewer]

max_preview_sizeMaximum file size for HTML preview.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.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.8
treat_as_binaryComma-separated list of MIME types that should be treated as binary data.application/octet-stream, application/pdf, application/postscript, application/msword,application/rtf,

[notification]

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.false
always_notify_reporterAlways send notifications to the ticket reporter.false
always_notify_updaterAlways send notifications to the user who causes the ticket change and to any previous updater of the ticket.true
ambiguous_char_widthWidth of ambiguous characters that should be used in the table of the 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. (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. Supported values are: none, the default value which uses 7-bit encoding if the text is plain ASCII or 8-bit otherwise. base64, which works with any kind of content but may cause some issues with touchy anti-spam/anti-virus engine. qp or quoted-printable, which works best for european languages (more compact than base64) if 8-bit encoding cannot be used.none
sendmail_pathPath to the sendmail executable. The sendmail program must accept the -i and -f options. (since 0.12)sendmail
smtp_always_bccComma-separated list of email addresses to always send notifications to. Addresses are not public (Bcc:).(no default)
smtp_always_ccComma-separated list of email addresses to always send notifications to. Addresses can be seen by all recipients (Cc:).(no default)
smtp_default_domainDefault host/domain to append to addresses that do not specify one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found in the user settings.(no default)
smtp_enabledEnable email notification.false
smtp_fromSender address to use in notification emails. At least one of smtp_from and smtp_replyto must be set, otherwise Trac refuses to send notification mails.trac@localhost
smtp_from_authorUse the author of the change as the sender in notification emails (e.g. reporter of a new ticket, author of a comment). If the author hasn't set an email address, smtp_from and smtp_from_name are used instead. (since 1.0)false
smtp_from_nameSender name to use in notification emails.(no default)
smtp_passwordPassword for authenticating with SMTP server.(no default)
smtp_portSMTP server port to use for email notification.25
smtp_replytoReply-To address to use in notification emails. At least one of smtp_from and smtp_replyto must be set, otherwise Trac refuses to send notification mails.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 [$project_name] is used as the prefix. If no prefix is desired, then specifying an empty option will disable it.__default__
smtp_userUsername for authenticating with SMTP server.(no default)
ticket_subject_templateA Genshi text template snippet used to get the notification subject. The template variables are documented on the TracNotification page.$prefix #$ticket.id: $summary
use_public_ccAddresses in the To and Cc fields are visible to all recipients. If this option is disabled, recipients are put in the Bcc list.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. See also smtp_default_domain. Do not use this option with a public SMTP server.false
use_tlsUse SSL/TLS to send notifications over SMTP.false

[project]

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..
descrShort description of the project.My example project
footerPage footer text (right-aligned).Visit the Trac open source project at<br /><a href="http://trac.edgewall.org/">http://trac.edgewall.org/</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)

[query]

default_anonymous_queryThe default query for anonymous users. The query is either in query language syntax, or a URL query string starting with ? as used in query: Trac links.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.status!=closed&owner=$USER
items_per_pageNumber of tickets displayed per page in ticket queries, by default.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

[report]

items_per_pageNumber of tickets displayed per page in ticket reports, by default.100
items_per_page_rssNumber of tickets displayed in the rss feeds for reports.0

[repositories]

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)

[revisionlog]

default_log_limitDefault value for the limit argument in the TracRevisionLog.100
graph_colorsComma-separated list of colors to use for the TracRevisionLog graph display. (since 1.0)#cc0,#0c0,#0cc,#00c,#c0c,#c00

[roadmap]

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

[search]

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

[spam-filter]

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 service.rest.akismet.com/1.1/
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? service.test.blogspam.net:8888
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 usage.ws.areyouahuman.com
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 service.api.defensio.com/2.0/users/
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 linksexample.com, example.org
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 blacklisting.list.blogspambl.com, all.s5h.net, dnsbl.tornevall.org
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
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

[sqlite]

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

[svn]

branchesComma separated list of paths categorized as branches. If a path ends with '*', then all the directory entries found below that path will be included. Example: /trunk, /branches/*, /projectAlpha/trunk, /sandbox/*trunk, branches/*
eol_styleEnd-of-Line character sequences when svn:eol-style property is native. If native, substitute with the native EOL marker on the server. Otherwise, if LF, CRLF or CR, substitute with the specified EOL marker. (since 1.0.2)native
tagsComma separated list of paths categorized as tags. If a path ends with '*', then all the directory entries found below that path will be included. Example: /tags/*, /projectAlpha/tags/A-1.0, /projectAlpha/tags/A-v1.1tags/*

[svn:externals]

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.

Example:

[svn:externals]
1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev

With the above, the svn://anotherserver.com/tools_repository/tags/1.1/tools external will be mapped to http://ourserver/tracs/tools/browser/tags/1.1/tools?rev= (and rev will be set to the appropriate revision number if the external additionally specifies a revision, see the SVN Book on externals for more details).

Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser.

Finally, the relative URLs introduced in Subversion 1.5 are not yet supported.

[teo]

dev_releaseVersion of the dev release of Trac.1.1
ignored_pagesList of pages to ignore.WikiStart, TitleIndex
lts_releaseVersion of the LTS release of Trac.0.12
stable_releaseVersion of the stable release of Trac.1.0

[ticket]

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.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.defect
default_versionDefault version for newly created tickets.(no default)
max_comment_sizeMaximum allowed comment size in characters.262144
max_description_sizeMaximum allowed description size in characters.262144
max_summary_sizeMaximum allowed summary size in characters. (since 1.0.2)262144
optional_fieldsComma-separated list of select fields that can have an empty value. (since 1.1.2)milestone, version
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').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.false
workflowOrdered list of workflow controllers to use for ticket actions.ConfigurableTicketWorkflow

[ticket-custom]

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

[ticket-workflow]

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.

[timeline]

abbreviated_messagesWhether wiki-formatted event messages should be truncated or not. This only affects the default rendering, and can be overriden by specific event providers, see their own documentation.enabled
changeset_collapse_eventsWhether consecutive changesets from the same author having exactly the same message should be presented as one event. That event will link to the range of changesets in the log view.false
changeset_long_messagesWhether wiki-formatted changeset messages should be multiline or not. If this option is not specified or is false and wiki_format_messages is set to true, changeset messages will be single line only, losing some formatting (bullet points, etc).false
changeset_show_filesNumber of files to show (-1 for unlimited, 0 to disable). This can also be location, for showing the common prefix for the changed files.0
default_daysbackDefault number of days displayed in the Timeline, in days.30
max_daysbackMaximum number of days (-1 for unlimited) displayable in the Timeline.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.oneliner
ticket_show_componentEnable the display of component of tickets in the timeline. (since 1.1.1)false
ticket_show_detailsEnable the display of all ticket changes in the timeline, not only open / close operations.false

[trac]

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 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)
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. (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.false
databaseDatabase connection string for this projectsqlite:db/trac.db
debug_sqlShow the SQL queries in the Trac log, at DEBUG level.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.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. 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.false
jquery_locationLocation of the jQuery JavaScript library (version 1.8.3). An empty value loads jQuery from the copy bundled with Trac. Alternatively, jQuery could be loaded from a CDN, for example: http://code.jquery.com/jquery-1.8.3.min.js, http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.8.3.min.js or https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js. (since 1.0)(no default)
jquery_ui_locationLocation of the jQuery UI JavaScript library (version 1.9.2). An empty value loads jQuery UI from the copy bundled with Trac. Alternatively, jQuery UI could be loaded from a CDN, for example: https://ajax.googleapis.com/ajax/libs/jqueryui/1.9.2/jquery-ui.min.js or http://ajax.aspnetcdn.com/ajax/jquery.ui/1.9.2/jquery-ui.min.js. (since 1.0)(no default)
jquery_ui_theme_locationLocation of the theme to be used with the jQuery UI JavaScript library (version 1.9.2). 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: https://ajax.googleapis.com/ajax/libs/jqueryui/1.9.2/themes/start/jquery-ui.css or http://ajax.aspnetcdn.com/ajax/jquery.ui/1.9.2/themes/start/jquery-ui.css. (since 1.0)(no default)
mainnavOrder of the items to display in the mainnav navigation bar, listed by IDs. See also TracNavigation.wiki, 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.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.ReadonlyWikiPolicy, 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. 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. (since 0.12)(default)
repository_typeDefault repository connector type. 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.(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.disabled
show_email_addressesShow email addresses instead of usernames. If false, we obfuscate email addresses.false
show_ip_addressesShow IP addresses for resource edits (e.g. wiki).false
timeoutTimeout value for database connection, in seconds. Use '0' to specify no timeout.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.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

[translatedpages]

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](?:_[A-Z]{2})?)
templatePage name template of translated pages{lang}:{page}

[versioncontrol]

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)

[vote]

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

[wiki]

ignore_missing_pagesEnable/disable highlighting CamelCase links to missing pages.false
max_sizeMaximum allowed wiki page size in characters.262144
render_unsafe_contentEnable/disable the use of unsafe HTML tags such as <script> or <embed> with the HTML WikiProcessor. For public sites where anonymous users can edit the wiki it is recommended to leave this option disabled.false
safe_schemesList of URI schemes considered "safe", that will be rendered as external links even if [wiki] render_unsafe_content is false.cvs, file, ftp, git, irc, http, https, news, sftp, smb, ssh, svn, svn+ssh
split_page_namesEnable/disable splitting the WikiPageNames with space characters.false

[wikiextras]

done_phrasesAnalogous to FIXME-phrases, but presentation is less eye-catching.DONE, DEBUGGED, FIXED, REVIEWED
fixme_phrasesA list of attentional phrases or single words, separated by comma (,) that will be highlighted to catch attention. Any delimiter ():<> adjacent to a phrase will not be presented. (i.e. do not include any of these delimiters in this list). This makes it possible to naturally write, for example, FIXME: in a wiki text, but view the phrase highlighted without the colon (:) which would not look natural. Use the ShowPhrases macro to show a list of currently defined phrases.BUG, FIXME
rbox_widthWidth of right aligned boxes.300
shadowless_boxesUse shadowless boxes.false
todo_phrasesAnalogous to FIXME-phrases, but presentation is less eye-catching.REVIEW, TODO
wide_tocRight aligned boxes with table of contents, produced by the PageOutline macro, are either as wide as ordinary right aligned boxes (true) or narrow (false).false

[wikiextras-symbols]

The set of symbols is configurable by providing associations between symbols and wiki keywords. A default set of symbols and keywords is defined, which can be revoked one-by-one (_remove) or all at once (_remove_defaults).

Example:

[wikiextras-symbols]
_remove_defaults = true
_remove = <- ->
&laquo; = <<
&raquo; = >>
&sum; = (SUM)
&hearts; = <3

Keywords are space-separated!

A symbol can also be removed by associating it with no keyword:

&larr; =

Use the ShowSymbols macro to find out the current set of symbols and keywords.

_removeSpace-separated(!) list of keywords that shall not be interpreted as symbols (even if defined in this section).(no default)
_remove_defaultsSet to true to remove all default symbols.disabled

Reference for special sections

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

[components]

This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to enabled or on will enable the component, any other value (typically disabled or off) will disable the component.

The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.

Consider the following configuration snippet:

[components]
trac.ticket.report.ReportModule = disabled
webadmin.* = enabled

The first option tells Trac to disable the report module. The second option instructs Trac to enable all components in the webadmin package. Note that the trailing wildcard is required for module/package matching.

See the Plugins page on About Trac to get the list of active components (requires CONFIG_VIEW permissions.)

See also: TracPlugins

[milestone-groups]

(since 0.11)

As the workflow for tickets is now configurable, there can be many ticket states, and simply displaying closed tickets vs. all the others is maybe not appropriate in all cases. This section enables one to easily create groups of states that will be shown in different colors in the milestone progress bar.

Example configuration (the default only has closed and active):

closed = closed
# sequence number in the progress bar
closed.order = 0
# optional extra param for the query (two additional columns: created and modified and sort on created)
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>

[repositories]

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

[svn:externals]

(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

Example:

[svn:externals]
1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev

With the above, the svn://anotherserver.com/tools_repository/tags/1.1/tools external will be mapped to http://ourserver/tracs/tools/browser/tags/1.1/tools?rev= (and rev will be set to the appropriate revision number if the external additionally specifies a revision, see the SVN Book on externals for more details).

Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser.

Finally, the relative URLs introduced in Subversion 1.5 are not yet supported.

[ticket-custom]

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

[ticket-workflow]

(since 0.11)

The workflow for tickets is controlled by plugins. By default, there's only a ConfigurableTicketWorkflow component in charge. That component allows the workflow to be configured via this section in the trac.ini file. See TracWorkflow for more details.

Discussion

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 2 years ago Last modified on Jul 17, 2012 9:25:34 PM