The Trac Configuration File

Trac is configured through the trac.ini file, located in the <projectenv>/conf directory. The trac.ini configuration file and its parent directory should be writable by the web server.

Trac monitors the timestamp of the file to trigger an environment reload when the timestamp changes. Most changes to the configuration will be 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.

Global Configuration

Configuration can be shared among environments using one or more global configuration files. Options in the global configuration will be merged with the environment-specific options, with local options overriding global options. The global configuration file is specified as follows:

[inherit]
file = /path/to/global/trac.ini

Multiple files can be specified using a comma-separated list. Non-absolute paths are relative to the Environment conf directory.

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 specify --inherit 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 in the global file.

There are three more options in the [inherit] section, templates_dir for sharing global templates, htdocs_dir for sharing global htdocs and plugins_dir, for sharing plugins. Those options can 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, refresh your modifications when you upgrade to a new version of Trac. The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate ITemplateStreamFilter transformation.

Reference for settings

This is a reference of available configuration options, and their default settings.

Documentation improvements should be discussed on the ​trac-dev mailing list or described in a ​ticket. Even better, ​submit a patch against the docstrings in the code.

[account-manager]

account_changes_notify_addresses	Email addresses to notify on account created, password changed and account deleted.	(no default)
allow_delete_account	Allow users to delete their own account.	enabled
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)
email_regexp	A validation regular expression describing new account emails. Define constraints for a valid email address. A custom pattern can narrow or widen scope i.e. to accept UTF-8 characters.	(?i)^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+\.)+[A-Z0-9-]{2,63}$
environ_auth_overwrite	Whether environment variable REMOTE_USER should get overwritten after processing login form input. Otherwise it will only be set, if unset at the time of authentication.	enabled
force_passwd_change	Force the user to change password when it's reset.	enabled
generated_password_length	Length of the randomly-generated passwords created when resetting the password for an account.	8
hash_method	IPasswordHashMethod used to create new/updated passwords	HtDigestHashMethod
notify_actions	Comma separated list of notification actions. Available actions are 'new', 'change', 'delete'.	(no default)
password_store	Ordered list of password stores, queried in turn.	(no default)
persistent_sessions	Allow the user to be remembered across sessions without needing to re-authenticate. This is, user checks a "Remember Me" checkbox and, next time he visits the site, he'll be remembered.	disabled
refresh_passwd	Re-set passwords on successful authentication. This is most useful to move users to a new password store or enforce new store configuration (i.e. changed hash type), but should be disabled/unset otherwise.	disabled
register_basic_question	A question to ask instead of the standard prompt, to which the value of register_basic_token is the answer. Setting to empty string (default value) keeps the standard prompt.	(no default)
register_basic_token	A string required as input to pass verification.	(no default)
register_check	Ordered list of IAccountRegistrationInspector's to use for registration checks.	BasicCheck,EmailCheck,BotTrapCheck,RegExpCheck,UsernamePermCheck
require_approval	Whether account registration requires administrative approval to enable the account or not.	disabled
reset_password	Set to False, if there is no email system setup.	enabled
username_char_blacklist	Always exclude some special characters from usernames. This is enforced upon new user registration.	:[]
username_regexp	A validation regular expression describing new usernames. Define constraints for allowed user names corresponding to local naming policy.	(?i)^[A-Z0-9.\-_]{5,}$
verify_email	Verify the email address of Trac users.	enabled

[attachment]

max_size	Maximum allowed file size (in bytes) for attachments.	262144
max_zip_size	Maximum allowed total size (in bytes) for an attachment list to be downloadable as a .zip. Set this to -1 to disable download as .zip. (since 1.0)	2097152
render_unsafe_content	Whether attachments should be rendered in the browser, or only made downloadable. Pretty much any file may be interpreted as HTML by the browser, which allows a malicious user to attach a file containing cross-site scripting attacks. For public sites where anonymous users can create attachments it is recommended to leave this option disabled.	disabled

[components]

Enable or disable components provided by Trac and plugins. The component to enable/disable is specified by the option name. The enabled state 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 component or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.

Consider the following configuration snippet:

[components]
trac.ticket.report.ReportModule = disabled
acct_mgr.* = enabled

The first option tells Trac to disable the report module. The second option instructs Trac to enable all components in the acct_mgr package. The trailing wildcard is required for module/package matching.

