The Trac Configuration File

Trac configuration is done by editing the trac.ini config file, located in <projectenv>/conf/trac.ini. Changes to the configuration are usually reflected immediately, though changes to the [components] or [logging] sections will require restarting the web server. You may also need to restart the web server after creating a global configuration file when none was previously present.

The trac.ini configuration file and its parent directory should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.

Global Configuration

In versions prior to 0.11, the global configuration was by default located in $prefix/share/trac/conf/trac.ini or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from. Literally, when you're upgrading to 0.11, you have to add an [inherit] section to your project's trac.ini file. Additionally, you have to move your customized templates and common images from $prefix/share/trac/... to the new location.

Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:

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

Multiple files can be specified using a comma-separated list.

Note that you can also specify a global option file when creating a new project, by adding the option --inherit=/path/to/global/trac.ini to trac-admin's initenv command. If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated conf/trac.ini file and delete the entries that will otherwise override those set in the global file.

There are two more entries in the [inherit] section, templates_dir for sharing global templates and plugins_dir, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another [inherit] file there.

Note that the templates found in the templates/ directory of the TracEnvironment have precedence over those found in [inherit] templates_dir. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate ITemplateStreamFilter transformation).

Reference for settings

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

[account-manager]

account_changes_notify_addresses	List of email addresses that get notified of user changes, ie, new user, password change and delete user.	(no default)
allow_delete_account	Allow users to delete their own account.	true
auth_init	Launch an initial Trac authentication setup.	true
authentication_url	URL of the HTTP authentication service	(no default)
cookie_refresh_pct	Persistent sessions randomly get a new session cookie ID with likelihood in percent per work hour given here (zero equals to never) to decrease vulnerability of long-lasting sessions.	10
db_htdigest_realm	Realm to select relevant htdigest db entries	(no default)
db_htpasswd_hash_type	Default hash type of new/updated passwords	crypt
email_regexp	A validation regular expression describing new account emails.	(?i)^[A-Z0-9._%+-]+@(?:[A-Z0-9-]+\.)+[A-Z]{2,6}$
environ_auth_overwrite	Whether environment variable REMOTE_USER should get overwritten after processing login form input. Otherwise it will only be set, if unset at the time of authentication.	true
force_passwd_change	Force the user to change password when it's reset.	true
generated_password_length	Length of the randomly-generated passwords created when resetting the password for an account.	8
hash_method	IPasswordHashMethod used to create new/updated passwords	HtDigestHashMethod
htdigest_file	Path relative to Trac environment or full host machine path to password file	(no default)
htdigest_realm	Realm to select relevant htdigest file entries	(no default)
htpasswd_file	Path relative to Trac environment or full host machine path to password file	(no default)
htpasswd_hash_type	Default hash type of new/updated passwords	crypt
login_opt_list	Set to True, to switch login page style showing alternative actions in a single listing together.	false
notify_actions	Comma separated list of actions to notify of. Available actions 'new', 'change', 'delete'.	(no default)
password_file	Path to the users file; leave blank to locate the users file by reading svnserve.conf	(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_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
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.	(?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

[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 the 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) (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

[components]

T h i s s e c t i o n i s u s e d t o e n a b l e o r d i s a b l e c o m p o n e n t s p r o v i d e d b y p l u g i n s , a s w e l l a s b y T r a c i t s e l f . T h e c o m p o n e n t t o e n a b l e / d i s a b l e i s s p e c i f i e d v i a t h e n a m e o f t h e o p t i o n . W h e t h e r i t s e n a b l e d i s d e t e r m i n e d b y t h e o p t i o n v a l u e ; s e t t i n g t h e v a l u e t o ` e n a b l e d ` o r ` o n ` w i l l e n a b l e t h e c o m p o n e n t , a n y o t h e r v a l u e ( t y p i c a l l y ` d i s a b l e d ` o r ` o f f ` ) w i l l d i s a b l e t h e c o m p o n e n t . T h e o p t i o n n a m e i s e i t h e r t h e f u l l y q u a l i f i e d n a m e o f t h e c o m p o n e n t s o r t h e m o d u l e / p a c k a g e p r e f i x o f t h e c o m p o n e n t . T h e f o r m e r e n a b l e s / d i s a b l e s a s p e c i f i c c o m p o n e n t , w h i l e t h e l a t t e r e n a b l e s / d i s a b l e s a n y c o m p o n e n t i n t h e s p e c i f i e d p a c k a g e / m o d u l e . C o n s i d e r t h e f o l l o w i n g c o n f i g u r a t i o n s n i p p e t : { { { [ c o m p o n e n t s ] t r a c . t i c k e t . r e p o r t . R e p o r t M o d u l e = d i s a b l e d w e b a d m i n . * = e n a b l e d } } } T h e f i r s t o p t i o n t e l l s T r a c t o d i s a b l e t h e [ w i k i : T r a c R e p o r t s r e p o r t m o d u l e ] . T h e s e c o n d o p t i o n i n s t r u c t s T r a c t o e n a b l e a l l c o m p o n e n t s i n t h e ` w e b a d m i n ` p a c k a g e . N o t e t h a t t h e t r a i l i n g w i l d c a r d i s r e q u i r e d f o r m o d u l e / p a c k a g e m a t c h i n g . T o v i e w t h e l i s t o f a c t i v e c o m p o n e n t s , g o t o t h e ' ' P l u g i n s ' ' p a g e o n ' ' A b o u t T r a c ' ' ( r e q u i r e s ` C O N F I G _ V I E W ` [ w i k i : T r a c P e r m i s s i o n s p e r m i s s i o n s ] ) . S e e a l s o : T r a c P l u g i n s

[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

[hg]

encoding	Encoding that should be used to decode filenames, file content, and changeset metadata. If multiple encodings are used for these different situations (or even multiple encodings were used for filenames), simply specify a list of encodings which will be tried in turn (since 0.12.0.24).	utf-8
hgrc	Optional path to an hgrc file which will be used to specify extra Mercurial configuration options (see ​http://www.selenic.com/mercurial/hgrc.5.html).	(no default)
node_format	Specify how the commit SHA1 hashes should be displayed. Possible choices are: 'short', the SHA1 hash is abbreviated to its first 12 digits, or 'hex', the hash is shown in full.	short
show_rev	Show decimal revision in front of the commit SHA1 hash. While this number is specific to the particular clone used to browse the repository, this can sometimes give an useful hint about the relative "age" of a revision.	true

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

T h i s s e c t i o n c o n f i g u r e s I n t e r T r a c p r e f i x e s . O p t i o n s i n t h i s s e c t i o n w h o s e n a m e c o n t a i n a " . " d e f i n e a s p e c t s o f t h e I n t e r T r a c p r e f i x c o r r e s p o n d i n g t o t h e o p t i o n n a m e u p t o t h e " . " . O p t i o n s w h o s e n a m e d o n ' t c o n t a i n a " . " d e f i n e a n a l i a s . T h e ` . u r l ` i s m a n d a t o r y a n d i s u s e d f o r l o c a t i n g t h e o t h e r T r a c . T h i s c a n b e a r e l a t i v e U R L i n c a s e t h a t T r a c e n v i r o n m e n t i s l o c a t e d o n t h e s a m e s e r v e r . T h e ` . t i t l e ` i n f o r m a t i o n i s u s e d f o r p r o v i d i n g a u s e f u l t o o l t i p w h e n m o v i n g t h e c u r s o r o v e r a n I n t e r T r a c l i n k . T h e ` . c o m p a t ` o p t i o n c a n b e u s e d t o a c t i v a t e o r d i s a b l e a ' ' c o m p a t i b i l i t y ' ' m o d e : * I f t h e t a r g e t e d T r a c i s r u n n i n g a v e r s i o n b e l o w [ t r a c : m i l e s t o n e : 0 . 1 0 0 . 1 0 ] ( [ t r a c : r 3 5 2 6 r 3 5 2 6 ] t o b e p r e c i s e ) , t h e n i t d o e s n ' t k n o w h o w t o d i s p a t c h a n I n t e r T r a c l i n k , a n d i t ' s u p t o t h e l o c a l T r a c t o p r e p a r e t h e c o r r e c t l i n k . N o t a l l l i n k s w i l l w o r k t h a t w a y , b u t t h e m o s t c o m m o n d o . T h i s i s c a l l e d t h e c o m p a t i b i l i t y m o d e , a n d i s ` t r u e ` b y d e f a u l t . * I f y o u k n o w t h a t t h e r e m o t e T r a c k n o w s h o w t o d i s p a t c h I n t e r T r a c l i n k s , y o u c a n e x p l i c i t l y d i s a b l e t h i s c o m p a t i b i l i t y m o d e a n d t h e n ' ' a n y ' ' T r a c L i n k s c a n b e c o m e I n t e r T r a c l i n k s . E x a m p l e c o n f i g u r a t i o n : { { { [ i n t e r t r a c ] # - - E x a m p l e o f s e t t i n g u p a n a l i a s : t = t r a c # - - L i n k t o a n e x t e r n a l T r a c : t r a c . t i t l e = E d g e w a l l ' s T r a c f o r T r a c t r a c . u r l = h t t p : / / t r a c . e d g e w a l l . o r g } } }

[interwiki]

E v e r y o p t i o n i n t h e ` [ i n t e r w i k i ] ` s e c t i o n d e f i n e s o n e I n t e r W i k i p r e f i x . T h e o p t i o n n a m e d e f i n e s t h e p r e f i x . T h e o p t i o n v a l u e d e f i n e s t h e U R L , o p t i o n a l l y f o l l o w e d b y a d e s c r i p t i o n s e p a r a t e d f r o m t h e U R L b y w h i t e s p a c e . P a r a m e t r i c U R L s a r e s u p p o r t e d a s w e l l . ' ' ' E x a m p l e : ' ' ' { { { [ i n t e r w i k i ] M e a t B a l l = h t t p : / / w w w . u s e m o d . c o m / c g i - b i n / m b . p l ? P E P = h t t p : / / w w w . p y t h o n . o r g / p e p s / p e p - $ 1 . h t m l P y t h o n E n h a n c e m e n t P r o p o s a l $ 1 t s v n = t s v n : I n t e r a c t w i t h T o r t o i s e S v n } } }

[logging]

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

[mimeviewer]

max_preview_size	Maximum file size for HTML preview. (since 0.9)	262144
mime_map	List of additional MIME types and keyword mappings. Mappings are comma-separated, and for each MIME type, there's a colon (":") separated list of associated keywords or file extensions. (since 0.10)	text/x-dylan:dylan, text/x-idl:ice, text/x-ada:ads:adb
mime_map_patterns	List of additional MIME types associated to filename patterns. Mappings are comma-separated, and each mapping consists of a MIME type and a Python regexp used for matching filenames, separated by a colon (":"). (since 1.0)	text/plain:README|INSTALL|COPYING.*
tab_width	Displayed tab width in file preview. (since 0.9)	8
treat_as_binary	Comma-separated list of MIME types that should be treated as binary data. (since 0.11.5)	application/octet-stream, application/pdf, application/postscript, application/msword,application/rtf,

[notification]

admit_domains	Comma-separated list of domains that should be considered as valid for email addresses (such as localdomain).	(no default)
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)
use_public_cc	Recipients can see email addresses of other CC'ed recipients. If this option is disabled (the default), recipients are put on BCC. (since 0.10)	false
use_short_addr	Permit email address without a host/domain (i.e. username only). The SMTP server should accept those addresses, and either append a FQDN or use local delivery. (since 0.10)	false
use_tls	Use SSL/TLS to send notifications over SMTP. (since 0.10)	false

[project]

admin	E-Mail address of the project's administrator.	(no default)
admin_trac_url	Base URL of a Trac instance where errors in this Trac should be reported. This can be an absolute or relative URL, or '.' to reference this Trac instance. An empty value will disable the reporting buttons. (since 0.11.3)	.
descr	Short description of the project.	My example project
footer	Page footer text (right-aligned).	Visit the Trac open source project at<br /><a href="http://trac.edgewall.org/">http://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 main project web site, usually the website in which the base_url resides. This is used in notification e-mails.	(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

[spam-filter]

account_karma	By how many points a failed registration check impacts the overall score.	5
account_replace_checks	Replace checks in account manager totally.	false
attachment_karma	The karma given to attachments.	0
authenticated_karma	The karma given to authenticated users, in case trust_authenticated is false.	10
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_karma	By how many points a successful CAPTCHA response increases the overall score.	10
captcha_karma_lifetime	Time in seconds that a successful CAPTCHA response increases karma.	86400
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)
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_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 IP blacklisting.	list.blogspambl.com, all.s5h.net, dnsbl.tornevall.org
ip_throttle_karma	By how many points exceeding the configured maximum number of posts per hour impacts the overall score.	3
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_posts_by_ip	The maximum allowed number of submissions per hour form a single IP address. If this limit is exceeded, subsequent permissions 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
reject_handler	The handler used to reject content.	FilterSystem
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.	9
spam_monitor_entries	How many monitor entries are displayed by default (between 5 and 1000).	15
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.	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
trust_authenticated	Whether content submissions by authenticated users should be trusted without checking for potential spam or other abuse.	true
use_external	Allow usage of external services.	true

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

