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

### [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. true 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_htdigest_realm Realm to select relevant htdigest db entries (no default) 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. true force_passwd_change Force the user to change password when it's reset. true 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) 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_opt_list Set to True, to switch login page style showing alternative actions in a single listing together. false password_format Legacy option, deprecated since acct_mgr-0.1.2 (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. false 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. false 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. true username_char_blacklist Always exclude some special characters from usernames. This is enforced upon new user registration. :[] verify_email Verify the email address of Trac users. true

### [announcer]

 always_notify_cc The always_notify_cc will notify users in the cc field by default when a ticket is modified. true always_notify_cc_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email always_notify_component_owner Whether or not to notify the owner of the ticket's component. The user can override this setting in their preferences. true always_notify_component_owner_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email always_notify_custom_cc The always_notify_custom_cc will notify the users in the custom cc field by default when a ticket is modified. true always_notify_custom_cc_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email always_notify_owner The always_notify_owner option mimics the option of the same name in the notification section, except users can override it in their preferences. true always_notify_owner_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email always_notify_reporter The always_notify_reporter will notify the ticket reporter when a ticket is modified by default. true always_notify_reporter_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email always_notify_user_admins Sent user account notification to admin users per default, so they may opt-out individually instead of requiring everyone to opt-in. true always_notify_user_admins_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email ctxtnav_names Text of context navigation entries. An empty list removes them from the context navigation bar. Watch This, Unwatch This custom_cc_fields Field names that contain users that should be notified on ticket changes (no default) default_email_format The default mime type of the email notifications. This can be overridden on a per user basis through the announcer preferences panel. text/plain email_address_resolvers SpecifiedEmailResolver, SessionEmailResolver, DefaultDomainEmailResolver email_always_bcc Email addresses specified here will always be bcc'd on all announcements. This setting is dangerous if accountmanager is present. (no default) email_always_cc Email addresses specified here will always be cc'd on all announcements. This setting is dangerous if accountmanager is present. (no default) email_crypto Enable cryptographically operation on email msg body. Empty string, the default for unset, disables all crypto operations. Valid values are: sign sign msg body with given privkey encrypt encrypt msg body with pubkeys of all recipients sign,encrypt sign, than encrypt msg body (no default) email_default_domain Default host/domain to append to address that do not specify one (no default) email_enabled Enable email notification. true email_from Sender address to use in notification emails. trac@localhost email_from_name Sender name to use in notification emails. (no default) email_replyto Reply-To address to use in notification emails. trac@localhost email_sender Name of the component implementing IEmailSender. This component is used by the announcer system to send emails. Currently, SmtpEmailSender and SendmailEmailSender are provided. SmtpEmailSender email_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. __default__ email_threaded_realms These are realms with announcements that should be threaded emails. In order for email threads to work, the announcer system needs to give the email recreatable Message-IDs based on the resources in the realm. The resources must have a unique and immutable id, name or str() representation in it's realm ticket,wiki email_to Default To: field undisclosed-recipients: ; filter_exception_realms The PermissionFilter? will filter announcements, for which the user doesn't have${REALM}_VIEW permission. If there is some realm that doesn't use a permission called ${REALM}_VIEW, then you should add it to this list and create a custom filter to enforce it's permissions. Be careful, or permissions could be bypassed using the AnnouncerPlugin?. acct_mgr gpg_binary GnuPG binary name, allows for full path too. Value 'gpg' is same default as in python-gnupg itself. For usual installations location of the gpg binary is auto-detected. gpg gpg_home Directory containing keyring files. In case of wrong configuration missing keyring files without content will be created in the configured location, provided necessary write permssion is granted for the corresponding parent directory. (no default) gpg_signing_key Keyid of private key (last 8 chars or more) used for signing. If unset, a private key will be selected from keyring automagicly. The password must be available i.e. provided by running gpg-agent or empty (bad security). On failing to unlock the private key, msg body will get emptied. (no default) ignore_cc_changes When true, the system will not send out announcement events if the only field that was changed was CC. A change to the CC field that happens at the same as another field will still result in an event being created. false joinable_groups Joinable groups represent 'opt-in' groups that users may freely join. Enter a list of groups (without @) seperated by commas. The name of the groups should be a simple alphanumeric string. By adding the group name preceeded by @ (such as @sec for the sec group) to the CC field of a ticket, everyone in that group will receive an announcement when that ticket is changed. (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. Note that the no encoding means that non-ASCII characters in text are going to cause problems with notifications. base64 never_notify_updater The never_notify_updater stops users from recieving announcements when they update tickets. false never_notify_updater_distributor Comma-separated list of distributors to send the message to by default. ex. email, xmpp email rcpt_allow_regexp A whitelist pattern to match any address to before adding to recipients list. (no default) rcpt_local_regexp A whitelist pattern to match any address, that should be considered local. This will be evaluated only if msg encryption is set too. Recipients with matching email addresses will continue to receive unencrypted email messages. (no default) subscription_resolvers Comma-separated list of subscription resolver components in the order they will be called. SubscriptionResolver ticket_email_header_fields Comma-separated list of fields to appear in tickets. Use * to include all headers. owner, reporter, milestone, priority, severity ticket_email_subject Format string for ticket email subject. This is a mini genshi template that is passed the ticket event and action objects. Ticket #${ticket.id}: ${ticket['summary']} {% if action %}[${action}]{% end %} ticket_link_with_comment Include last change anchor in the ticket URL. false 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 false use_threaded_delivery Do message delivery in a separate thread. Enabling this will improve responsiveness for requests that end up with an announcement being sent over email. It requires building Python with threading support enabled— which is usually the case. To test, start Python and type 'import threading' to see if it raises an error. false watchable_paths List of URL paths to allow watching. Globs are supported. wiki/*,ticket/* wiki_email_diff Should a wiki diff be sent with emails? true wiki_email_subject Format string for the wiki email subject. This is a mini genshi template and it is passed the page, event and action objects. Page: ${page.name}${action}