To view the list of active components, go to the Plugins section of About Trac (requires CONFIG_VIEW permission).

See also: TracPlugins

[git]

cached_repository	Wrap GitRepository in CachedRepository.	disabled
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.	disabled
shortrev_len	The length at which a sha1 is abbreviated (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.	disabled
use_committer_id	Use git-committer id instead of git-author id for the changeset Author field.	enabled
use_committer_time	Use git-committer timestamp instead of git-author timestamp for the changeset Timestamp field.	enabled
wikishortrev_len	The minimum length at which a hex-string in wiki content is formatted as a changeset TracLink (must be >= 4 and <= 40).	40

[gitweb-repositories]

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)
sync_per_request	Repositories to sync on every request (not recommended).	(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

[http-headers]

Headers to be added to the HTTP request. (since 1.2.3)

The header name must conform to ​RFC7230 and the following reserved names are not allowed: content-type, content-length, location, etag, pragma, cache-control, expires.

[inherit]

htdocs_dir	Path to the shared htdocs directory. Static resources in that directory are mapped to /chrome/shared under the environment URL, in addition to common and site locations. This can be useful in site.html for common interface customization of multiple Trac environments. Non-absolute paths are relative to the Environment conf directory. (since 1.0)	(no default)
plugins_dir	Path to the shared plugins directory. Plugins in that directory are loaded in addition to those in the directory of the environment plugins, with this one taking precedence. Non-absolute paths are relative to the Environment conf directory.	(no default)
templates_dir	Path to the shared templates directory. Templates in that directory are loaded in addition to those in the environments templates directory, but the latter take precedence. Non-absolute paths are relative to the Environment conf directory.	(no default)

[intertrac]

This section configures InterTrac prefixes. Option names in this section that contain a . are of the format <name>.<attribute>. Option names that don't contain a . define an alias.

The .url attribute is mandatory and is used for locating the other Trac. This can be a relative path when the other Trac environment is located on the same server.

The .title attribute is used for generating a tooltip when the cursor is hovered over an InterTrac link.

Example configuration:

[intertrac]
# -- Example of setting up an alias:
t = trac

# -- Link to an external Trac:
genshi.title = Edgewall's Trac for Genshi
genshi.url = https://genshi.edgewall.org

[interwiki]

Every option in the [interwiki] section defines one InterWiki prefix. The option name defines the prefix. The option value defines the URL, optionally followed by a description separated from the URL by whitespace. Parametric URLs are supported as well.

Example:

[interwiki]
MeatBall = http://www.usemod.com/cgi-bin/mb.pl?
PEP = http://www.python.org/peps/pep-$1.html Python Enhancement Proposal $1
tsvn = tsvn: Interact with TortoiseSvn

[logging]

log_file	If log_type is file, this should be a path to the log-file. Relative paths are resolved relative to the log directory of the environment.	trac.log
log_format	Custom logging format. If nothing is set, the following will be used: Trac[$(module)s] $(levelname)s: $(message)s In addition to regular key names supported by the ​Python logger library one could use: $(path)s the path for the current environment $(basename)s the last path component of the current environment $(project)s the project name Note the usage of $(...)s instead of %(...)s as the latter form would be interpreted by the ConfigParser itself. Example: ($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s	(no default)
log_level	Level of verbosity in log. Should be one of (CRITICAL, ERROR, WARNING, INFO, DEBUG).	INFO
log_type	Logging facility to use. Should be one of (none, file, stderr, syslog, winlog).	file

[mainnav]

Configures the main navigation bar, which by default contains Wiki, Timeline, Roadmap, Browse Source, View Tickets, New Ticket, Search and Admin.

The label, href, and order attributes can be specified. Entries can be disabled by setting the value of the navigation item to disabled.

The following example renames the link to WikiStart to Home, links the View Tickets entry to a specific report and disables the Search entry.

[mainnav]
wiki.label = Home
tickets.href = /report/24
search = disabled

See TracNavigation for more details.

[metanav]

Configures the meta navigation entries, which by default are Login, Logout, Preferences, Help/Guide and About Trac. The allowed attributes are the same as for [mainnav]. Additionally, a special entry is supported - logout.redirect is the page the user sees after hitting the logout button. For example:

[metanav]
logout.redirect = wiki/Logout

See TracNavigation for more details.

[milestone]

default_group_by	Default field to use for grouping tickets in the grouped progress bar. (since 1.2)	component
default_retarget_to	Default milestone to which tickets are retargeted when closing or deleting a milestone. (since 1.1.2)	(no default)
stats_provider	Name of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the milestone views.	DefaultTicketGroupStatsProvider

[milestone-groups]

As the workflow for tickets is now configurable, there can be many ticket states, and simply displaying closed tickets vs. all the others is maybe not appropriate in all cases. This section enables one to easily create groups of states that will be shown in different colors in the milestone progress bar.

Note that the groups can only be based on the ticket status, nothing else. In particular, it's not possible to distinguish between different closed tickets based on the resolution.

Example configuration with three groups, closed, new and active (the default only has closed and active):

# the 'closed' group correspond to the 'closed' tickets
closed = closed

# .order: sequence number in the progress bar
closed.order = 0

# .query_args: optional parameters for the corresponding
#              query. In this example, the changes from the
#              default are two additional columns ('created' and
#              'modified'), and sorting is done on 'created'.
closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime

# .overall_completion: indicates groups that count for overall
#                      completion percentage
closed.overall_completion = true

new = new
new.order = 1
new.css_class = new
new.label = new

# Note: one catch-all group for other statuses is allowed
active = *
active.order = 2

# .css_class: CSS class for this interval
active.css_class = open

# .label: displayed label for this group
active.label = in progress

The definition consists in a comma-separated list of accepted status. Also, '*' means any status and could be used to associate all remaining states to one catch-all group.

The CSS class can be one of: new (yellow), open (no color) or closed (green). Other styles can easily be added using custom CSS rule: table.progress td.<class> { background: <color> } to a site/style.css file for example.

[mimeviewer]

max_preview_size	Maximum file size for HTML preview.	262144
mime_map	List of additional MIME types and keyword mappings. Mappings are comma-separated, and for each MIME type, there's a colon (":") separated list of associated keywords or file extensions.	text/x-dylan:dylan,text/x-idl:ice,text/x-ada:ads:adb
mime_map_patterns	List of additional MIME types associated to filename patterns. Mappings are comma-separated, and each mapping consists of a MIME type and a Python regexp used for matching filenames, separated by a colon (":"). (since 1.0)	text/plain:README(?!\.rst)|INSTALL(?!\.rst)|COPYING.*
pygments_default_style	The default style to use for Pygments syntax highlighting.	trac
pygments_modes	List of additional MIME types known by Pygments. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding Pygments mode to be used for the conversion and quality is the quality ratio associated to this conversion. That can also be used to override the default quality ratio used by the Pygments render.	(no default)
tab_width	Displayed tab width in file preview.	8
treat_as_binary	Comma-separated list of MIME types that should be treated as binary data.	application/octet-stream,application/pdf,application/postscript,application/msword,application/rtf

[notification]

admit_domains	Comma-separated list of domains that should be considered as valid for email addresses (such as localdomain).	(no default)
ambiguous_char_width	Width of ambiguous characters that should be used in the table of the notification mail. If single, the same width as characters in US-ASCII. This is expected by most users. If double, twice the width of US-ASCII characters. This is expected by CJK users.	single
batch_subject_template	Like ticket_subject_template but for batch modifications. (since 1.0)	${prefix} Batch modify: ${tickets_descr}
default_format.email	Default format to distribute email notifications.	text/plain
email_address_resolvers	Comma separated list of email resolver components in the order they will be called. If an email address is resolved, the remaining resolvers will not be called.	SessionEmailResolver
email_sender	Name of the component implementing IEmailSender. This component is used by the notification system to send emails. Trac currently provides SmtpEmailSender for connecting to an SMTP server, and SendmailEmailSender for running a sendmail-compatible executable.	SmtpEmailSender
ignore_domains	Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).	(no default)
irc_relay_url		http://localhost:8787/message
message_id_hash	Hash algorithm to create unique Message-ID header. (since 1.0.13)	md5
mime_encoding	Specifies the MIME encoding scheme for emails. Supported values are: none, the default value which uses 7-bit encoding if the text is plain ASCII or 8-bit otherwise. base64, which works with any kind of content but may cause some issues with touchy anti-spam/anti-virus engine. qp or quoted-printable, which works best for european languages (more compact than base64) if 8-bit encoding cannot be used.	none
sendmail_path	Path to the sendmail executable. The sendmail program must accept the -i and -f options.	sendmail
smtp_always_bcc	Comma-separated list of email addresses to always send notifications to. Addresses are not public (Bcc:).	(no default)
smtp_always_cc	Comma-separated list of email addresses to always send notifications to. Addresses can be seen by all recipients (Cc:).	(no default)
smtp_default_domain	Default host/domain to append to addresses that do not specify one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found in the user settings.	(no default)
smtp_enabled	Enable email notification.	disabled
smtp_from	Sender address to use in notification emails. At least one of smtp_from and smtp_replyto must be set, otherwise Trac refuses to send notification mails.	trac@localhost
smtp_from_author	Use the author of the change as the sender in notification emails (e.g. reporter of a new ticket, author of a comment). If the author hasn't set an email address, smtp_from and smtp_from_name are used instead. (since 1.0)	disabled
smtp_from_name	Sender name to use in notification emails.	(no default)
smtp_password	Password for authenticating with SMTP server.	(no default)
smtp_port	SMTP server port to use for email notification.	25
smtp_replyto	Reply-To address to use in notification emails. At least one of smtp_from and smtp_replyto must be set, otherwise Trac refuses to send notification mails.	trac@localhost
smtp_server	SMTP server hostname to use for email notifications.	localhost
smtp_subject_prefix	Text to prepend to subject line of notification emails. If the setting is not defined, then [$project_name] is used as the prefix. If no prefix is desired, then specifying an empty option will disable it.	__default__
smtp_user	Username for authenticating with SMTP server.	(no default)
ticket_subject_template	A Jinja2 text template snippet used to get the notification subject. The template variables are documented on the TracNotification page.	${prefix} #${ticket.id}: ${summary}
use_public_cc	Addresses in the To and Cc fields are visible to all recipients. If this option is disabled, recipients are put in the Bcc list.	disabled
use_short_addr	Permit email address without a host/domain (i.e. username only). The SMTP server should accept those addresses, and either append a FQDN or use local delivery. See also smtp_default_domain. Do not use this option with a public SMTP server.	disabled
use_tls	Use SSL/TLS to send notifications over SMTP.	disabled

[notification-subscriber]

The notifications subscriptions are controlled by plugins. All INotificationSubscriber components are in charge. These components may allow to be configured via this section in the trac.ini file.

See TracNotification for more details.

Available subscribers:

Subscriber	Description
AlwaysEmailSubscriber
CarbonCopySubscriber	Ticket that I'm listed in the CC field is modified
NewTicketSubscriber	Any ticket is created
TicketOwnerSubscriber	Ticket that I own is created or modified
TicketPreviousUpdatersSubscriber	Ticket that I previously updated is modified
TicketReporterSubscriber	Ticket that I reported is modified
TicketUpdaterSubscriber	I update a ticket

[project]

admin	E-Mail address of the project's administrator.	(no default)
admin_trac_url	Base URL of a Trac instance where errors in this Trac should be reported. This can be an absolute or relative URL, or '.' to reference this Trac instance. An empty value will disable the reporting buttons.	.
descr	Short description of the project.	My example project
footer	Page footer text (right-aligned).	Visit the Trac open source project at<br /><a href="https://trac.edgewall.org/">https://trac.edgewall.org/</a>
icon	URL of the icon of the project.	common/trac.ico
name	Name of the project.	My Project
url	URL of the project web site. This is usually the domain in which the base_url resides. For example, the project URL might be https://myproject.com, with the Trac site (base_url) residing at either https://trac.myproject.com or https://myproject.com/trac. The project URL is added to the footer of notification e-mails.	(no default)

[pygments-lexer]

Configure Pygments ​lexer options.

For example, to set the ​PhpLexer options startinline and funcnamehighlighting:

[pygments-lexer]
php.startinline = True
php.funcnamehighlighting = True

The lexer name is derived from the class name, with Lexer stripped from the end. The lexer short names can also be used in place of the lexer name.

[query]

default_anonymous_query	The default query for anonymous users. The query is either in query language syntax, or a URL query string starting with ? as used in query: Trac links.	status!=closed&cc~=$USER
default_query	The default query for authenticated users. The query is either in query language syntax, or a URL query string starting with ? as used in query: Trac links.	status!=closed&owner=$USER
items_per_page	Number of tickets displayed per page in ticket queries, by default. Set to 0 to specify no limit.	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.	?status=!closed

[report]

items_per_page	Number of tickets displayed per page in ticket reports, by default. Set to 0 to specify no limit.	100
items_per_page_rss	Number of tickets displayed in the rss feeds for reports. Set to 0 to specify no limit.	0

[roadmap]

stats_provider

Name of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for display in the roadmap views.

DefaultTicketGroupStatsProvider

[search]

default_disabled_filters	Specifies which search filters should be disabled by default on the search page. This will also restrict the filters for the quick search function. The filter names defined by default components are: wiki, ticket, milestone and changeset. For plugins, look for their implementation of the ISearchSource interface, in the get_search_filters() method, the first member of returned tuple. Once disabled, search filters can still be manually enabled by the user on the search page.	(no default)
min_query_length	Minimum length of query string allowed when performing a search.	3

[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.	disabled
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 BadContent. Can be used in addition to BadContent wiki page.	(no default)
bayes_karma	By what factor Bayesian spam probability score affects the overall karma of a submission.	15
bayes_min_dbcount	Entries with a count less than this value get removed from the database when calling the reduce function.	5
bayes_min_training	The minimum number of submissions in the training database required for the filter to start impacting the karma of submissions.	25
botscout_api_key	API key required to use BotScout.	(no default)
botscout_karma	By how many points a BotScout reject impacts the overall karma of a submission.	3
captcha	CAPTCHA method to use for verifying humans.	ExpressionCaptcha
captcha_captchasnet_alphabet	Alphabet for Captchas.Net usage.	abcdefghijklmnopqrstuvwxyz
captcha_captchasnet_audiourl	Length of Captchas.Net captcha.	https://audio.captchas.net/
captcha_captchasnet_imgurl	Length of Captchas.Net captcha.	https://image.captchas.net/
captcha_captchasnet_length	Length of Captchas.Net captcha.	6
captcha_captchasnet_secret	Secret for Captchas.Net usage.	(no default)
captcha_captchasnet_username	Username for Captchas.Net usage.	(no default)
captcha_expression_ceiling	Maximum value of individual terms in numeric CAPTCHA expression.	10
captcha_expression_terms	Number of terms in numeric CAPTCHA expression.	3
captcha_expression_trash	Elements which are inserted and should be ignored.	ignore me,skip,whoa,never mind,something else
captcha_failed_karma	By how many points a failed CAPTCHA impacts the overall score.	1
captcha_hcaptcha_private_key	Sitekey for hCaptcha usage.	(no default)
captcha_hcaptcha_public_key	Secret for hCaptcha usage.	(no default)
captcha_image_alphabet	Alphabet to choose image CAPTCHA challenge from.	abcdefghkmnopqrstuvwxyz
captcha_image_font_size	Font size to use in image CAPTCHA.	25
captcha_image_fonts	Set of fonts to choose from when generating image CAPTCHA.	vera.ttf
captcha_image_letters	Number of letters to use in image CAPTCHA challenge.	6
captcha_karma	By how many points a successful CAPTCHA response increases the overall score.	20
captcha_karma_lifetime	Time in seconds that a successful CAPTCHA response increases karma.	86400
captcha_keycaptcha_private_key	Private key for KeyCaptcha usage.	(no default)
captcha_keycaptcha_user_id	User id for KeyCaptcha usage.	(no default)
captcha_lifetime	Time in seconds before database cleanup is called.	3600
captcha_recaptcha_private_key	Private key for reCaptcha usage.	(no default)
captcha_recaptcha_public_key	Public key for reCaptcha usage.	(no default)
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
httpbl_api_key	Http:BL API key required for use.	(no default)
httpbl_spammer_karma	By how many points listing as "comment spammer" impacts the overall karma of a submission.	6
ip6_blacklist_servers	Servers used for IPv6 blacklisting.	all.s5h.net,dnsbl.dronebl.org,bl.ipv6.spameatingmonkey.net
ip_blacklist_karma	By how many points blacklisting by a single server impacts the overall karma of a submission.	5
ip_blacklist_servers	Servers used for IPv4 blacklisting.	all.s5h.net,dnsbl.dronebl.org,rbl.blockedservers.com
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.	disabled
logging_enabled	Whether all content submissions and spam filtering activity should be logged to the database.	enabled
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
nolog_obvious	Don't log obvious spam (Bayes >90%%, marked as spam and not authenticated) to the database.	disabled
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 BadContent 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.	enabled
show_blacklisted_ip	Show the matched bad IP patterns in rejection message.	enabled
show_train_only	Show the buttons for training without deleting entry.	disabled
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 StopForumSpam reject impacts the overall karma of a submission.	4
train_external	Allow training of external services.	enabled
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.	disabled
url_blacklist_karma	By how many points blacklisting by a single bad URL impacts the overall karma of a submission.	3
url_blacklist_servers	Servers used for URL blacklisting.	urired.spameatingmonkey.net,multi.surbl.org,dbl.spamhaus.org
use_external	Allow usage of external services.	enabled

[sqlite]

extensions

Paths to ​sqlite extensions. The paths may be absolute or relative to the Trac environment.

(no default)

[tags]

cloud_caseless_sort	Whether the tag cloud should be sorted case-sensitive.	disabled
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.	enabled
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. bulleted-list of "linked-id description (tags)" oldlist (default value) The original format with a 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.	enabled
listtagged_default_format	Set default format for the handler of the /tags domain. See ListTagged description (WikiMacros) for supported values.	oldlist
listtagged_default_table_cols	Select columns and column order for table format. See ListTagged description (WikiMacros) 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:<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.	enabled
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.	disabled
wiki_page_link	Link a tag to the wiki page with same name, if it exists.	enabled
wiki_page_prefix	Prefix for tag wiki page names.	(no default)

[ticket]

allowed_empty_fields	Comma-separated list of select fields that can have an empty value. (since 1.1.2)	milestone,version
default_cc	Default cc: list for newly created tickets.	(no default)
default_component	Default component for newly created tickets.	(no default)
default_description	Default description for newly created tickets.	(no default)
default_keywords	Default keywords for newly created tickets.	(no default)
default_milestone	Default milestone for newly created tickets.	(no default)
default_owner	Default owner for newly created tickets. The component owner is used when set to the value < default >.	< default >
default_priority	Default priority for newly created tickets.	major
default_resolution	Default resolution for resolving (closing) tickets.	fixed
default_severity	Default severity for newly created tickets.	(no default)
default_summary	Default summary (title) for newly created tickets.	(no default)
default_type	Default type for newly created tickets.	defect
default_version	Default version for newly created tickets.	(no default)
max_comment_size	Maximum allowed comment size in characters.	262144
max_description_size	Maximum allowed description size in characters.	262144
max_summary_size	Maximum allowed summary size in characters. (since 1.0.2)	262144
preserve_newlines	Whether Wiki formatter should respect the new lines present in the Wiki text. If set to 'default', this is equivalent to 'yes' for new environments but keeps the old behavior for upgraded environments (i.e. 'no').	default
restrict_owner	Make the owner field of tickets use a drop-down menu. Be sure to understand the performance implications before activating this option. See Assign-to as Drop-Down List. Please note that e-mail addresses are not obfuscated in the resulting drop-down menu, so this option should not be used if e-mail addresses must remain protected.	disabled
workflow	Ordered list of workflow controllers to use for ticket actions.	ConfigurableTicketWorkflow

[ticket-custom]

In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.

[ticket-workflow]

The workflow for tickets is controlled by plugins. By default, there's only a ConfigurableTicketWorkflow component in charge. That component allows the workflow to be configured via this section in the trac.ini file. See TracWorkflow for more details.

[timeline]

abbreviated_messages	Whether wiki-formatted event messages should be truncated or not. This only affects the default rendering, and can be overridden by specific event providers, see their own documentation.	enabled
default_daysback	Default number of days displayed in the Timeline, in days.	30
max_daysback	Maximum number of days (-1 for unlimited) displayable in the Timeline.	90
newticket_formatter	Which formatter flavor (e.g. 'html' or 'oneliner') should be used when presenting the description for new tickets. If 'oneliner', the [timeline] abbreviated_messages option applies.	oneliner
ticket_show_component	Enable the display of component of tickets in the timeline. (since 1.1.1)	disabled
ticket_show_details	Enable the display of all ticket changes in the timeline, not only open / close operations.	enabled

[trac]

anonymous_session_lifetime	Lifetime of the anonymous session, in days. Set the option to 0 to disable purging old anonymous sessions. (since 1.0.17)	90
auth_cookie_lifetime	Lifetime of the authentication cookie, in seconds. This value determines how long the browser will cache authentication information, and therefore, after how much inactivity a user will have to log in again. The default value of 0 makes the cookie expire at the end of the browsing session. (since 0.12)	0
auth_cookie_path	Path for the authentication cookie. Set this to the common base path of several Trac instances if you want them to share the cookie. (since 0.12)	(no default)
auto_preview_timeout	Inactivity timeout in seconds after which the automatic wiki preview triggers an update. This option can contain floating-point values. The lower the setting, the more requests will be made to the server. Set this to 0 to disable automatic preview.	2.0
auto_reload	Automatically reload template files after modification.	disabled
backup_dir	Database backup location	db
base_url	Base URL of the Trac site. This is used to produce documents outside of the web browsing context, such as URLs in notification e-mails that point to Trac resources.	(no default)
check_auth_ip	Whether the IP address of the user should be checked for authentication (since 0.9).	disabled
database	Database connection string for this project	sqlite:db/trac.db
debug_sql	Show the SQL queries in the Trac log, at DEBUG level.	disabled
default_charset	Charset to be used when in doubt.	utf-8
default_date_format	The date format. Valid options are 'iso8601' for selecting ISO 8601 format, or leave it empty which means the default date format will be inferred from the browser's default language. (since 1.0)	(no default)
default_dateinfo_format	The date information format. Valid options are 'relative' for displaying relative format and 'absolute' for displaying absolute format. (since 1.0)	relative
default_handler	Name of the component that handles requests to the base URL. Options include TimelineModule, RoadmapModule, BrowserModule, QueryModule, ReportModule, TicketModule and WikiModule. The session preference for default handler take precedence, when set.	WikiModule
default_language	The preferred language to use if no user preference has been set.	(no default)
default_timezone	The default timezone to use	(no default)
htdocs_location	Base URL for serving the core static resources below /chrome/common/. It can be left empty, and Trac will simply serve those resources itself. Advanced users can use this together with trac-admin ... deploy <deploydir> to allow serving the static resources for Trac directly from the web server. Note however that this only applies to the <deploydir>/htdocs/common directory, the other deployed resources (i.e. those from plugins) will not be made available this way and additional rewrite rules will be needed in the web server.	(no default)
ignore_auth_case	Whether login names should be converted to lower case (since 0.9).	disabled
jquery_location	Location of the jQuery JavaScript library (version 3.6.3). An empty value loads jQuery from the copy bundled with Trac. Alternatively, jQuery could be loaded from a CDN, for example: ​http://code.jquery.com/jquery-3.6.3.min.js, ​http://ajax.aspnetcdn.com/ajax/jQuery/jquery-3.6.3.min.js or ​https://ajax.googleapis.com/ajax/libs/jquery/3.6.3/jquery.min.js. (since 1.0)	(no default)
jquery_ui_location	Location of the jQuery UI JavaScript library (version 1.13.0). An empty value loads jQuery UI from the copy bundled with Trac. Alternatively, jQuery UI could be loaded from a CDN, for example: ​https://ajax.googleapis.com/ajax/libs/jqueryui/1.13.0/jquery-ui.min.js or ​http://ajax.aspnetcdn.com/ajax/jquery.ui/1.13.0/jquery-ui.min.js. (since 1.0)	(no default)
jquery_ui_theme_location	Location of the theme to be used with the jQuery UI JavaScript library (version 1.13.0). An empty value loads the custom Trac jQuery UI theme from the copy bundled with Trac. Alternatively, a jQuery UI theme could be loaded from a CDN, for example: ​https://ajax.googleapis.com/ajax/libs/jqueryui/1.13.0/themes/start/jquery-ui.css or ​http://ajax.aspnetcdn.com/ajax/jquery.ui/1.13.0/themes/start/jquery-ui.css. (since 1.0)	(no default)
mysqldump_path	Location of mysqldump for MySQL database backups	mysqldump
never_obfuscate_mailto	Never obfuscate mailto: links explicitly written in the wiki, even if show_email_addresses is false or the user doesn't have EMAIL_VIEW permission.	disabled
permission_policies	List of components implementing IPermissionPolicy, in the order in which they will be applied. These components manage fine-grained access control to Trac resources.	DefaultWikiPolicy,DefaultTicketPolicy,DefaultPermissionPolicy,LegacyAttachmentPolicy
permission_store	Name of the component implementing IPermissionStore, which is used for managing user and group permissions.	DefaultPermissionStore
pg_dump_path	Location of pg_dump for Postgres database backups	pg_dump
request_filters	Ordered list of filters to apply to all requests.	(no default)
resizable_textareas	Make <textarea> fields resizable. Requires JavaScript.	enabled
secure_cookies	Restrict cookies to HTTPS connections. When true, set the secure flag on all cookies so that they are only sent to the server on HTTPS connections. Use this if your Trac instance is only accessible through HTTPS.	disabled
show_email_addresses	Show email addresses instead of usernames. If false, email addresses are obfuscated for users that don't have EMAIL_VIEW permission.	disabled
show_full_names	Show full names instead of usernames. (since 1.2)	enabled
timeout	Timeout value for database connection, in seconds. Use '0' to specify no timeout.	20
use_base_url_for_redirect	Optionally use [trac] base_url for redirects. In some configurations, usually involving running Trac behind a HTTP proxy, Trac can't automatically reconstruct the URL that is used to access it. You may need to use this option to force Trac to use the base_url setting also for redirects. This introduces the obvious limitation that this environment will only be usable when accessible from that URL, as redirects are frequently used.	disabled
use_chunked_encoding	If enabled, send contents as chunked encoding in HTTP/1.1. Otherwise, send contents with Content-Length header after entire of the contents are rendered. (since 1.0.6)	enabled
use_xsendfile	When true, send a X-Sendfile header and no content when sending files from the filesystem, so that the web server handles the content. This requires a web server that knows how to handle such a header, like Apache with mod_xsendfile or lighttpd. (since 1.0)	disabled
wiki_toolbars	Add a simple toolbar on top of Wiki <textarea>s. (since 1.0.2)	enabled
xsendfile_header	The header to use if use_xsendfile is enabled. If Nginx is used, set X-Accel-Redirect. (since 1.0.6)	X-Sendfile

[vote]

paths

List of URL paths to allow voting on. Globs are supported.

/ticket*,/wiki*

[wiki]

default_edit_area_height	Default height of the textarea on the wiki edit page. (Since 1.1.5)	20
ignore_missing_pages	Enable/disable highlighting CamelCase links to missing pages.	disabled
max_size	Maximum allowed wiki page size in characters.	262144
render_unsafe_content	Enable/disable the use of unsafe HTML tags such as <script> or <embed> with the HTML WikiProcessor. For public sites where anonymous users can edit the wiki it is recommended to leave this option disabled.	disabled
safe_origins	List of URIs considered "safe cross-origin", that will be rendered as img element without crossorigin="anonymous" attribute or used in url() of inline style attribute even if [wiki] render_unsafe_content is false (since 1.0.15). To make any origins safe, specify "*" in the list.	data:
safe_schemes	List of URI schemes considered "safe", that will be rendered as external links even if [wiki] render_unsafe_content is false.	cvs,file,ftp,git,irc,http,https,news,sftp,smb,ssh,svn,svn+ssh
split_page_names	Enable/disable splitting the WikiPageNames with space characters.	disabled

Configure Error Reporting

The error reporting page has a Create button for reporting issues. The site to which issues are reported depends on the configuration of the Trac site and the user’s permissions.

If the user doesn’t possess TRAC_ADMIN, the site to which a user is directed to create a ticket is determined by the [trac] admin_trac_url setting:

• If empty, there will be no Create button.
• If set to the default value (.), the ticket will be created on the site which the error occurred.
• Otherwise the ticket will be created at the site pointed to by admin_trac_url.

If [project] admin is not empty, the administrator's email address will be rendered on the error page.

If the user possesses TRAC_ADMIN, the Create button will direct the user to report the issue on trac.edgewall.org. If the error was generated in a plugin, the error will be reported to the project URL provided that the plugin author has included the project URL in the plugin installation data. The user possessing TRAC_ADMIN also sees a traceback and system information on the error page.

---

See also: TracAdmin, TracEnvironment