# 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 Trac Environment 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 Trac Interface Customization 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 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 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. 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 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 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. 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_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 require_approval Whether account registration requires administrative approval to enable the account or not. false 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. :[] 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. true

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

### [authz_policy]

 authz_file Location of authz policy configuration file. (no default)

### [autocomplete]

 fields select fields to autocomplement (no default)

### [blackmagic]

 gray_disabled If not set, disabled items will have a label with strike-through font. Otherwise, this color will be used to gray them out. Suggested value is #cccccc. (no default) permissions List of user-defined permissions (Deprecated in 0.12 in favor of Trac's tracopt.perm.config_perm_provider.ExtraPermissionsProvider component, see Trac Permissions#Creating New Privileges) (no default)

### [bookmark]

 paths List of URL paths to allow bookmarking on. Globs are supported. /*
 ignore_pattern Resource names that match this pattern will not be added to the breadcrumbs trail. (no default) label Text label to show before breadcrumb list. If empty, 'Breadcrumbs:' is used as default. (no default) max_crumbs Indicates maximum number of breadcrumbs to store per user. 6 paths List of URL paths to allow breadcrumb tracking. Globs are supported. /wiki/,/ticket/,/milestone/

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

### [cards]

 auto_refresh Automatically poll the server to refresh all cards periodically. True auto_refresh_interval Interval between automatic refresh requests in seconds. 10

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

### [contactform]

 intro_text Introductory text to use in the email. (no default) recipients Recipients for the contact form. (no default)

### [discussion]

 automatic_forum_tags Tags that will be created automatically from discussion forums fields. Possible values are: name, author. name,author automatic_topic_tags Tags that will be created automatically from discussion topics fields. Possible values are: author, status. author,status default_message_display Default display mode for topic messages list. tree default_topic_display Default display mode for forum topics list. classic forum_sort Column by which will be sorted forum lists. Possible values are: id, group, name, subject, time, moderators, description, topics, replies, lasttopic, lastreply. lasttopic forum_sort_direction Direction of forum lists sorting. Possible values are: asc, desc. asc messages_per_page Number of messages per page in message list. 50 smtp_always_cc Always send discussion notifications to the listed e-mail addresses. (no default) title Main navigation bar button title. Discussion topic_sort Column by which will be sorted topic lists. Possible values are: id, forum, subject, time, author, body, replies, lastreply. lastreply topic_sort_direction Direction of topic lists sorting. Possible values are: asc, desc. asc topics_per_page Number of topics per page in topic list. 30

### [extended_version]

 milestone_stats_provider Name of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on per milestone tickets in the version view. DefaultTicketGroupStatsProvider navigation_item The main navigation item to highlight when displaying versions. roadmap show_milestone_description whether to display milestone descriptions on version page. false version_stats_provider Name of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on all version tickets. DefaultTicketGroupStatsProvider

### [extra-permissions]

This section provides a way to add arbitrary permissions to a Trac environment. This can be useful for adding new permissions to use for workflow actions, for example.

To add new permissions, create a new section [extra-permissions] in your trac.ini. Every entry in that section defines a meta-permission and a comma-separated list of permissions. For example:

[extra-permissions]


This entry will define three new permissions EXTRA_VIEW, EXTRA_MODIFY and EXTRA_DELETE, as well as a meta-permissions EXTRA_ADMIN that grants all three permissions.

If you don't want a meta-permission, start the meta-name with an underscore (_):

[extra-permissions]
_perms = extra_view, extra_modify


### [forms]

 parent_blacklist Deaktivate form submission from these (parent) resources. Resources are specified as comma-separated list of paths and/or : pairs, even with REGEXP pattern supported for resource IDs in the latter specifier type. wiki:PageTemplates/*,/newticket show_fullname Display full names instead of usernames if available. false show_fullname_position Comma-separated list containing one or more of the possible positional descriptors 'change', 'macro', 'value'. Default is to show full names in 'macro' content only. macro

### [graphviz]

 cache_dir The directory that will be used to cache the generated images. Note that if different than the default (gvcache), this directory must exist. If not given as an absolute path, the path will be relative to the files directory within the Trac environment's directory. gvcache cache_manager If this entry exists and set to true in the configuration file, then the cache management logic will be invoked and the cache_max_size, cache_min_size, cache_max_count and cache_min_count must be defined. false cache_max_count The maximum number of files that the cache should contain. This is the high watermark for the directory entry count. 2000 cache_max_size The maximum size in bytes that the cache should consume. This is the high watermark for disk space used. 10485760 cache_min_count The minimum number of files that the cache should contain. This is the low watermark for the directory entry count. 1500 cache_min_size When cleaning out the cache, remove files until this size in bytes is used by the cache. This is the low watermark for disk space used. 5242880 cmd_path Full path to the directory where the graphviz programs are located. If not specified, the default is /usr/bin on Linux, C:\Program Files\ATT\Graphviz\bin on Windows and /usr/local/bin on FreeBSD 6. (no default) default_graph_dpi Default dpi setting for graphviz, used during SVG to PNG rasterization. 96 encoding The encoding which should be used for communicating with Graphviz (should match -Gcharset if given). utf-8 out_format Graph output format. Valid formats are: png, jpg, svg, svgz, gif. If not specified, the default is png. This setting can be overrided on a per-graph basis. png png_antialias If this entry exists in the configuration file, then PNG outputs will be antialiased. Note that this requires rsvg to be installed. false processor Graphviz default processor. Valid processors are: dot, neato, twopi, fdp, circo. If not specified, the default is dot. This setting can be overrided on a per-graph basis. GraphvizMacro will verify that the default processor is installed and will not work if it is missing. All other processors are optional. If any of the other processors are missing, a warning message will be sent to the trac log and GraphvizMacro will continue to work. dot rsvg_path Full path to the rsvg program (including the filename). The default is /rsvg. (no default)

### [gridmodify]

 fields List of fields that will be modifiable. (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 Trac Environment; 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

### [hidevals]

 dont_filter Ticket fields to ignore when filtering. (no default)

### [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 Inter Trac prefixes. Options in this section whose name contain a "." define aspects of the Inter Trac 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 Inter Trac 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 Inter Trac 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 true by default.
• If you know that the remote Trac knows how to dispatch Inter Trac links, you can explicitly disable this compatibility mode and then any Trac Links can become Inter Trac 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 Inter Wiki 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 Config Parser? 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

### [logviewer]

 autolevel Which log level shall be used on autoload (only applies when autoload is enabled). This integer value defaults to 3 (warnings). Possible values: 1=critical, 2=error, 3=warning, 4=info, 5=debug 3 autoload Whether the log file content should be automatically loaded when the module is called, i.e. even before the form was submitted. This is a boolean option (true/false), and defaults to false. false autotail Only applies to autoload: Restrict the evaluated lines to the last N lines. Defaults to 1000. 1000 autoup Include log events of higher levels than autolevel on autoload? This boolean option defaults to true - and only applies on autoload true defaultlevel Preset for the log level dropdown (if autoload is disabled). This integer value defaults to 3 (warnings). Possible values: 1=critical, 2=error, 3=warning, 4=info, 5=debug 3 defaulttail Preset for the Tail input (restrict query to the last N lines of the logfile to load). This must be a number (integer), and by default is empty (not set) (no default) defaultup Check the box to include log events of higher levels when autoload is disabled? This boolean option defaults to true. true

### [markdown]

 tab_length Specify the length of tabs in the markdown source. This affects the display of multiple paragraphs in list items, including sub-lists, blockquotes, code blocks, etc. 4
 managed_menus List of menus to be controlled by the Menu Manager mainnav,metanav serve_ui_files true

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

### [miln-checkbox]

 class Cascading Style Sheet (CSS) class name to apply to HTML checkboxes. (no default) type Type of checkbox to render; either html to render an HTML checkbox using the input tag, or unicode to render unicode based ballot box characters ☐ and ☑. html

### [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.* 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. (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

### [privatewikis]

 private_wikis Wikis to protect. Private

### [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 Trac Revision Log. (since 0.11) 100 graph_colors Comma-separated list of colors to use for the Trac Revision Log 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

### [rpc]

 jsonrpc_origin SP separated permitted origins; Where do you want to permit requests from; for jsonrpc Cross-Origin Resource Sharing. ​http://example.com/path for specified, blank for nowhere, *(asterisk) for anywhere to permit. See: ​http://www.w3.org/TR/cors/, ​rfc:6454. (Provided by ContextChrome.CrossOriginResourceSharingEnabler) (no default)

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

### [section-edit]

 edit_subsections Whether to edit all subsections or just the section. false preview_whole_page Whether to preview the entire page or just the section. true

### [spam-filter]

This section is used to handle all configurations used by spam filter plugin.

 account_karma By how many points a failed registration check impacts the overall score. 0 account_replace_checks Replace checks in account manager totally. false akismet_api_key Wordpress key required to use the Akismet API. (no default) akismet_api_url URL of the Akismet service. rest.akismet.com/1.1/ akismet_karma By how many points an Akismet reject impacts the overall karma of a submission. 10 attachment_karma The karma given to attachments. 0 attachment_sample_size The maximum number of bytes from an attachment to pass through the spam filters. 16384 authenticated_karma The karma given to authenticated users, in case trust_authenticated is false. 20 badcontent_file Local file to be loaded to get Bad Content?. Can be used in addition to Bad Content? wiki page. (no default) blogspam_json_api_url URL of the Blog Spam? service. test.blogspam.net:9999 blogspam_json_skip_tests Comma separated list of tests to skip. 45-wordcount.js, 60-drone.js, 80-sfs.js blogspam_karma By how many points an Blog Spam? reject impacts the overall karma of a submission. 5 botscout_api_key API key required to use Bot Scout?. (no default) botscout_karma By how many points a Bot Scout? reject impacts the overall karma of a submission. 3 extlinks_allowed_domains List of domains that should be allowed in external links example.com, example.org extlinks_karma By how many points too many external links in a submission impact the overall score. 2 fspamlist_api_key API key required to use FSpamList. (no default) fspamlist_karma By how many points a FSpamList reject impacts the overall karma of a submission. 3 ip_throttle_karma By how many points exceeding the configured maximum number of posts per hour impacts the overall score. 3 ipbadcontent_file Local file to be loaded to get BadIP. Can be used in addition to BadIP wiki page. (no default) ipregex_karma By how many points a match with a pattern on the BadIP page impacts the overall karma of a submission. 20 is_forwarded Interpret X-Forwarded-For header for IP checks. false logging_enabled Whether all content submissions and spam filtering activity should be logged to the database. true max_external_links The maximum number of external links allowed in a submission until that submission gets negative karma. 4 max_posts_by_ip The maximum allowed number of submissions per hour from a single IP address. If this limit is exceeded, subsequent submissions get negative karma. 10 min_karma The minimum score required for a submission to be allowed. 0 purge_age The number of days after which log entries should be purged. 7 regex_karma By how many points a match with a pattern on the Bad Content? page impacts the overall karma of a submission. 5 register_karma The karma given to registrations. 0 reject_handler The handler used to reject content. FilterSystem report_pages List of page types to add spam report link wiki, attachment, ticket session_karma By how many points an existing and configured session improves the overall karma of the submission. A third of the points is granted for having an existing session at all, the other two thirds are granted when the user has his name and/or email address set in the session, respectively. 6 show_blacklisted Show the matched bad content patterns in rejection message. true show_blacklisted_ip Show the matched bad IP patterns in rejection message. true show_train_only Show the buttons for training without deleting entry. false skip_external Skip external calls when this negative karma is already reached by internal tests. 20 skip_externalham Skip external calls when this positive karma is already reached by internal tests. 30 spam_monitor_entries How many monitor entries are displayed by default (between 5 and 10000). 100 spam_report_entries How many report entries are displayed by default (between 5 and 10000). 100 spam_user_defaultmode Default mode for spam user admin panel. overview spam_user_maxage How many days no login are considered for dead accounts. 200 spam_user_minwiki How many wiki edits are still an unused account. 0 stop_external Stop external calls when this negative karma is reached. 50 stop_externalham Stop external calls when this positive karma is reached. 50 stopforumspam_api_key API key used to report SPAM. (no default) stopforumspam_karma By how many points a Stop Forum Spam? reject impacts the overall karma of a submission. 4 train_external Allow training of external services. true trap_karma By how many points a trap reject impacts the overall karma of a submission. 10 trap_name Name of the invisible trap field, should contain some reference to e-mail for better results. sfp_email trap_name_hidden Name of the hidden trap field, should contain some reference to e-mail for better results. sfph_mail trap_name_register Name of the register trap field, should contain some reference to web/homepage for better results. spf_homepage trust_authenticated Whether content submissions by authenticated users should be trusted without checking for potential spam or other abuse. false use_external Allow usage of external services. true

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

### [tags]

 cloud_caseless_sort Whether the tag cloud should be sorted case-sensitive. false cloud_mincount Integer threshold to hide tags with smaller count. 1 complete_field Ticket field to which a drop-down tag list should be attached. keywords complete_matchcontains Include partial matches in suggestion list. Default is true. true complete_sticky_tags A list of comma separated values available for input. (no default) default_format Set the default format for the handler of the /tags domain. || oldlist (default value) || The original format with a bulleted-list of "linked-id description (tags)" || || compact || bulleted-list of "linked-description" || || table || table… (see corresponding column option) || oldlist default_table_cols Select columns and order for table format using a "|"-separated list of column names. Supported columns: realm, id, description, tags id|description|tags exclude_realms Comma-separated list of realms to exclude from tags queries by default, unless specifically included using "realm:realm-name" in a query. (no default) ignore_closed_tickets Do not collect tags from closed tickets. true listtagged_default_format Set default format for the handler of the /tags domain. See ListTagged description (Wiki Macros) for supported values. oldlist listtagged_default_table_cols Select columns and column order for table format. See ListTagged description (Wiki Macros) for supported values. id|description|tags listtagged_exclude_realms Comma-separated list of realms to exclude from tags queries by default, unless specifically included using 'realm:' in a query. (no default) listtagged_items_per_page Number of tagged resources displayed per page of tag query results requested by ListTagged macros and from /tags. 100 query_exclude_wiki_templates Whether tagged wiki page templates should be queried. true revisable_realms Comma-separated list of realms requiring tag change history. wiki separator Character(s) to use as separators between tags. Default is a single whitespace.   ticket_fields List of ticket fields to expose as tags. keywords ticket_help If specified, 'keywords' label on ticket view will be turned into a link to this URL. (no default) ticket_help_newwindow If true and keywords_help specified, wiki page will open in a new window. Default is false. false wiki_page_link Link a tag to the wiki page with same name, if it exists. true wiki_page_prefix Prefix for tag wiki page names. (no default)

### [ticket]

 commit_ticket_update_check_perms Check that the committer has permission to perform the requested operations on the referenced tickets. This requires that the user names be the same for Trac and repository operations. true commit_ticket_update_commands.close Commands that close tickets, as a space-separated list. close closed closes fix fixed fixes commit_ticket_update_commands.refs Commands that add a reference, as a space-separated list. If set to the special value , all tickets referenced by the message will get a reference to the changeset. addresses re references refs see commit_ticket_update_envelope Require commands to be enclosed in an envelope. Must be empty or contain two characters. For example, if set to "[]", then commands must be in the form of [closes #4]. (no default) commit_ticket_update_notify Send ticket change notification when updating a ticket. true decorate_fields comma separated List of field names to add css class of ticket link. (Provided by ContextChrome.TicketLinkDecorator) type 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 (since 0.11). 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 (since 0.9). defect default_version Default version for newly created tickets. (no default) max_comment_size Don't accept tickets with a too big comment. (since 0.11.2) 262144 max_description_size Don't accept tickets with a too big description. (since 0.11). 262144 preserve_newlines Whether Wiki formatter should respect the new lines present in the Wiki text. If set to 'default', this is equivalent to 'yes' for new environments but keeps the old behavior for upgraded environments (i.e. 'no'). (since 0.11). 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. (since 0.9) false workflow Ordered list of workflow controllers to use for ticket actions (since 0.11). ConfigurableTicketWorkflow

### [ticket-custom]

In this section, you can define additional fields for tickets. See Trac Tickets Custom Fields 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 Trac Workflow for more details.

(since 0.11)

### [ticketfieldslayout]

 fields List of comma delimited field names of ticket and group names which start with an @ character. A group defines as group. in the section. […] (no default) stylesheet_files File names of the stylesheet which the plugin adds to ticket page and ticket form ticketfieldslayout/web_ui.css templates List of template names to apply the fields layout in ticket page and ticket form ticket.html, ticket_box.html, ticket_preview.html

### [tracmath]


### [user_manager]

 admin_default_panel Default user admin panel. profile attribute_provider Name of the component implementing IAttributeProvider, which is used for storing user attributes SessionAttributeProvider user_store Name of the component implementing IUserStore, which is used for storing project's team SessionUserStore wiki_page_attachment Wiki Page used by Trac User Manager? plugin to manage User Profile?'s picture. UserManagerPluginPictures

### [userpictures]

 attachment_lineitem_size 20 attachment_view_size 40 browser_changeset_size 30 browser_filesource_size 40 browser_lineitem_size 20 pictures_provider DefaultUserPicturesProvider report_size 20 search_results_size 20 ticket_comment_diff_size 30 ticket_comment_size 40 ticket_owner_size 30 ticket_reporter_size 60 timeline_size 30 wiki_diff_size 30 wiki_history_lineitem_size 20 wiki_view_size 40

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

 decay_colors List of (age_in_seconds: color) value pairs e.g. "86400:#ffffff, 604800:#cccccc, 2147483647: #777777"; means that the page modified in a day shows on white, in a week shows on light grey, and so on. (Provided by ContextChrome.DecayedWiki) 86400:#ffffff, 604800:#eeeeee, 2678400:#dddddd, 31536000:#aaaaaa, 2147483647: #777777 ignore_missing_pages Enable/disable highlighting Camel Case 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

### [wiki-notification]

 attach_diff Send diff's as an attachment instead of inline in email body. false banned_addresses A comma separated list of email addresses that should never be sent a notification email. (no default) from_email Sender address to use in notification emails. trac+wiki@localhost 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) 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) false

### [wikicalendar]

 internal_css Whether CSS should be embedded into the HTML. This is meant as fallback, if linking the external style sheet file fails. false ticket.due_field Custom due date field name to evaluate for displaying tickets by date. due_close ticket.due_field.format Custom due date value format, that is any expression supported by strftime or 'ts' identifier for POSIX microsecond time stamps as supported in Trac since 1.1.1. %y-%m-%d

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

### [wikiticketcalendar]

 ticket.due_field.format Custom due date value format, that is any expression supported by strftime or 'ts' identifier for POSIX microsecond time stamps as supported in later Trac versions. (depreciated - see wikicalendar section) %y-%m-%d ticket.due_field.name Custom due date field name to evaluate for displaying tickets by date. (depreciated - see wikicalendar section) due_close