TracIni - Xwrits - Trac

The Trac Configuration File

Trac configuration is done by editing the trac.ini config file, located in <projectenv>/conf/trac.ini.

Global Configuration

Since version 0.9, Trac can also read the configuration from a global trac.ini file. These global options will then be merged with the environment-specific options, where local options override global options.

The global configuration is by default localted in $prefix/share/trac/conf/trac.ini. It can be moved to a different location (for example, /etc/trac.ini), but that requires changing the file trac/siteconfig.py which gets created when Trac is installed.

Reference

This is a brief reference of available configuration options.

[trac]

databaseDatabase connection string for this project
default_charsetCharset used in text files in the subversion repository (default is iso-8859-15)
default_handlerName of the component that handles requests to the base URL (default is WikiHandler) (since 0.9)
repository_dirPath to local Subversion repository
authz_filePath to Subversion authorization (authz) file.
authz_module_nameThe module prefix used in the authz_file (See FineGrainedPermissions?)
check_auth_ipWhether the IP address of the user should be checked for authentication (true, false) (since 0.9)
ignore_auth_caseWhether case should be ignored for login names (true, false) (since 0.9)
templates_dirPath to the ClearSilver templates

[project]

nameProject name
descrShort project description
urlURL to the main project website
iconURL to icon file to use as shortcut icon (favicon)
footerPage footer text (right-aligned)
srcURL to image to use as header logo
linkDestination URL to link to from header logo
altalt text for header logo
widthHeader logo width in pixels
heightHeader logo height in pixels

See also: TracInterfaceCustomization.

[logging]

log_typeLogging facility to use. (none, file, stderr, syslog, winlog)
log_fileIf log_type is file, this should be a path to the log-file
log_levelLevel of verbosity in log (CRITICAL, ERROR, WARN, INFO, DEBUG)

See also: TracLogging

[attachment]

max_sizeMaximum allowed file size for ticket and wiki attachments

[notification]

smtp_enabledEnable SMTP (email) notification (true, false)
smtp_serverSMTP server to use for email notifications
smtp_userUsername for SMTP server (since 0.9)
smtp_passwordPassword for SMTP server (since 0.9)
smtp_fromSender address to use in notification emails
smtp_replytoReply-To address to use in notification emails
smtp_always_ccEmail address(es) to always send notifications to
always_notify_reporterAlways send notifications to any address in the reporter field
always_notify_ownerAlways send notifications to the ticket owner (since 0.9)

See also: TracNotification

[mimeviewer]

enscript_pathPath to the Enscript program
php_pathPath to the PHP program
max_preview_sizeMaximum file size for HTML preview (since 0.9)
tab_widthDisplayed tab width in file preview (since 0.9)

[ticket]

default_versionDefault version for newly created tickets
default_severityDefault severity for newly created tickets
default_priorityDefault priority for newly created tickets
default_milestoneDefault milestone for newly created tickets
default_componentDefault component for newly created tickets
restrict_ownerMake the owner field of tickets use a drop-down menu (since 0.9)

[ticket-custom]

Creates user-defined ticket fields.

[timeline]

default_daysbackDefault "depth" of the Timeline, in days (since 0.9)
changeset_show_filesNumber of files to show (-1 for unlimited, 0 to disable)
 ticket_show_detailsEnable the display of all ticket changes in the timeline

[browser]

hide_propertiesList of subversion properties to hide from the repository browser (since 0.9)

[wiki]

ignore_missing_pagesenable/disable highlighting CamelCase links to missing pages (since 0.9)

[components]

(since 0.9)

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

Note that prior to Trac r2335 (that applies to 0.9b1 and 0.9b2), you would use a [disabled_components] section instead. See a previous version of this page for the details.


See also: TracGuide, TracAdmin, TracEnvironment