[timeline]

abbreviated_messages	Whether wiki-formatted event messages should be truncated or not. This only affects the default rendering, and can be overriden by specific event providers, see their own documentation. (Since 0.11)	true
default_daysback	Default number of days displayed in the Timeline, in days. (since 0.9.)	30
max_daysback	Maximum number of days (-1 for unlimited) displayable in the Timeline. (since 0.11)	90

[trac]

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. The default is 2.0 seconds. (since 0.12)	2.0
auto_reload	Automatically reload template files after modification.	false
backup_dir	Database backup location	db
base_url	Reference URL for the Trac deployment. This is the base URL that will be used when producing documents that will be used outside of the web browsing context, like for example when inserting URLs pointing to Trac resources in notification e-mails.	(no default)
check_auth_ip	Whether the IP address of the user should be checked for authentication (since 0.9).	false
database	Database connection string for this project	sqlite:db/trac.db
debug_sql	Show the SQL queries in the Trac log, at DEBUG level. (Since 0.11.5)	false
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 default is WikiModule. (since 0.9)	WikiModule
default_language	The preferred language to use if no user preference has been set. (since 0.12.1)	(no default)
default_timezone	The default timezone to use	(no default)
genshi_cache_size	The maximum number of templates that the template loader will cache in memory. The default value is 128. You may want to choose a higher value if your site uses a larger number of templates, and you have enough memory to spare, or you can reduce it if you are short on memory.	128
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).	false
jquery_location	Location of the jQuery JavaScript library (version 1.7.2). 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-1.7.2.min.js, ​http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.2.min.js or ​https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js. (since 1.0)	(no default)
jquery_ui_location	Location of the jQuery UI JavaScript library (version 1.8.21). 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.8.21/jquery-ui.min.js or ​http://ajax.aspnetcdn.com/ajax/jquery.ui/1.8.21/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.8.21). 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.8.21/themes/start/jquery-ui.css or ​http://ajax.aspnetcdn.com/ajax/jquery.ui/1.8.21/themes/start/jquery-ui.css. (since 1.0)	(no default)
mainnav	Order of the items to display in the mainnav navigation bar, listed by IDs. See also TracNavigation.	wiki, timeline, roadmap, browser, tickets, newticket, search
metanav	Order of the items to display in the metanav navigation bar, listed by IDs. See also TracNavigation.	login, logout, prefs, help, about
never_obfuscate_mailto	Never obfuscate mailto: links explicitly written in the wiki, even if show_email_addresses is false or the user has not the EMAIL_VIEW permission (since 0.11.6).	false
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. Defaults to the DefaultPermissionPolicy? (pre-0.11 behavior) and LegacyAttachmentPolicy? (map ATTACHMENT_* permissions to realm specific ones)	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 (since 0.10).	(no default)
resizable_textareas	Make <textarea> fields resizable. Requires JavaScript. (since 0.12)	true
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. (since 0.11.2)	false
show_email_addresses	Show email addresses instead of usernames. If false, we obfuscate email addresses. (since 0.11)	false
show_ip_addresses	Show IP addresses for resource edits (e.g. wiki). (since 0.11.3)	false
timeout	Timeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11)	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. (since 0.10.5)	false
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)	false

