Trac is being migrated to new services! Issues can be found in our new YouTrack instance and WIKI pages can be found on our website.

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

--

The Trac Configuration File

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

Trac configuration is done by editing the trac.ini config file, located in <projectenv>/conf/trac.ini. Changes to the configuration are usually reflected immediately, though changes to the [components] or [logging] sections will require restarting the web server. You may also need to restart the web server after creating a global configuration file when none was previously present.

The trac.ini configuration file and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.

Global Configuration

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

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

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

[account-manager]

account_changes_notify_addresses

List of email addresses that get notified of user changes, ie, new user, password change and delete user.

(no default)
allow_delete_account

Allow users to delete their own account.

enabled
auth_init

Launch an initial Trac authentication setup.

enabled
db_htdigest_realm

Realm to select relevant htdigest db entries

(no default)
email_regexp

A validation regular expression describing new account emails. Define constraints for a valid email address. A custom pattern can narrow or widen scope i.e. to accept UTF-8 characters.

(?i)^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+\.)+[A-Z0-9-]{2,63}$
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
htdigest_file

Path relative to Trac environment or full host machine path to password file

(no default)
htdigest_realm

Realm to select relevant htdigest file entries

(no default)
login_attempt_max_count

Lock user account after specified number of login attempts. Value zero means no limit.

0
login_opt_list

Set to True, to switch login page style showing alternative actions in a single listing together.

disabled
notify_actions

Comma separated list of actions to notify of. Available actions '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_basic_question

A question to ask instead of the standard prompt, to which the value of register_basic_token is the answer. Setting to empty string (default value) keeps the standard prompt.

(no default)
register_basic_token

A string required as input to pass verification.

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

:[]
username_regexp

A validation regular expression describing new usernames. Define constraints for allowed user names corresponding to local naming policy.

(?i)^[A-Z0-9.\-_]{5,}$
verify_email

Verify the email address of Trac users.

enabled

