![[ DeepNet IP Database ]](/images/ipdb-logo.png){kind=logo}
| Version 2 (modified by , 14 years ago) ( diff ) |
|---|
The Trac Configuration File
Table of Contents
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.
Reference for settings
This is a brief reference of available configuration options.
[account-manager]
account_changes_notify_addresses | Email addresses to notify on account created, password changed and account deleted. | (no default) |
allow_delete_account | Allow users to delete their own account. | enabled |
authentication_url | URL of the HTTP authentication service | (no default) |
cookie_refresh_pct | Persistent 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_htpasswd_hash_type | Default hash type of new/updated passwords | crypt |
environ_auth_overwrite | Whether 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_change | Force the user to change password when it's reset. | enabled |
generated_password_length | Length of the randomly-generated passwords created when resetting the password for an account. | 8 |
hash_method | IPasswordHashMethod used to create new/updated passwords | HtDigestHashMethod |
htpasswd_file | Path relative to Trac environment or full host machine path to password file | (no default) |
htpasswd_hash_type | Default hash type of new/updated passwords | crypt |
login_attempt_max_count | Lock user account after specified number of login attempts. Value zero means no limit. | 0 |
notify_actions | Comma separated list of notification actions. Available actions are 'new', 'change', 'delete'. | (no default) |
password_store | Ordered list of password stores, queried in turn. | (no default) |
persistent_sessions | Allow 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_passwd | Re-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_check | Ordered list of IAccountRegistrationInspector's to use for registration checks. | BasicCheck,EmailCheck,BotTrapCheck,RegExpCheck,UsernamePermCheck |
reset_password | Set to False, if there is no email system setup. | enabled |
user_lock_max_time | Limit user account lock time to specified time (seconds). This is relevant only with user_lock_time_progression > 1. | 86400 |
user_lock_time | Drop user account lock after specified time (seconds). Value zero means unlimited lock time. | 0 |
user_lock_time_progression | Extend 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_blacklist | Always exclude some special characters from usernames. This is enforced upon new user registration. | :[] |
[attachment]
max_size | Maximum allowed file size (in bytes) for attachments. | 262144 |
max_zip_size |
Maximum allowed total size (in bytes) for an attachment list to be
downloadable as a | 2097152 |
render_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. | enabled |
downloadable_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: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 | (no default) |
intermediate_point |
If set to a value between 0 and 1 (exclusive), this will be the
point chosen to set the | (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 | (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 | (136, 136, 255) |
oneliner_properties | Comma-separated list of version control properties to render as oneliner wiki content in the repository browser. | trac:summary |
render_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. | disabled |
wiki_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. | 10000000 |
max_diff_files | Maximum number of modified files for which the changeset view will attempt to show the diffs inlined. | 0 |
wiki_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]
alt | Alternative text for the header logo. | (please configure the [header_logo] section in trac.ini) |
height | Height of the header logo image in pixels. | -1 |
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 | site/your_project_logo.png |
width | Width of the header logo image in pixels. | -1 |
[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 | (no default) |
plugins_dir | Path to the shared plugins directory.
Plugins in that directory are loaded in addition to those in
the directory of the environment
Non-absolute paths are relative to the Environment | (no default) |
templates_dir | Path to the shared templates directory.
Templates in that directory are loaded in addition to those in the
environments
Non-absolute paths are relative to the Environment | (no default) |
[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 | trac.log |
log_format | Custom logging format. If nothing is set, the following will be used:
In addition to regular key names supported by the Python logger library one could use:
Note the usage of
Example:
| (no default) |
log_level | Level of verbosity in log.
Should be one of ( | INFO |
log_type | Logging facility to use.
Should be one of ( | file |
[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) | component |
default_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 | 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_size | Maximum file size for HTML preview. | 262144 |
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:adb |
mime_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.* |
tab_width | Displayed tab width in file preview. | 8 |
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 |
batch_subject_template |
Like | ${prefix} Batch modify: ${tickets_descr} |
default_format.email | Default format to distribute email notifications. | text/plain |
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. | SessionEmailResolver |
email_sender |
Name of the component implementing
This component is used by the notification system to send emails.
Trac currently provides | SmtpEmailSender |
ignore_domains | Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains). | (no default) |
message_id_hash | Hash algorithm to create unique Message-ID header. (since 1.0.13) | md5 |
mime_encoding | Specifies the MIME encoding scheme for emails.
Supported values are: | none |
sendmail_path | Path to the sendmail executable.
The sendmail program must accept the | sendmail |
smtp_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_enabled | Enable email notification. | disabled |
smtp_from | Sender address to use in notification emails.
At least one of | trac@localhost |
smtp_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, | disabled |
smtp_from_name | Sender name to use in notification emails. | (no default) |
smtp_password | Password for authenticating with SMTP server. | (no default) |
smtp_port | SMTP server port to use for email notification. | 25 |
smtp_replyto | Reply-To address to use in notification emails.
At least one of | trac@localhost |
smtp_server | SMTP server hostname to use for email notifications. | localhost |
smtp_subject_prefix | Text to prepend to subject line of notification emails.
If the setting is not defined, then | __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. | disabled |
use_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 | disabled |
use_tls | Use SSL/TLS to send notifications over SMTP. | 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. | . |
descr | Short description of the project. | My example project |
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> |
icon | URL of the icon of the project. | common/trac.ico |
name | Name of the project. | My Project |
url | URL of the project web site.
This is usually the domain in which the | (no default) |
[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 | status!=closed&cc~=$USER |
default_query |
The default query for authenticated users. The query is either
in query language syntax, or a URL query
string starting with | status!=closed&owner=$USER |
items_per_page |
Number of tickets displayed per page in ticket queries,
by default. Set to | 100 |
ticketlink_query |
The base query to be used when linkifying values of ticket
fields. The query is a URL query
string starting with | ?status=!closed |
[report]
items_per_page |
Number of tickets displayed per page in ticket reports,
by default. Set to | 100 |
items_per_page_rss |
Number of tickets displayed in the rss feeds for reports.
Set to | 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]
default_log_limit | Default value for the limit argument in the TracRevisionLog. | 100 |
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 | 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: | (no default) |
min_query_length | Minimum length of query string allowed when performing a search. | 3 |
[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 | (no default) |
authz_module_name |
The module prefix used in the | (no default) |
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/* |
eol_style |
End-of-Line character sequences when
If (since 1.0.2) | native |
tags | 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/* |
[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 | milestone,version |
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_priority | Default priority for newly created tickets. | major |
default_resolution | Default resolution for resolving (closing) tickets. | fixed |
default_severity | Default severity for newly created tickets. | (no default) |
default_summary | Default summary (title) for newly created tickets. | (no default) |
default_type | Default type for newly created tickets. | defect |
default_version | Default version for newly created tickets. | (no default) |
max_comment_size | Maximum allowed comment size in characters. | 262144 |
max_description_size | Maximum allowed description size in characters. | 262144 |
max_summary_size | Maximum allowed summary size in characters. (since 1.0.2) | 262144 |
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'). | default |
restrict_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 |
workflow | Ordered 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_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. | enabled |
changeset_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. | disabled |
changeset_long_messages | Whether wiki-formatted changeset messages should be multiline or not.
If this option is not specified or is false and | disabled |
changeset_show_files |
Number of files to show (
This can also be | 0 |
default_daysback | Default number of days displayed in the Timeline, in days. | 30 |
max_daysback | Maximum number of days (-1 for unlimited) displayable in the Timeline. | 90 |
newticket_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. | oneliner |
ticket_show_component | Enable the display of component of tickets in the timeline. (since 1.1.1) | disabled |
ticket_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) | 90 |
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 default value of 0 makes the cookie expire at the end of the browsing session. (since 0.12) | 0 |
auth_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. (since 0.12) | (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.0 |
auto_reload | Automatically reload template files after modification. | disabled |
backup_dir | Database backup location | db |
base_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) |
check_auth_ip | Whether the IP address of the user should be checked for authentication (since 0.9). | disabled |
database | Database connection string for this project | sqlite:db/trac.db |
debug_sql | Show the SQL queries in the Trac log, at DEBUG level. | disabled |
default_charset | Charset to be used when in doubt. | utf-8 |
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) | relative |
default_handler | Name of the component that handles requests to the base URL.
Options include The session preference for default handler take precedence, when set. | WikiModule |
default_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
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 | (no default) |
ignore_auth_case | Whether login names should be converted to lower case (since 0.9). | disabled |
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 | disabled |
permission_policies |
List of components implementing | DefaultWikiPolicy,DefaultTicketPolicy,DefaultPermissionPolicy,LegacyAttachmentPolicy |
permission_store |
Name of the component implementing | DefaultPermissionStore |
pg_dump_path | Location of pg_dump for Postgres database backups | pg_dump |
request_filters | Ordered list of filters to apply to all requests. | (no default) |
resizable_textareas |
Make | enabled |
secure_cookies | Restrict cookies to HTTPS connections.
When true, set the | disabled |
show_email_addresses | Show email addresses instead of usernames. If false, email addresses are obfuscated for users that don't have EMAIL_VIEW permission. | disabled |
show_full_names | Show full names instead of usernames. (since 1.2) | enabled |
timeout | Timeout value for database connection, in seconds. Use '0' to specify no timeout. | 20 |
use_base_url_for_redirect |
Optionally use
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 | disabled |
use_chunked_encoding |
If enabled, send contents as chunked encoding in HTTP/1.1.
Otherwise, send contents with | enabled |
use_xsendfile |
When true, send a | disabled |
wiki_toolbars | Add a simple toolbar on top of Wiki <textarea>s. (since 1.0.2) | enabled |
xsendfile_header |
The header to use if | 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]
default_edit_area_height | Default height of the textarea on the wiki edit page. (Since 1.1.5) | 20 |
ignore_missing_pages | Enable/disable highlighting CamelCase links to missing pages. | disabled |
max_size | Maximum allowed wiki page size in characters. | 262144 |
render_unsafe_content |
Enable/disable the use of unsafe HTML tags such as For public sites where anonymous users can edit the wiki it is recommended to leave this option disabled. | disabled |
safe_origins |
List of URIs considered "safe cross-origin", that will be
rendered as 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 | cvs,file,ftp,git,irc,http,https,news,sftp,smb,ssh,svn,svn+ssh |
split_page_names | Enable/disable splitting the WikiPageNames with space characters. | disabled |
Reference for special sections
[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 closed.overall_completion = truepercentage 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.
See also: TracGuide, TracAdmin, TracEnvironment