[wiki]

ignore_missing_pages	Enable/disable highlighting CamelCase links to missing pages (since 0.9).	false
max_size	Maximum allowed wiki page size in bytes. (since 0.11.2)	262144
render_unsafe_content	Enable/disable the use of unsafe HTML tags such as <script> or <embed> with the HTML WikiProcessor (since 0.10.4). For public sites where anonymous users can edit the wiki it is recommended to leave this option disabled (which is the default).	false
safe_schemes	List of URI schemes considered "safe", that will be rendered as external links even if [wiki] render_unsafe_content is false. (since 0.11.8)	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 (since 0.10).	false

Reference for special sections

1. [components]
2. [extra-permissions]
3. [milestone-groups]
4. [repositories]
5. [svn:externals]
6. [ticket-custom]
7. [ticket-workflow]

[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
webadmin.* = enabled

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

See the Plugins page on About Trac to get the list of active components (requires CONFIG_VIEW permissions.)

See also: TracPlugins

[extra-permissions]

(since 0.12)

Custom additional permissions can be defined in this section when ExtraPermissionsProvider? is enabled.

[milestone-groups]

(since 0.11)

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.

Example configuration (the default only has closed and active):

closed = closed
# sequence number in the progress bar
closed.order = 0
# optional extra param for the query (two additional columns: created and modified and sort 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
# indicates groups that count for overall completion percentage
closed.overall_completion = true

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

# one catch-all group is allowed
active = *
active.order = 2
# CSS class for this interval
active.css_class = open
# 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). New styles can easily be added using the following selector: table.progress td.<class>

[repositories]

(since 0.12 multirepos)

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.

[svn:externals]

(since 0.11)

The TracBrowser for Subversion can interpret the svn:externals property of folders. By default, it only turns the URLs into links as Trac can't browse remote repositories.

However, if you have another Trac instance (or an other repository browser like ​ViewVC) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.

This mapping is done in the [svn:externals] section of the TracIni

Example:

[svn:externals]
1 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
2 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
4 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev

With the above, the svn://anotherserver.com/tools_repository/tags/1.1/tools external will be mapped to http://ourserver/tracs/tools/browser/tags/1.1/tools?rev= (and rev will be set to the appropriate revision number if the external additionally specifies a revision, see the ​SVN Book on externals for more details).

Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser.

Finally, the relative URLs introduced in ​Subversion 1.5 are not yet supported.

[ticket-custom]

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

[ticket-workflow]

(since 0.11)

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.

---

See also: TracGuide, TracAdmin, TracEnvironment