[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 .zip. Set this to -1 to disable download as .zip. (since 1.0)

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

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

[doxygen]

default_documentation

Default documentation project, relative to [doxygen] path. When no explicit path is given in a documentation request, this path will be prepended to the request before looking for documentation files.

(no default)
default_namespace

Default namespace to search for named objects in.

(no default)
encoding

Default encoding used by the generated documentation files.

iso-8859-1
ext

Space separated list of extensions for doxygen managed files.

htm html png
html_output

Default documentation project suffix, as generated by Doxygen using the HTML_OUTPUT Doxygen configuration setting.

(no default)
index

Default index page to pick in the generated documentation.

main.html
path

Directory containing doxygen generated files.

/var/lib/trac/doxygen
source_ext

Space separated list of source files extensions

idl odl java cs py php php4 inc phtml m cpp cxx c hpp hxx h
title

Title to use for the main navigation tab.

Doxygen
wiki_index

Wiki page to use as the default page for the Doxygen main page. If set, supersedes the [doxygen] index option.

(no default)

[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
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
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 conf directory. (since 1.0)

(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 plugins, with this one taking precedence.

Non-absolute paths are relative to the Environment conf directory.

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

(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_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.log
log_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)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_level

Level of verbosity in log.

Should be one of (CRITICAL, ERROR, WARNING, INFO, DEBUG).

DEBUG
log_type

Logging facility to use.

Should be one of (none, file, stderr, syslog, winlog).

none

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 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_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.*
pygments_default_style

The default style to use for Pygments syntax highlighting.

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

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

Like ticket_subject_template but for batch modifications. (since 1.0)

${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 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_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, 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_path

Path to the sendmail executable.

The sendmail program must accept the -i and -f options.

(since 0.12)

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 smtp_from and smtp_replyto must be set, otherwise Trac refuses to send notification mails.

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, smtp_from and smtp_from_name are used instead. (since 1.0)

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 smtp_from and smtp_replyto must be set, otherwise Trac refuses to send notification mails.

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 [$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 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_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 smtp_default_domain. Do not use this option with a public SMTP server.

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:

SubscriberDescription
AlwaysEmailSubscriber
CarbonCopySubscriberTicket that I'm listed in the CC field is modified
NewTicketSubscriberAny ticket is created
TicketOwnerSubscriberTicket that I own is created or modified
TicketPreviousUpdatersSubscriberTicket that I previously updated is modified
TicketReporterSubscriberTicket that I reported is modified
TicketUpdaterSubscriberI 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
icon

URL of the icon of the project.

common/trac.ico
name

Name of the project.

My Project
url

URL of the main project web site, usually the website in which the base_url resides. This is used in notification e-mails.

(no default)

[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~=$USER
default_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=$USER
items_per_page

Number of tickets displayed per page in ticket queries, by default.

100

[readonlyticket]

ticket_list

List of tickets that should be considered Read-Only for users that don't have the TICKET_ADMIN priviledge.

(no default)

[report]

items_per_page

Number of tickets displayed per page in ticket reports, by default.

100
items_per_page_rss

Number of tickets displayed in the rss feeds for reports.

0

[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. (since 0.12)

(no default)
min_query_length

Minimum length of query string allowed when performing a search.

3

[secdl]

duplicate

Specify what to do if a file is uploaded with an already existing file name. To deny the upload, set it to 'deny' (default), set it to 'allow' to allow two files with the same name. Note that this applies only to local downloads, remote downloads are not restricted.

deny
extensions

Comma separated list of allowed file extensions (without leading dot). Leave this empty to not restrict the file types. The default is 'zip,gz,bz2,rar'. See also the 'no_extension' option.

zip,gz,bz2,rar
lighty_prefix

Must be set to the Lighttpd 'secdownload-uri-prefix' configuration value if mod_secdownload is used. The final download URL will be constructed using this value as the first part after the root path, followed by the protected part of the URL. If regular downloads are enabled, the URL will be the same but without the protected part. Note that if you do not start the value for this option with a '/', an URL relative to the Trac environment root will be created. This is in most cases not what you want!

/download/
lighty_secret

The secret key to protect the downloads (Lighttpd 'secdownload.secret' configuration value). The downloads using mod_secdownload are disabled if this is left empty (default).

(no default)
max_files

Maximum number of uploaded files. If this limit is reached, no more uploads are allowed. Set this to '0' to allow an unlimited number of uploads (default). Note that this applies to local files only.

0
max_size

Maximum allowed file size for uploaded files in bytes. Note that a file has to be uploaded completely before this can be checked. Set 'max_size' to '0' to not restrict the file size. The default value is '524288' (512 KiB). See also the 'max_total' configuration option. Note that this applies to local files only.

524288
max_total

Maximum total size of uploaded files in bytes. If a new file upload would exceed this limit it will be denied. Note that a file has to be uploaded completely before this can be checked (unless the limit is already reached). Set this to '0' to disable this feature (default). This applies to local files only.

0
no_extension

In addition to the allowed file extensions specified by the 'extensions' option, allow files with no extension to be uploaded if this option is set to True. The default value is False.

disabled
order

Default order of the downloads table, specified as comma separated list of field names. See 'show_fields' for a list of allowed field names. You may prepend a '!' to change the sort order of a given field (eg. use '!name' to sort by file name in a descending order). Note that the fields used here have to be included in the 'show_fields' list, too. The default value is '!time', so latest downloads will be shown at the top of the table.

!time
regular_downloads

Enable regular downloads not using mod_secdownload. Note that the webserver has to be configured to serve the files in 'upload_dir'. This option will be ignored unless 'lighty_secret' is empty and 'use_xsendfile' is disabled. Regular downloads may be used on other servers than Lighttpd, too, but keep in mind that there are no further restrictions to access these files.

disabled
schemes

Comma separated list of allowed schemes for the remote downloads. A remote download with another scheme can not be created. To not restrict the remote URLs leave this option empty. Note that URLs without a scheme are always denied. The default is 'http,https'.

http,https
show_fields

Comma separated list of fields to show on the downloads index page. Valid options are: 'id', 'name', 'url', 'description', 'size', 'time', 'last_request', 'count', 'author', 'ip', 'component', 'version', 'milestone', 'platform', 'architecture', 'type', 'hidden', 'checksum_md5', 'checksum_sha'. Note that some options are not displayed in a separate column but will force a new table row, and some options are not displayed at all (though they are valid). The order does not matter.

name,size,description,url,time,checksum_md5,checksum_sha
temp_dir

Temporary directory for uploaded files. If this is empty (default) 'upload_dir' will be used. Note that it is highly recommended to use a directory on the same physical partition as 'upload_dir'. The directory must exist and the user running Trac must have write access to this directory.

(no default)
title

Main navigation link title, and title of the downloads index page. Defaults to 'Downloads'.

Downloads
trac_downloads

If 'lighty_secret' is not set and 'regular_downloads' is disabled, too, this option can be enabled to allow downloads to be handled by Trac itself. This is disabled by default.

disabled
unmanaged_file_external_prefix

If using a 'unmanaged_file_prefix' and 'regular' file serving, this needs to be set to the prefix the files stored under 'unmanaged_file_prefix' are being exposed via the web server.

(no default)
unmanaged_file_prefix

If you are going to use unmanaged locally hosted files not uploaded using the admin interface, this must be set to a prefix relative to which these local files can be found. Don't set this to / - that'll cause potential leakage!!!

/dev/null/
upload_dir

Directory to store uploaded files. The directory must exist and the user running Trac must have write access to this directory. The user running Lighttpd (or any other webserver if regular downloads are used) must have read permissions. The default value is '/var/lib/trac/files'. Note that you can safely use the same upload directory for multiple environments, the uploaded files are automatically stored in subdirectories for each environment.

/var/lib/trac/files
url

URL of the downloads page relative to the Trac environment root (one word, no slashes). Defaults to 'download'.

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

disabled
wiki_prefix

Comma separated list of prefixes used in the wiki to link to the downloads. The default value is 'download,secdownload'.

download,secdownload

[simpleticket]

fields

Fields to hide for the simple ticket entry form.

(no default)
show_only

If True, show only the specified fields rather than hiding the specified fields

disabled

[ticket]

allowed_empty_fields

Comma-separated list of select fields that can have an empty value. (since 1.1.2)

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.

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

Status to apply when removing 'Pending' status automatically.

new
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 overriden by specific event providers, see their own documentation.

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

disabled

[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
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. (since 0.12)

2.0
auto_reload

Automatically reload template files after modification.

disabled
backup_dir

Database backup location

db
base_url

Reference 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_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 TimelineModule, RoadmapModule, BrowserModule, QueryModule, ReportModule, TicketModule and WikiModule.

WikiModule
default_language

The preferred language to use if no user preference has been set. (since 0.12.1)

(no default)
default_timezone

The default timezone to use

(no default)
genshi_cache_size

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

(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 1.11.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.11.3.min.js, http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.11.3.min.js or https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js.

(since 1.0)

(no default)
jquery_ui_location

Location of the jQuery UI JavaScript library (version 1.11.4).

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.11.4/jquery-ui.min.js or http://ajax.aspnetcdn.com/ajax/jquery.ui/1.11.4/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.11.4).

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.11.4/themes/start/jquery-ui.css or http://ajax.aspnetcdn.com/ajax/jquery.ui/1.11.4/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.

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

ReadonlyWikiPolicy,DefaultPermissionPolicy,LegacyAttachmentPolicy
permission_store

Name of the component implementing IPermissionStore, which is used for managing user and group permissions.

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 <textarea> fields resizable. Requires JavaScript. (since 0.12)

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

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
show_ip_addresses

Show IP addresses for resource edits (e.g. wiki). Since 1.0.5 this option is deprecated and will be removed in 1.3.1.

disabled
timeout

Timeout value for database connection, in seconds. Use '0' to specify no timeout.

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

disabled
use_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)

disabled
use_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)

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 use_xsendfile is enabled. If Nginx is used, set X-Accel-Redirect. (since 1.0.6)

X-Sendfile

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

disabled
safe_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+ssh
split_page_names

Enable/disable splitting the WikiPageNames with space characters.

disabled

[wiki-notification]

attach_diff

Send diff's as an attachment instead of inline in email body.

disabled
banned_addresses

A comma separated list of email addresses that should never be sent a notification email.

(no default)
from_name

Sender name to use in notification emails.

Defaults to project name.

(no default)
redirect_time

The default seconds a redirect should take when watching/un-watching a wiki page

5
smtp_always_bcc

Comma separated list of email address(es) to always send notifications to.

Addresses do not appear publicly (Bcc:).

(no default)
smtp_always_cc

Comma separated list of email address(es) to always send notifications to.

Addresses can be seen by all recipients (Cc:).

(no default)
smtp_from

Sender address to use in notification emails.

trac+wiki@localhost
subject_template

A Genshi text template snippet used to get the notification subject.

$prefix $pagename $action
use_public_cc

Recipients can see email addresses of other CC'ed recipients.

If this option is disabled(the default), recipients are put on BCC.

(values: 1, on, enabled, true or 0, off, disabled, false)

disabled

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

All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!