### [attachment]

 max_size Maximum allowed file size (in bytes) for ticket and wiki 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 (which is the default). false

### [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. (since 0.11) true 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. (since 0.10) /trunk, /branches/*, /tags/* hide_properties Comma-separated list of version control properties to hide from the repository browser. (since 0.9) 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 intermediate_point). If not set, the intermediate color between oldest_color and newest_color will be used. (since 0.11) (no default) intermediate_point If set to a value between 0 and 1 (exclusive), this will be the point chosen to set the intermediate_color for interpolating the color value. (since 0.11) (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 color_scale is enabled. (since 0.11) (255, 136, 136) oldest_color (r,g,b) color triple to use for the color corresponding to the oldest color, for the color scale used in blame or the browser age column if color_scale is enabled. (since 0.11) (136, 136, 255) oneliner_properties Comma-separated list of version control properties to render as oneliner wiki content in the repository browser. (since 0.11) 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 (which is the default). false wiki_properties Comma-separated list of version control properties to render as wiki content in the repository browser. (since 0.11) 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 (since 0.10). 10000000 max_diff_files Maximum number of modified files for which the changeset view will attempt to show the diffs inlined (since 0.10). 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. true

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


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.

To view the list of active components, go to the Plugins page on About Trac (requires CONFIG_VIEW permissions).

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

### [report]

 items_per_page Number of tickets displayed per page in ticket reports, by default (since 0.11) 100 items_per_page_rss Number of tickets displayed in the rss feeds for reports (since 0.11) 0

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

### [sendmail]

 sendmail_path Path to the sendmail executable. The sendmail program must accept the -i and -f options. sendmail

### [slack]

 channel Channel name on Slack #Trac fields Fields to include in Slack notification type,component,resolution username Username of the bot on Slack notify Trac-Bot webhook Incoming webhook for Slack https://hooks.slack.com/services/ wiki-channel Channel name on Slack #TracWiki wiki-username Username of the bot on Slack notify Trac-Bot wiki-webhook Incoming webhook for Slack https://hooks.slack.com/services/ wikiadd Turn add notification on or off (defaults on) 1 wikichange Turn change notification on or off (defaults off) 0 wikidel Turn delete notification on or off (defaults on) 1 wikipages Regex of wiki pages to notify on change of .*

