Version 1 (modified by trac, 13 years ago) (diff)

--

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

### [git]

 cached_repository Wrap GitRepository in CachedRepository. false git_bin Path to the git executable. git git_fs_encoding Define charset encoding of paths within git repositories. utf-8 persistent_cache Enable persistent caching of commit tree. false projects_base Path to the base of your git projects (no default) projects_list Path to a gitweb-formatted projects.list (no default) projects_url Template for project URLs. %s will be replaced with the repo name (no default) shortrev_len The length at which a sha1 should be abbreviated to (must be >= 4 and <= 40). 7 trac_user_rlookup Enable reverse mapping of git email addresses to trac user ids. Performance will be reduced if there are many users and the cached_repository option is disabled. A repository resync is required after changing the value of this option. false use_committer_id Use git-committer id instead of git-author id for the changeset Author field. true use_committer_time Use git-committer timestamp instead of git-author timestamp for the changeset Timestamp field. true wikishortrev_len The minimum length of an hex-string for which auto-detection as sha1 is performed (must be >= 4 and <= 40). 40

### [google.analytics]

 admin_logging Disabling this option will prevent all logged in admins from showing up on your Google Analytics reports. disabled authenticated_logging Disabling this option will prevent all authenticated users from showing up on your Google Analytics reports. enabled extensions Enter any extensions of files you would like to be tracked as a download. For example to track all MP3s and PDFs enter: mp3,pdf Outbound link tracking must be enabled for downloads to be tracked. zip,tar,tar.gz,tar.bzip,egg google_external_path This will be the path shown on Google Analytics regarding external links. Consider the following link: The above link will be shown as for example: /external/trac.edgewall.org/ This way you will be able to track outgoing links. Outbound link tracking must be enabled for external links to be tracked. /external/ outbound_link_tracking Disabling this option will turn off the tracking of outbound links. It's recommended not to disable this option unless you're a privacy advocate (now why would you be using Google Analytics in the first place?) or it's causing some kind of weird issue. enabled tracking_domain_name If you're tracking multiple subdomains with the same Google Analytics profile, like what's talked about in: enter your main domain here. For more info, please visit the previous link. (no default) uid Google Analytics' UID. The UID is needed for Google Analytics to log your website stats. Your UID can be found by looking in the JavaScript Google Analytics gives you to put on your page. Look for your UID in between var pageTracker = _gat._getTracker("UA-111111-11"); in the javascript. In this example you would put UA-11111-1 in the UID box. (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 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 width Width of the header logo image in pixels. -1

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

The .compat option can be used to activate or disable a compatibility mode:

• If the targeted Trac is running a version below 0.10 (r3526 to be precise), then it doesn't know how to dispatch an InterTrac link, and it's up to the local Trac to prepare the correct link. Not all links will work that way, but the most common do. This is called the compatibility mode, and is false by default.
• If you know that the remote Trac knows how to dispatch InterTrac links, you can explicitly disable this compatibility mode and then any TracLinks can become InterTrac links.

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 (see ​http://docs.python.org/library/logging.html), one could use:$(path)s the path for the current environment $(basename)s the last path component of the current environment$(project)s the project name Note the usage of $(...)s instead of %(...)s as the latter form would be interpreted by the ConfigParser itself. Example: ($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s:$(message)s (since 0.10.5) (no default) log_level Level of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG). DEBUG log_type Logging facility to use. Should be one of (none, file, stderr, syslog, winlog). none

### [milestone]

 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.

(since 0.11)

### [mimeviewer]

 max_preview_size Maximum file size for HTML preview. (since 0.9) 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. (since 0.10) 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|INSTALL|COPYING.* tab_width Displayed tab width in file preview. (since 0.9) 8 treat_as_binary Comma-separated list of MIME types that should be treated as binary data. (since 0.11.5) 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) always_notify_owner Always send notifications to the ticket owner (since 0.9). false always_notify_reporter Always send notifications to any address in the reporter field. false always_notify_updater Always send notifications to the person who causes the ticket property change and to any previous updater of that ticket. true ambiguous_char_width Which width of ambiguous characters (e.g. 'single' or 'double') should be used in the table of 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. By default, the template is $prefix Batch modify:$tickets_descr. (since 1.0) $prefix Batch modify:$tickets_descr 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) mime_encoding Specifies the MIME encoding scheme for emails. Valid options are 'base64' for Base64 encoding, 'qp' for Quoted-Printable, and 'none' for no encoding, in which case mails will be sent as 7bit if the content is all ASCII, or 8bit otherwise. (since 0.10) 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 Email address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10) (no default) smtp_always_cc Email address(es) to always send notifications to, addresses can be seen by all recipients (Cc:). (no default) smtp_default_domain Default host/domain to append to address that do not specify one. (no default) smtp_enabled Enable email notification. false smtp_from Sender address to use in notification emails. trac@localhost smtp_from_author Use the action author as the sender of notification emails. (since 1.0) false smtp_from_name Sender name to use in notification emails. (no default) smtp_password Password for SMTP server. (since 0.9) (no default) smtp_port SMTP server port to use for email notification. 25 smtp_replyto Reply-To address to use in notification emails. 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 the [$project_name] prefix. If no prefix is desired, then specifying an empty option will disable it. (since 0.10.1) __default__ smtp_user Username for SMTP server. (since 0.9) (no default) ticket_subject_template A Genshi text template snippet used to get the notification subject. By default, the subject template is$prefix #$ticket.id:$summary. $prefix being the value of the smtp_subject_prefix option. (since 0.11) $prefix #$ticket.id:$summary 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. (since 0.10) false 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. (since 0.10) false use_tls Use SSL/TLS to send notifications over SMTP. (since 0.10) false

### [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. (since 0.11.3) . descr Short description of the project. My example project footer Page footer text (right-aligned). Visit the Trac open source project at
http://trac.edgewall.org/ 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)

### [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. (since 0.11.2) 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. (since 0.11.2) status!=closed&owner=$USER items_per_page Number of tickets displayed per page in ticket queries, by default (since 0.11) 100 ticketlink_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. (since 0.12) ?status=!closed

### [repositories]

One of the alternatives for registering new repositories is to populate the [repositories] section of the trac.ini.

This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.

See TracRepositoryAdmin for details about the format adopted for this section and the rest of that page for the other alternatives.

(since 0.12)

### [revisionlog]

 default_log_limit Default value for the limit argument in the TracRevisionLog. (since 0.11) 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 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

### [sqlite]

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

### [svn]

 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 (the default), substitute with the native EOL marker on the server. Otherwise, if LF, CRLF or CR, substitute with the specified EOL marker. (since 1.0.2) native 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/*, /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

### [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. (since 0.12.1) (no default)

### [vote]

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

### [wiki]

 ignore_missing_pages Enable/disable highlighting CamelCase links to missing pages (since 0.9). false max_size Maximum allowed wiki page size in characters. (since 0.11.2) 262144 render_unsafe_content Enable/disable the use of unsafe HTML tags such as

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