The Trac Configuration File
Table of Contents
Trac is configured through the trac.ini file, located in the <projectenv>/conf directory. The trac.ini configuration file and its parent directory should be writable by the web server.
Trac monitors the timestamp of the file to trigger an environment reload when the timestamp changes. Most changes to the configuration will be 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.
Global Configuration
Configuration can be shared among environments using one or more global configuration files. Options in the global configuration will be merged with the environment-specific options, with local options overriding global options. The global configuration file is specified as follows:
[inherit] file=/path/to/global/trac.ini
Multiple files can be specified using a comma-separated list. Non-absolute paths are relative to the Environment conf directory.
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 specify --inherit 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 in the global file.
There are three more options in the [inherit] section, templates_dir for sharing global templates, htdocs_dir for sharing global htdocs and plugins_dir, for sharing plugins. Those options can 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, refresh your modifications when you upgrade to a new version of Trac. The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate ITemplateStreamFilter transformation.
Reference for settings
This is a reference of available configuration options, and their default settings.
Documentation improvements should be discussed on the trac-dev mailing list or described in a ticket. Even better, submit a patch against the docstrings in the code.
[attachment]
max_zip_size
Maximum 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)
2097152render_unsafe_content Whether 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.
disabled[browser]
color_scale Enable colorization of the age column.
This uses the same color scale as the source code annotation: blue is older, red is newer.
enableddownloadable_paths List 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_properties Comma-separated list of version control properties to hide from the repository browser.
svk:mergeintermediate_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.
intermediate_point
If 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.
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_properties Comma-separated list of version control properties to render as oneliner wiki content in the repository browser.
trac:summaryrender_unsafe_content Whether 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.
disabledwiki_properties Comma-separated list of version control properties to render as wiki content in the repository browser.
trac:description[changeset]
max_diff_bytes Maximum 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.
10000000max_diff_files Maximum number of modified files for which the changeset view will attempt to show the diffs inlined.
0wiki_format_messages Whether wiki formatting should be applied to changeset messages.
If this option is disabled, changeset messages will be rendered as pre-formatted text.
enabled[components]
Enable or disable components provided by Trac and plugins.
The component to enable/disable is specified by the option name.
The enabled state 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 component 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 acct_mgr.*=enabled
The first option tells Trac to disable the
report module.
The second option instructs Trac to enable all components in
the acct_mgr package. The trailing wildcard is required for
module/package matching.
To view the list of active components, go to the Plugins
section of About Trac (requires CONFIG_VIEW
permission).
See also: TracPlugins
[header_logo]
link URL to link to, from the header logo.
(no default)src URL 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[http-headers]
Headers to be added to the HTTP request. (since 1.2.3)
The header name must conform to RFC7230 and the following reserved names are not allowed: content-type, content-length, location, etag, pragma, cache-control, expires.
[inherit]
htdocs_dir Path 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.
Non-absolute paths are relative to the Environment conf
directory.
(since 1.0)
plugins_dir Path 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.
Non-absolute paths are relative to the Environment conf
directory.
templates_dir Path 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.
Non-absolute paths are relative to the Environment conf
directory.
[intertrac]
This section configures InterTrac prefixes. Option names in
this section that contain a . are of the format
<name>.<attribute>. Option names that don't contain a . define
an alias.
The .url attribute is mandatory and is used for locating the
other Trac. This can be a relative path when the other Trac
environment is located on the same server.
The .title attribute is used for generating a tooltip when the
cursor is hovered over an InterTrac link.
Example configuration:
[intertrac] # -- Example of setting up an alias: t=trac # -- Link to an external Trac: genshi.title=Edgewall's Trac for Genshi genshi.url=https://genshi.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_file
If 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.loglog_format Custom 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 one could use:
$(path)sthe path for the current environment$(basename)sthe last path component of the current environment$(project)sthe 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
[mainnav]
Configures the main navigation bar, which by default contains Wiki, Timeline, Roadmap, Browse Source, View Tickets, New Ticket, Search and Admin.
The label, href, and order attributes can be specified. Entries
can be disabled by setting the value of the navigation item to
disabled.
The following example renames the link to WikiStart to Home, links the View Tickets entry to a specific report and disables the Search entry.
[mainnav] wiki.label=Home tickets.href=/report/24 search=disabled
See TracNavigation for more details.
[metanav]
Configures the meta navigation
entries, which by default are Login, Logout, Preferences,
Help/Guide and About Trac. The allowed attributes are the
same as for [mainnav]. Additionally, a special entry is supported -
logout.redirect is the page the user sees after hitting the logout
button. For example:
[metanav] logout.redirect=wiki/Logout
See TracNavigation for more details.
[milestone]
default_group_by Default field to use for grouping tickets in the grouped progress bar. (since 1.2)
componentdefault_retarget_to Default milestone to which tickets are retargeted when closing or deleting a milestone. (since 1.1.2)
(no default)stats_provider
Name 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]
mime_map List 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:adbmime_map_patterns List 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(?!\.rst)|INSTALL(?!\.rst)|COPYING.*pygments_modes List 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.
treat_as_binary Comma-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_domains Comma-separated list of domains that should be considered as valid for email addresses (such as localdomain).
(no default)ambiguous_char_width Width 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.
singlebatch_subject_template
Like ticket_subject_template but for batch modifications.
(since 1.0)
${prefix} Batch modify: ${tickets_descr}email_address_resolvers Comma separated list of email resolver components in the order they will be called. If an email address is resolved, the remaining resolvers will not be called.
SessionEmailResolveremail_sender
Name 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.
SmtpEmailSenderignore_domains Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
(no default)mime_encoding Specifies 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.
nonesendmail_path Path to the sendmail executable.
The sendmail program must accept the -i and -f options.
sendmailsmtp_always_bcc Comma-separated list of email addresses to always send notifications to. Addresses are not public (Bcc:).
(no default)smtp_always_cc Comma-separated list of email addresses to always send notifications to. Addresses can be seen by all recipients (Cc:).
(no default)smtp_default_domain Default 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_from Sender 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@localhostsmtp_from_author
Use 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)
disabledsmtp_from_name Sender name to use in notification emails.
(no default)smtp_password Password for authenticating with SMTP server.
(no default)smtp_replyto Reply-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@localhostsmtp_subject_prefix Text 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_user Username for authenticating with SMTP server.
(no default)ticket_subject_template A Jinja2 text template snippet used to get the notification subject.
The template variables are documented on the TracNotification page.
${prefix} #${ticket.id}: ${summary}use_public_cc Addresses in the To and Cc fields are visible to all recipients.
If this option is disabled, recipients are put in the Bcc list.
disableduse_short_addr Permit 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.
disabled[notification-subscriber]
The notifications subscriptions are controlled by plugins. All
INotificationSubscriber components are in charge. These components
may allow to be configured via this section in the trac.ini file.
See TracNotification for more details.
Available subscribers:
| Subscriber | Description |
|---|---|
AlwaysEmailSubscriber | |
CarbonCopySubscriber | Ticket that I'm listed in the CC field is modified |
NewTicketSubscriber | Any ticket is created |
TicketOwnerSubscriber | Ticket that I own is created or modified |
TicketPreviousUpdatersSubscriber | Ticket that I previously updated is modified |
TicketReporterSubscriber | Ticket that I reported is modified |
TicketUpdaterSubscriber | I update a ticket |
[project]
admin E-Mail address of the project's administrator.
(no default)admin_trac_url Base 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.
.footer Page footer text (right-aligned).
Visit the Trac open source project at<br /><a href="https://trac.edgewall.org/">https://trac.edgewall.org/</a>url URL of the project web site.
This is usually the domain in which the base_url resides.
For example, the project URL might be https://myproject.com,
with the Trac site (base_url) residing at either
https://trac.myproject.com or https://myproject.com/trac.
The project URL is added to the footer of notification e-mails.
[pygments-lexer]
Configure Pygments lexer options.
For example, to set the
PhpLexer options
startinline and funcnamehighlighting:
[pygments-lexer] php.startinline=True php.funcnamehighlighting=True
The lexer name is derived from the class name, with Lexer stripped
from the end. The lexer short names can also be used in place
of the lexer name.
[query]
default_anonymous_query
The 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~=$USERdefault_query
The 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=$USERitems_per_page
Number of tickets displayed per page in ticket queries,
by default. Set to 0 to specify no limit.
100ticketlink_query
The 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.
?status=!closed[report]
items_per_page
Number of tickets displayed per page in ticket reports,
by default. Set to 0 to specify no limit.
100items_per_page_rss
Number of tickets displayed in the rss feeds for reports.
Set to 0 to specify no limit.
0[repositories]
One of the methods for registering repositories is to
populate the [repositories] section of trac.ini.
This is especially suited for setting up aliases, using a shared configuration, or specifying repositories at the time of environment creation.
See TracRepositoryAdmin for details on the format of this section, and look elsewhere on the page for information on other repository providers.
[revisionlog]
graph_colors Comma-separated list of colors to use for the TracRevisionLog graph display. (since 1.0)
#cc0,#0c0,#0cc,#00c,#c0c,#c00[roadmap]
stats_provider
Name 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_filters
Specifies 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.
[sqlite]
extensions Paths to sqlite extensions. The paths may be absolute or relative to the Trac environment.
(no default)[svn]
authz_file
The path to the Subversion
authorization (authz) file.
To enable authz permission checking, the AuthzSourcePolicy
permission policy must be added to [trac] permission_policies.
Non-absolute paths are relative to the Environment conf
directory.
authz_module_name
The module prefix used in the authz_file for the default
repository. If left empty, the global section is used.
branches
Comma 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_style
End-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)
nativetags Comma separated list of paths categorized as tags.
If a path ends with '*', then all the directory entries found below
that path will be included.
Example: /tags/*, /projectAlpha/tags/A-1.0, /projectAlpha/tags/A-v1.1
tags/*[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.
[ticket]
allowed_empty_fields
Comma-separated list of select fields that can have
an empty value. (since 1.1.2)
milestone,versioncommit_ticket_update_check_perms Check that the committer has permission to perform the requested operations on the referenced tickets.
This requires that the user names be the same for Trac and repository operations.
enabledcommit_ticket_update_commands.close Commands that close tickets, as a space-separated list.
close closed closes fix fixed fixescommit_ticket_update_commands.refs Commands that add a reference, as a space-separated list.
If set to the special value <ALL>, all tickets referenced by the
message will get a reference to the changeset.
addresses re references refs seecommit_ticket_update_envelope Require commands to be enclosed in an envelope.
Must be empty or contain two characters. For example, if set to [],
then commands must be in the form of [closes #4].
default_cc Default cc: list for newly created tickets.
(no default)default_component Default component for newly created tickets.
(no default)default_description Default description for newly created tickets.
(no default)default_keywords Default keywords for newly created tickets.
(no default)default_milestone Default milestone for newly created tickets.
(no default)default_owner
Default owner for newly created tickets. The component owner
is used when set to the value < default >.
< default >default_severity Default severity for newly created tickets.
(no default)default_summary Default summary (title) for newly created tickets.
(no default)default_version Default version for newly created tickets.
(no default)preserve_newlines Whether 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').
defaultrestrict_owner Make 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.
disabled[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_messages Whether wiki-formatted event messages should be truncated or not.
This only affects the default rendering, and can be overridden by specific event providers, see their own documentation.
enabledchangeset_collapse_events Whether 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.
disabledchangeset_long_messages Whether 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).
disabledchangeset_show_files
Number of files to show (-1 for unlimited, 0 to disable).
This can also be location, for showing the common prefix for the
changed files.
0newticket_formatter Which 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.
onelinerticket_show_component Enable the display of component of tickets in the timeline. (since 1.1.1)
disabledticket_show_details Enable the display of all ticket changes in the timeline, not only open / close operations.
enabled[trac]
anonymous_session_lifetime Lifetime of the anonymous session, in days.
Set the option to 0 to disable purging old anonymous sessions. (since 1.0.17)
90auth_cookie_domain Auth cookie domain attribute.
The auth cookie can be shared among multiple subdomains by setting the value to the domain. (since 1.2)
(no default)auth_cookie_lifetime Lifetime 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.
0auth_cookie_path Path for the authentication cookie. Set this to the common base path of several Trac instances if you want them to share the cookie.
(no default)auto_preview_timeout Inactivity 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.
2.0base_url Base URL of the Trac site.
This is used to produce documents outside of the web browsing context, such as URLs in notification e-mails that point to Trac resources.
(no default)default_date_format The 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_format The date information format. Valid options are 'relative' for displaying relative format and 'absolute' for displaying absolute format. (since 1.0)
relativedefault_handler Name of the component that handles requests to the base URL.
Options include TimelineModule, RoadmapModule,
BrowserModule, QueryModule, ReportModule, TicketModule
and WikiModule.
The session preference for default handler take precedence, when set.
WikiModuledefault_language The preferred language to use if no user preference has been set.
(no default)default_timezone The default timezone to use
(no default)htdocs_location
Base 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.
jquery_location Location of the jQuery JavaScript library (version 3.6.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-3.6.3.min.js, http://ajax.aspnetcdn.com/ajax/jQuery/jquery-3.6.3.min.js or https://ajax.googleapis.com/ajax/libs/jquery/3.6.3/jquery.min.js.
(since 1.0)
(no default)jquery_ui_location Location of the jQuery UI JavaScript library (version 1.13.0).
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.13.0/jquery-ui.min.js or http://ajax.aspnetcdn.com/ajax/jquery.ui/1.13.0/jquery-ui.min.js.
(since 1.0)
(no default)jquery_ui_theme_location Location of the theme to be used with the jQuery UI JavaScript library (version 1.13.0).
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.13.0/themes/start/jquery-ui.css or http://ajax.aspnetcdn.com/ajax/jquery.ui/1.13.0/themes/start/jquery-ui.css.
(since 1.0)
(no default)never_obfuscate_mailto
Never obfuscate mailto: links explicitly written in the wiki,
even if show_email_addresses is false or the user doesn't have
EMAIL_VIEW permission.
disabledpermission_policies
List of components implementing IPermissionPolicy, in the order
in which they will be applied. These components manage fine-grained
access control to Trac resources.
DefaultWikiPolicy,DefaultTicketPolicy,DefaultPermissionPolicy,LegacyAttachmentPolicypermission_store
Name of the component implementing IPermissionStore, which is
used for managing user and group permissions.
DefaultPermissionStorerequest_filters Ordered list of filters to apply to all requests.
(no default)secure_cookies Restrict 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.
disabledshow_email_addresses Show email addresses instead of usernames. If false, email addresses are obfuscated for users that don't have EMAIL_VIEW permission.
disableduse_base_url_for_redirect
Optionally 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.
disableduse_chunked_encoding
If enabled, send contents as chunked encoding in HTTP/1.1.
Otherwise, send contents with Content-Length header after entire of
the contents are rendered. (since 1.0.6)
enableduse_xsendfile
When 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)
disabledxsendfile_header
The header to use if use_xsendfile is enabled. If Nginx is used,
set X-Accel-Redirect. (since 1.0.6)
X-Sendfile[versioncontrol]
allowed_repository_dir_prefixes Comma-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.
(no default)default_repository_type Default repository connector type.
This is used as the default repository type for repositories defined in the repositories section or using the "Repositories" admin panel.
svn[wiki]
render_unsafe_content
Enable/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.
disabledsafe_origins
List of URIs considered "safe cross-origin", that will be
rendered as img element without crossorigin="anonymous" attribute
or used in url() of inline style attribute even if
[wiki] render_unsafe_content is false (since 1.0.15).
To make any origins safe, specify "*" in the list.
data:safe_schemes
List 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+sshConfigure Error Reporting
The error reporting page has a Create button for reporting issues. The site to which issues are reported depends on the configuration of the Trac site and the user’s permissions.
If the user doesn’t possess TRAC_ADMIN, the site to which a user is directed to create a ticket is determined by the [trac] admin_trac_url setting:
- If empty, there will be no Create button.
- If set to the default value (
.), the ticket will be created on the site which the error occurred. - Otherwise the ticket will be created at the site pointed
to by
admin_trac_url.
If [project] admin is not empty, the administrator's email address will be rendered on the error page.
If the user possesses TRAC_ADMIN, the Create button will direct the user to report the issue on trac.edgewall.org. If the error was generated in a plugin, the error will be reported to the project URL provided that the plugin author has included the project URL in the plugin installation data. The user possessing TRAC_ADMIN also sees a traceback and system information on the error page.
See also: TracAdmin, TracEnvironment