### [smtp]

 debuglevel Set to 1 for useful smtp debugging on stdout. 0 password Password for SMTP server. (no default) port SMTP server port to use for email notification. 25 server SMTP server hostname to use for email notifications. localhost timeout SMTP server connection timeout. (requires python-2.6) 10 use_ssl Use ssl for smtp connection. false use_tls Use SSL/TLS to send notifications over SMTP. false user Username for SMTP server. (no default)

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

### [tracmath]


### [tracwysiwyg]

 templates List of template names that the plugin will show a WYSIWYG editor on each TracWiki textarea. The plugin shows on all pages by default. (no default) wysiwyg_stylesheets Add stylesheets to the WYSIWYG editor (no default)

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

### [wiki]

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

### [wikiextras]

 done_phrases Analogous to FIXME-phrases, but presentation is less eye-catching. DONE, DEBUGGED, FIXED, REVIEWED fixme_phrases A list of attentional phrases or single words, separated by comma (,) that will be highlighted to catch attention. Any delimiter ():<> adjacent to a phrase will not be presented. (i.e. do not include any of these delimiters in this list). This makes it possible to naturally write, for example, FIXME: in a wiki text, but view the phrase highlighted without the colon (:) which would not look natural. Use the ShowPhrases macro to show a list of currently defined phrases. BUG, FIXME icon_limit To prevent exhaustive network traffic, limit the maximum number of icons generated by the macro Icon. Set to 0 for unlimited number of icons (this will produce exhaustive network traffic—you have been warned!) 32 lbox_width Width of left aligned boxes (defaults to rbox_width). 300 rbox_width Width of right aligned boxes. 300 shadowless_boxes Use shadowless boxes. false shadowless_icons Use shadowless icons. false showicons_limit To prevent exhaustive network traffic, limit the maximum number of icons generated by the macro ShowIcons. Set to 0 for unlimited number of icons (this will produce exhaustive network traffic—you have been warned!) 96 todo_phrases Analogous to FIXME-phrases, but presentation is less eye-catching. REVIEW, TODO wide_toc Right aligned boxes with table of contents, produced by the PageOutline macro, are either as wide as ordinary right aligned boxes (true) or narrow (false). false

### [wikiextras-custom-phrases]

Custom phrases are configurable by providing associations between a CSS class and the list of phrases separated by comma.

Example:

[wikiextras-custom-phrases]
nice = NICE, COOL


### [wikiextras-smileys]

The set of smileys is configurable by providing associations between icon names and wiki keywords. A default set of icons and keywords is defined, which can be revoked one-by-one (_remove) or all at once (_remove_defaults).

Example:

[wikiextras-smileys]
_remove_defaults = true
_remove = :-( :(
smiley = :-) :)
smiley-wink = ;-) ;)
clock = (CLOCK) (TIME)
calendar-month = (CALENDAR) (DATE)
chart = (CHART)
document-excel = (EXCEL)
document-word = (WORD)
eye = (EYE)
new = (NEW)
tick = (TICK)


Keywords are space-separated!

A smiley can also be removed by associating its icon with nothing:

smiley =


Use the ShowSmileys macro to find out the current set of icons and keywords.

 _remove Space-separated(!) list of keywords that shall not be interpreted as smileys (even if defined in this section). (no default) _remove_defaults Set to true to remove all default smileys. false

### [wikiextras-symbols]

The set of symbols is configurable by providing associations between symbols and wiki keywords. A default set of symbols and keywords is defined, which can be revoked one-by-one (_remove) or all at once (_remove_defaults).

Example:

[wikiextras-symbols]
_remove_defaults = true
_remove = <- ->
&laquo; = <<
&raquo; = >>
&sum; = (SUM)
&hearts; = <3


Keywords are space-separated!

A symbol can also be removed by associating it with no keyword:

&larr; =


Use the ShowSymbols macro to find out the current set of symbols and keywords.

 _remove Space-separated(!) list of keywords that shall not be interpreted as symbols (even if defined in this section). (no default) _remove_defaults Set to true to remove all default symbols. false