wiki:TracNotification

Version 5 (modified by trac, 9 months ago) (diff)

--

Email Notification of Ticket Changes

Trac supports notification of ticket changes via email.

Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.

Disabled by default, notification can be activated and configured in trac.ini.

Receiving Notification Mails

When reporting a new ticket or adding a comment, enter a valid email address or your Trac username in the reporter, assigned to/owner or cc field. Trac will automatically send you an email when changes are made to the ticket, depending on how notification is configured.

How to use your username to receive notification mails

To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your preferences.

Alternatively, a default domain name (smtp_default_domain) can be set in the TracIni file, see Configuration Options below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation.

When using apache and mod_kerb for authentication against Kerberos / Active Directory, usernames take the form (username@EXAMPLE.LOCAL). To avoid this being interpreted as an email address, add the Kerberos domain to (ignore_domains).

Ticket attachment notifications

Since 1.0.3 Trac will send notifications when a ticket attachment is added or deleted. Usually attachment notifications will be enabled in an environment by default. To disable the attachment notifications for an environment the TicketAttachmentNotifier component must be disabled:

[components]
trac.ticket.notification.TicketAttachmentNotifier = disabled

Configuring SMTP Notification

Important: The [trac] base_url option must be configured for links in the notification message to be correctly generated.

Configuration Options

These are the available options for the [notification] section in trac.ini:

[account-manager]

account_changes_notify_addressesList of email addresses that get notified of user changes, ie, new user, password change and delete user.(no default)
allow_delete_accountAllow users to delete their own account.enabled
authentication_urlURL of the HTTP authentication service(no default)
cookie_refresh_pctPersistent 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_realmRealm to select relevant htdigest db entries(no default)
environ_auth_overwriteWhether 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_changeForce the user to change password when it's reset.enabled
generated_password_lengthLength of the randomly-generated passwords created when resetting the password for an account.8
hash_methodIPasswordHashMethod used to create new/updated passwordsHtDigestHashMethod
htdigest_filePath relative to Trac environment or full host machine path to password file(no default)
htdigest_realmRealm to select relevant htdigest file entries(no default)
login_attempt_max_countLock user account after specified number of login attempts. Value zero means no limit.0
login_opt_listSet to True, to switch login page style showing alternative actions in a single listing together.disabled
notify_actionsComma separated list of actions to notify of. Available actions 'new', 'change', 'delete'.
password_formatLegacy option, deprecated since acct_mgr-0.1.2(no default)
password_storeOrdered list of password stores, queried in turn.(no default)
persistent_sessionsAllow 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_passwdRe-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_tokenA string required as input to pass verification.(no default)
register_checkOrdered list of IAccountRegistrationInspector's to use for registration checks.BasicCheck, EmailCheck, BotTrapCheck, RegExpCheck, UsernamePermCheck
reset_passwordSet to False, if there is no email system setup.enabled
user_lock_max_timeLimit user account lock time to specified time (seconds). This is relevant only with user_lock_time_progression > 1.86400
user_lock_timeDrop user account lock after specified time (seconds). Value zero means unlimited lock time.0
user_lock_time_progressionExtend user account lock time incrementally. This is based on logarithmic calculation and decimal numbers accepted: Value '1' means constant lock time per failed login attempt. Value '2' means double locktime after 2nd lock activation, four times the initial locktime after 3rd, and so on.1
username_char_blacklistAlways exclude some special characters from usernames. This is enforced upon new user registration.:[]
verify_emailVerify the email address of Trac users.enabled

[attachment]

max_sizeMaximum allowed file size (in bytes) for attachments.262144
max_zip_sizeMaximum 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_contentWhether 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

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

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

See also: TracPlugins

[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]
EXTRA_ADMIN = EXTRA_VIEW, EXTRA_MODIFY, EXTRA_DELETE

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.

The permissions are created in upper-case characters regardless of the casing of the definitions in trac.ini. For example, the definition extra_view would create the permission EXTRA_VIEW.

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

[extra-permissions]
_perms = EXTRA_VIEW, EXTRA_MODIFY

[graphviz]

cache_dirThe 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_managerIf 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.disabled
cache_max_countThe maximum number of files that the cache should contain. This is the high watermark for the directory entry count.2000
cache_max_sizeThe maximum size in bytes that the cache should consume. This is the high watermark for disk space used.10485760
cache_min_countThe minimum number of files that the cache should contain. This is the low watermark for the directory entry count.1500
cache_min_sizeWhen 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_pathFull 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_dpiDefault dpi setting for graphviz, used during SVG to PNG rasterization.96
encodingThe encoding which should be used for communicating with Graphviz (should match -Gcharset if given).utf-8
out_formatGraph 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_antialiasIf this entry exists in the configuration file, then PNG outputs will be antialiased. Note that this requires rsvg to be installed.disabled
processorGraphviz 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_pathFull path to the rsvg program (including the filename). The default is <cmd_path>/rsvg.(no default)

[header_logo]

altAlternative text for the header logo.(please configure the [header_logo] section in trac.ini)
heightHeight of the header logo image in pixels.-1
linkURL to link to, from the header logo.(no default)
srcURL 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
widthWidth of the header logo image in pixels.-1

[inherit]

htdocs_dirPath 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_dirPath 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_dirPath to the shared templates directory. Templates in that directory are loaded in addition to those in the environments templates directory, but the latter take precedence. (since 0.11)(no default)

[intertrac]

This section configures InterTrac prefixes. Options in this section whose name contain a "." define aspects of the InterTrac prefix corresponding to the option name up to the ".". Options whose name don't contain a "." define an alias.

The .url is mandatory and is used for locating the other Trac. This can be a relative URL in case that Trac environment is located on the same server.

The .title information is used for providing a useful tooltip when moving the cursor over an InterTrac link.

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

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

Example configuration:

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

# -- Link to an external Trac:
trac.title = Edgewall's Trac for Trac
trac.url = http://trac.edgewall.org

[interwiki]

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

Example:

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

[logging]

log_fileIf 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_formatCustom 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_levelLevel of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG).DEBUG
log_typeLogging facility to use. Should be one of (none, file, stderr, syslog, winlog).none

[milestone]

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

[milestone-groups]

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

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

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

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

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

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

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

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

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

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

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

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

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

(since 0.11)

[mimeviewer]

enscript_modesList of additional MIME types known by Enscript. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding Enscript 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 Enscript render, which is 2 (since 0.10).text/x-dylan:dylan:4
enscript_pathPath to the Enscript executable.enscript
max_preview_sizeMaximum file size for HTML preview. (since 0.9)262144
mime_mapList 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_patternsList 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_styleThe default style to use for Pygments syntax highlighting.trac
pygments_modesList 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_widthDisplayed tab width in file preview. (since 0.9)8
treat_as_binaryComma-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_domainsComma-separated list of domains that should be considered as valid for email addresses (such as localdomain).(no default)
always_notify_ownerAlways send notifications to the ticket owner (since 0.9).false
always_notify_reporterAlways send notifications to any address in the reporter field.false
always_notify_updaterAlways send notifications to the person who causes the ticket property change and to any previous updater of that ticket.true
ambiguous_char_widthWhich 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_templateLike 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_senderName 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_domainsComma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).(no default)
mime_encodingSpecifies 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_pathPath to the sendmail executable. The sendmail program must accept the -i and -f options. (since 0.12)sendmail
smtp_always_bccEmail address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10)(no default)
smtp_always_ccEmail address(es) to always send notifications to, addresses can be seen by all recipients (Cc:).(no default)
smtp_default_domainDefault host/domain to append to address that do not specify one.(no default)
smtp_enabledEnable email notification.false
smtp_fromSender address to use in notification emails.trac@localhost
smtp_from_authorUse the action author as the sender of notification emails. (since 1.0)false
smtp_from_nameSender name to use in notification emails.(no default)
smtp_passwordPassword for SMTP server. (since 0.9)(no default)
smtp_portSMTP server port to use for email notification.25
smtp_replytoReply-To address to use in notification emails.trac@localhost
smtp_serverSMTP server hostname to use for email notifications.localhost
smtp_subject_prefixText 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_userUsername for SMTP server. (since 0.9)(no default)
ticket_subject_templateA 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_ccRecipients 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_addrPermit 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_tlsUse SSL/TLS to send notifications over SMTP. (since 0.10)false

[project]

adminE-Mail address of the project's administrator.(no default)
admin_trac_urlBase 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).
descrShort description of the project.My example project
footerPage footer text (right-aligned).Visit the Trac open source project at<br /><a href="http://trac.edgewall.org/">http://trac.edgewall.org/</a>
iconURL of the icon of the project.common/trac.ico
nameName of the project.My Project
urlURL 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_queryThe 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_queryThe 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_pageNumber of tickets displayed per page in ticket queries, by default (since 0.11)100
ticketlink_queryThe 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_pageNumber of tickets displayed per page in ticket reports, by default (since 0.11)100
items_per_page_rssNumber of tickets displayed in the rss feeds for reports (since 0.11)0

[revisionlog]

default_log_limitDefault value for the limit argument in the TracRevisionLog. (since 0.11)100
graph_colorsComma-separated list of colors to use for the TracRevisionLog graph display. (since 1.0)#cc0,#0c0,#0cc,#00c,#c0c,#c00

[roadmap]

stats_providerName 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_filtersSpecifies 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_lengthMinimum 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_karmaBy how many points a failed registration check impacts the overall score.0
account_replace_checksReplace checks in account manager totally.false
attachment_karmaThe karma given to attachments.0
attachment_sample_sizeThe maximum number of bytes from an attachment to pass through the spam filters.16384
authenticated_karmaThe karma given to authenticated users, in case trust_authenticated is false.20
badcontent_fileLocal file to be loaded to get BadContent. Can be used in addition to BadContent wiki page.(no default)
captchaCAPTCHA method to use for verifying humans.ExpressionCaptcha
captcha_expression_ceilingMaximum value of individual terms in numeric CAPTCHA expression.10
captcha_expression_termsNumber of terms in numeric CAPTCHA expression.3
captcha_failed_karmaBy how many points a failed CAPTCHA impacts the overall score.1
captcha_image_alphabetAlphabet to choose image CAPTCHA challenge from.abcdefghkmnopqrstuvwxyz
captcha_image_font_sizeFont size to use in image CAPTCHA.25
captcha_image_fontsSet of fonts to choose from when generating image CAPTCHA.vera.ttf
captcha_image_lettersNumber of letters to use in image CAPTCHA challenge.6
captcha_karmaBy how many points a successful CAPTCHA response increases the overall score.20
captcha_karma_lifetimeTime in seconds that a successful CAPTCHA response increases karma.86400
captcha_keycaptcha_private_keyPrivate key for KeyCaptcha? usage.(no default)
captcha_keycaptcha_user_idUser id for KeyCaptcha? usage.(no default)
captcha_lifetimeTime in seconds before database cleanup is called.3600
ip6_blacklist_serversServers used for IPv6 blacklisting.all.s5h.net, dnsbl.dronebl.org, bl.ipv6.spameatingmonkey.net
ip_blacklist_karmaBy how many points blacklisting by a single server impacts the overall karma of a submission.5
ip_blacklist_serversServers used for IPv4 blacklisting.list.blogspambl.com, all.s5h.net, dnsbl.tornevall.org, dnsbl.dronebl.org
ip_throttle_karmaBy how many points exceeding the configured maximum number of posts per hour impacts the overall score.3
ipbadcontent_fileLocal file to be loaded to get BadIP. Can be used in addition to BadIP wiki page.(no default)
ipregex_karmaBy how many points a match with a pattern on the BadIP page impacts the overall karma of a submission.20
is_forwardedInterpret X-Forwarded-For header for IP checks.false
logging_enabledWhether all content submissions and spam filtering activity should be logged to the database.true
max_posts_by_ipThe maximum allowed number of submissions per hour from a single IP address. If this limit is exceeded, subsequent submissions get negative karma.10
min_karmaThe minimum score required for a submission to be allowed.0
purge_ageThe number of days after which log entries should be purged.7
regex_karmaBy how many points a match with a pattern on the BadContent page impacts the overall karma of a submission.5
register_karmaThe karma given to registrations.0
reject_handlerThe handler used to reject content.FilterSystem
report_pagesList of page types to add spam report linkwiki, attachment, ticket
show_blacklistedShow the matched bad content patterns in rejection message.true
show_blacklisted_ipShow the matched bad IP patterns in rejection message.true
show_train_onlyShow the buttons for training without deleting entry.disabled
skip_externalSkip external calls when this negative karma is already reached by internal tests.20
skip_externalhamSkip external calls when this positive karma is already reached by internal tests.30
spam_monitor_entriesHow many monitor entries are displayed by default (between 5 and 10000).100
spam_report_entriesHow many report entries are displayed by default (between 5 and 10000).100
spam_user_defaultmodeDefault mode for spam user admin panel.overview
spam_user_maxageHow many days no login are considered for dead accounts.200
spam_user_minwikiHow many wiki edits are still an unused account.0
stop_externalStop external calls when this negative karma is reached.50
stop_externalhamStop external calls when this positive karma is reached.50
train_externalAllow training of external services.true
trap_karmaBy how many points a trap reject impacts the overall karma of a submission.10
trap_nameName of the invisible trap field, should contain some reference to e-mail for better results.sfp_email
trap_name_hiddenName of the hidden trap field, should contain some reference to e-mail for better results.sfph_mail
trap_name_registerName of the register trap field, should contain some reference to web/homepage for better results.spf_homepage
trust_authenticatedWhether content submissions by authenticated users should be trusted without checking for potential spam or other abuse.false
url_blacklist_karmaBy how many points blacklisting by a single bad URL impacts the overall karma of a submission.3
url_blacklist_serversServers used for URL blacklisting.urired.spameatingmonkey.net, multi.surbl.org, dbl.spamhaus.org
use_externalAllow usage of external services.true

[sqlite]

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

[ticket]

default_ccDefault cc: list for newly created tickets.(no default)
default_componentDefault component for newly created tickets.(no default)
default_descriptionDefault description for newly created tickets.(no default)
default_keywordsDefault keywords for newly created tickets.(no default)
default_milestoneDefault milestone for newly created tickets.(no default)
default_ownerDefault owner for newly created tickets.< default >
default_priorityDefault priority for newly created tickets.major
default_resolutionDefault resolution for resolving (closing) tickets (since 0.11).fixed
default_severityDefault severity for newly created tickets.(no default)
default_summaryDefault summary (title) for newly created tickets.(no default)
default_typeDefault type for newly created tickets (since 0.9).defect
default_versionDefault version for newly created tickets.(no default)
max_comment_sizeMaximum allowed comment size in characters. (since 0.11.2).262144
max_description_sizeMaximum allowed description size in characters. (since 0.11).262144
max_summary_sizeMaximum allowed summary size in characters. (since 1.0.2).262144
preserve_newlinesWhether 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_ownerMake 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
workflowOrdered 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 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.

(since 0.11)

[timeline]

abbreviated_messagesWhether 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)enabled
default_daysbackDefault number of days displayed in the Timeline, in days. (since 0.9.)30
max_daysbackMaximum number of days (-1 for unlimited) displayable in the Timeline. (since 0.11)90
newticket_formatterWhich 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. (since 0.11).oneliner
ticket_show_detailsEnable the display of all ticket changes in the timeline, not only open / close operations (since 0.9).false

[trac]

auth_cookie_lifetimeLifetime 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_pathPath 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_timeoutInactivity 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_reloadAutomatically reload template files after modification.disabled
backup_dirDatabase backup locationdb
base_urlReference 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_ipWhether the IP address of the user should be checked for authentication (since 0.9).false
databaseDatabase connection string for this projectsqlite:db/trac.db
debug_sqlShow the SQL queries in the Trac log, at DEBUG level. (Since 0.11.5)disabled
default_charsetCharset to be used when in doubt.utf-8
default_date_formatThe 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_formatThe date information format. Valid options are 'relative' for displaying relative format and 'absolute' for displaying absolute format. (since 1.0)relative
default_handlerName 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_languageThe preferred language to use if no user preference has been set. (since 0.12.1)(no default)
default_timezoneThe default timezone to use(no default)
genshi_cache_sizeThe 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_locationBase 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_caseWhether login names should be converted to lower case (since 0.9).false
jquery_locationLocation 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_locationLocation 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_locationLocation 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)
mainnavOrder of the items to display in the mainnav navigation bar, listed by IDs. See also TracNavigation.wiki, timeline, roadmap, browser, tickets, newticket, search
metanavOrder of the items to display in the metanav navigation bar, listed by IDs. See also TracNavigation.login, logout, prefs, help, about
never_obfuscate_mailtoNever obfuscate mailto: links explicitly written in the wiki, even if show_email_addresses is false or the user doesn't have EMAIL_VIEW permission (since 0.11.6).false
permission_policiesList 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_storeName of the component implementing IPermissionStore, which is used for managing user and group permissions.DefaultPermissionStore
pg_dump_pathLocation of pg_dump for Postgres database backupspg_dump
request_filtersOrdered list of filters to apply to all requests (since 0.10).(no default)
resizable_textareasMake <textarea> fields resizable. Requires JavaScript. (since 0.12)true
secure_cookiesRestrict 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)disabled
show_email_addressesShow email addresses instead of usernames. If false, email addresses are obfuscated for users that don't have EMAIL_VIEW permission. (since 0.11)false
show_ip_addressesShow IP addresses for resource edits (e.g. wiki). Since 1.0.5 this option is deprecated and will be removed in 1.3.1. (since 0.11.3)false
timeoutTimeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11)20
use_base_url_for_redirectOptionally 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)disabled
use_xsendfileWhen 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_toolbarsAdd a simple toolbar on top of Wiki <textarea>s. (since 1.0.2)true

[virtualticketpermissions]

group_blacklistGroups that do not affect the common membership check.anonymous, authenticated

[wiki]

ignore_missing_pagesEnable/disable highlighting CamelCase links to missing pages (since 0.9).false
max_sizeMaximum allowed wiki page size in characters. (since 0.11.2)262144
render_unsafe_contentEnable/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_schemesList 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_namesEnable/disable splitting the WikiPageNames with space characters (since 0.10).false

Example Configuration (SMTP)

[notification]
smtp_enabled = true
smtp_server = mail.example.com
smtp_from = notifier@example.com
smtp_replyto = myproj@projects.example.com
smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com

Example Configuration (sendmail)

[notification]
smtp_enabled = true
email_sender = SendmailEmailSender
sendmail_path = /usr/sbin/sendmail
smtp_from = notifier@example.com
smtp_replyto = myproj@projects.example.com
smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com

Subscriber Configuration

The default subscriptions are configured in the [notification-subscriber] section.

[account-manager]

account_changes_notify_addressesList of email addresses that get notified of user changes, ie, new user, password change and delete user.(no default)
allow_delete_accountAllow users to delete their own account.enabled
authentication_urlURL of the HTTP authentication service(no default)
cookie_refresh_pctPersistent 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_realmRealm to select relevant htdigest db entries(no default)
environ_auth_overwriteWhether 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_changeForce the user to change password when it's reset.enabled
generated_password_lengthLength of the randomly-generated passwords created when resetting the password for an account.8
hash_methodIPasswordHashMethod used to create new/updated passwordsHtDigestHashMethod
htdigest_filePath relative to Trac environment or full host machine path to password file(no default)
htdigest_realmRealm to select relevant htdigest file entries(no default)
login_attempt_max_countLock user account after specified number of login attempts. Value zero means no limit.0
login_opt_listSet to True, to switch login page style showing alternative actions in a single listing together.disabled
notify_actionsComma separated list of actions to notify of. Available actions 'new', 'change', 'delete'.
password_formatLegacy option, deprecated since acct_mgr-0.1.2(no default)
password_storeOrdered list of password stores, queried in turn.(no default)
persistent_sessionsAllow 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_passwdRe-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_tokenA string required as input to pass verification.(no default)
register_checkOrdered list of IAccountRegistrationInspector's to use for registration checks.BasicCheck, EmailCheck, BotTrapCheck, RegExpCheck, UsernamePermCheck
reset_passwordSet to False, if there is no email system setup.enabled
user_lock_max_timeLimit user account lock time to specified time (seconds). This is relevant only with user_lock_time_progression > 1.86400
user_lock_timeDrop user account lock after specified time (seconds). Value zero means unlimited lock time.0
user_lock_time_progressionExtend user account lock time incrementally. This is based on logarithmic calculation and decimal numbers accepted: Value '1' means constant lock time per failed login attempt. Value '2' means double locktime after 2nd lock activation, four times the initial locktime after 3rd, and so on.1
username_char_blacklistAlways exclude some special characters from usernames. This is enforced upon new user registration.:[]
verify_emailVerify the email address of Trac users.enabled

[attachment]

max_sizeMaximum allowed file size (in bytes) for attachments.262144
max_zip_sizeMaximum 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_contentWhether 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

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

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

See also: TracPlugins

[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]
EXTRA_ADMIN = EXTRA_VIEW, EXTRA_MODIFY, EXTRA_DELETE

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.

The permissions are created in upper-case characters regardless of the casing of the definitions in trac.ini. For example, the definition extra_view would create the permission EXTRA_VIEW.

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

[extra-permissions]
_perms = EXTRA_VIEW, EXTRA_MODIFY

[graphviz]

cache_dirThe 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_managerIf 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.disabled
cache_max_countThe maximum number of files that the cache should contain. This is the high watermark for the directory entry count.2000
cache_max_sizeThe maximum size in bytes that the cache should consume. This is the high watermark for disk space used.10485760
cache_min_countThe minimum number of files that the cache should contain. This is the low watermark for the directory entry count.1500
cache_min_sizeWhen 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_pathFull 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_dpiDefault dpi setting for graphviz, used during SVG to PNG rasterization.96
encodingThe encoding which should be used for communicating with Graphviz (should match -Gcharset if given).utf-8
out_formatGraph 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_antialiasIf this entry exists in the configuration file, then PNG outputs will be antialiased. Note that this requires rsvg to be installed.disabled
processorGraphviz 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_pathFull path to the rsvg program (including the filename). The default is <cmd_path>/rsvg.(no default)

[header_logo]

altAlternative text for the header logo.(please configure the [header_logo] section in trac.ini)
heightHeight of the header logo image in pixels.-1
linkURL to link to, from the header logo.(no default)
srcURL 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
widthWidth of the header logo image in pixels.-1

[inherit]

htdocs_dirPath 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_dirPath 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_dirPath to the shared templates directory. Templates in that directory are loaded in addition to those in the environments templates directory, but the latter take precedence. (since 0.11)(no default)

[intertrac]

This section configures InterTrac prefixes. Options in this section whose name contain a "." define aspects of the InterTrac prefix corresponding to the option name up to the ".". Options whose name don't contain a "." define an alias.

The .url is mandatory and is used for locating the other Trac. This can be a relative URL in case that Trac environment is located on the same server.

The .title information is used for providing a useful tooltip when moving the cursor over an InterTrac link.

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

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

Example configuration:

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

# -- Link to an external Trac:
trac.title = Edgewall's Trac for Trac
trac.url = http://trac.edgewall.org

[interwiki]

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

Example:

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

[logging]

log_fileIf 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_formatCustom 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_levelLevel of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG).DEBUG
log_typeLogging facility to use. Should be one of (none, file, stderr, syslog, winlog).none

[milestone]

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

[milestone-groups]

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

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

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

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

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

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

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

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

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

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

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

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

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

(since 0.11)

[mimeviewer]

enscript_modesList of additional MIME types known by Enscript. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding Enscript 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 Enscript render, which is 2 (since 0.10).text/x-dylan:dylan:4
enscript_pathPath to the Enscript executable.enscript
max_preview_sizeMaximum file size for HTML preview. (since 0.9)262144
mime_mapList 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_patternsList 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_styleThe default style to use for Pygments syntax highlighting.trac
pygments_modesList 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_widthDisplayed tab width in file preview. (since 0.9)8
treat_as_binaryComma-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_domainsComma-separated list of domains that should be considered as valid for email addresses (such as localdomain).(no default)
always_notify_ownerAlways send notifications to the ticket owner (since 0.9).false
always_notify_reporterAlways send notifications to any address in the reporter field.false
always_notify_updaterAlways send notifications to the person who causes the ticket property change and to any previous updater of that ticket.true
ambiguous_char_widthWhich 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_templateLike 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_senderName 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_domainsComma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).(no default)
mime_encodingSpecifies 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_pathPath to the sendmail executable. The sendmail program must accept the -i and -f options. (since 0.12)sendmail
smtp_always_bccEmail address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10)(no default)
smtp_always_ccEmail address(es) to always send notifications to, addresses can be seen by all recipients (Cc:).(no default)
smtp_default_domainDefault host/domain to append to address that do not specify one.(no default)
smtp_enabledEnable email notification.false
smtp_fromSender address to use in notification emails.trac@localhost
smtp_from_authorUse the action author as the sender of notification emails. (since 1.0)false
smtp_from_nameSender name to use in notification emails.(no default)
smtp_passwordPassword for SMTP server. (since 0.9)(no default)
smtp_portSMTP server port to use for email notification.25
smtp_replytoReply-To address to use in notification emails.trac@localhost
smtp_serverSMTP server hostname to use for email notifications.localhost
smtp_subject_prefixText 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_userUsername for SMTP server. (since 0.9)(no default)
ticket_subject_templateA 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_ccRecipients 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_addrPermit 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_tlsUse SSL/TLS to send notifications over SMTP. (since 0.10)false

[project]

adminE-Mail address of the project's administrator.(no default)
admin_trac_urlBase 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).
descrShort description of the project.My example project
footerPage footer text (right-aligned).Visit the Trac open source project at<br /><a href="http://trac.edgewall.org/">http://trac.edgewall.org/</a>
iconURL of the icon of the project.common/trac.ico
nameName of the project.My Project
urlURL 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_queryThe 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_queryThe 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_pageNumber of tickets displayed per page in ticket queries, by default (since 0.11)100
ticketlink_queryThe 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_pageNumber of tickets displayed per page in ticket reports, by default (since 0.11)100
items_per_page_rssNumber of tickets displayed in the rss feeds for reports (since 0.11)0

[revisionlog]

default_log_limitDefault value for the limit argument in the TracRevisionLog. (since 0.11)100
graph_colorsComma-separated list of colors to use for the TracRevisionLog graph display. (since 1.0)#cc0,#0c0,#0cc,#00c,#c0c,#c00

[roadmap]

stats_providerName 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_filtersSpecifies 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_lengthMinimum 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_karmaBy how many points a failed registration check impacts the overall score.0
account_replace_checksReplace checks in account manager totally.false
attachment_karmaThe karma given to attachments.0
attachment_sample_sizeThe maximum number of bytes from an attachment to pass through the spam filters.16384
authenticated_karmaThe karma given to authenticated users, in case trust_authenticated is false.20
badcontent_fileLocal file to be loaded to get BadContent. Can be used in addition to BadContent wiki page.(no default)
captchaCAPTCHA method to use for verifying humans.ExpressionCaptcha
captcha_expression_ceilingMaximum value of individual terms in numeric CAPTCHA expression.10
captcha_expression_termsNumber of terms in numeric CAPTCHA expression.3
captcha_failed_karmaBy how many points a failed CAPTCHA impacts the overall score.1
captcha_image_alphabetAlphabet to choose image CAPTCHA challenge from.abcdefghkmnopqrstuvwxyz
captcha_image_font_sizeFont size to use in image CAPTCHA.25
captcha_image_fontsSet of fonts to choose from when generating image CAPTCHA.vera.ttf
captcha_image_lettersNumber of letters to use in image CAPTCHA challenge.6
captcha_karmaBy how many points a successful CAPTCHA response increases the overall score.20
captcha_karma_lifetimeTime in seconds that a successful CAPTCHA response increases karma.86400
captcha_keycaptcha_private_keyPrivate key for KeyCaptcha? usage.(no default)
captcha_keycaptcha_user_idUser id for KeyCaptcha? usage.(no default)
captcha_lifetimeTime in seconds before database cleanup is called.3600
ip6_blacklist_serversServers used for IPv6 blacklisting.all.s5h.net, dnsbl.dronebl.org, bl.ipv6.spameatingmonkey.net
ip_blacklist_karmaBy how many points blacklisting by a single server impacts the overall karma of a submission.5
ip_blacklist_serversServers used for IPv4 blacklisting.list.blogspambl.com, all.s5h.net, dnsbl.tornevall.org, dnsbl.dronebl.org
ip_throttle_karmaBy how many points exceeding the configured maximum number of posts per hour impacts the overall score.3
ipbadcontent_fileLocal file to be loaded to get BadIP. Can be used in addition to BadIP wiki page.(no default)
ipregex_karmaBy how many points a match with a pattern on the BadIP page impacts the overall karma of a submission.20
is_forwardedInterpret X-Forwarded-For header for IP checks.false
logging_enabledWhether all content submissions and spam filtering activity should be logged to the database.true
max_posts_by_ipThe maximum allowed number of submissions per hour from a single IP address. If this limit is exceeded, subsequent submissions get negative karma.10
min_karmaThe minimum score required for a submission to be allowed.0
purge_ageThe number of days after which log entries should be purged.7
regex_karmaBy how many points a match with a pattern on the BadContent page impacts the overall karma of a submission.5
register_karmaThe karma given to registrations.0
reject_handlerThe handler used to reject content.FilterSystem
report_pagesList of page types to add spam report linkwiki, attachment, ticket
show_blacklistedShow the matched bad content patterns in rejection message.true
show_blacklisted_ipShow the matched bad IP patterns in rejection message.true
show_train_onlyShow the buttons for training without deleting entry.disabled
skip_externalSkip external calls when this negative karma is already reached by internal tests.20
skip_externalhamSkip external calls when this positive karma is already reached by internal tests.30
spam_monitor_entriesHow many monitor entries are displayed by default (between 5 and 10000).100
spam_report_entriesHow many report entries are displayed by default (between 5 and 10000).100
spam_user_defaultmodeDefault mode for spam user admin panel.overview
spam_user_maxageHow many days no login are considered for dead accounts.200
spam_user_minwikiHow many wiki edits are still an unused account.0
stop_externalStop external calls when this negative karma is reached.50
stop_externalhamStop external calls when this positive karma is reached.50
train_externalAllow training of external services.true
trap_karmaBy how many points a trap reject impacts the overall karma of a submission.10
trap_nameName of the invisible trap field, should contain some reference to e-mail for better results.sfp_email
trap_name_hiddenName of the hidden trap field, should contain some reference to e-mail for better results.sfph_mail
trap_name_registerName of the register trap field, should contain some reference to web/homepage for better results.spf_homepage
trust_authenticatedWhether content submissions by authenticated users should be trusted without checking for potential spam or other abuse.false
url_blacklist_karmaBy how many points blacklisting by a single bad URL impacts the overall karma of a submission.3
url_blacklist_serversServers used for URL blacklisting.urired.spameatingmonkey.net, multi.surbl.org, dbl.spamhaus.org
use_externalAllow usage of external services.true

[sqlite]

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

[ticket]

default_ccDefault cc: list for newly created tickets.(no default)
default_componentDefault component for newly created tickets.(no default)
default_descriptionDefault description for newly created tickets.(no default)
default_keywordsDefault keywords for newly created tickets.(no default)
default_milestoneDefault milestone for newly created tickets.(no default)
default_ownerDefault owner for newly created tickets.< default >
default_priorityDefault priority for newly created tickets.major
default_resolutionDefault resolution for resolving (closing) tickets (since 0.11).fixed
default_severityDefault severity for newly created tickets.(no default)
default_summaryDefault summary (title) for newly created tickets.(no default)
default_typeDefault type for newly created tickets (since 0.9).defect
default_versionDefault version for newly created tickets.(no default)
max_comment_sizeMaximum allowed comment size in characters. (since 0.11.2).262144
max_description_sizeMaximum allowed description size in characters. (since 0.11).262144
max_summary_sizeMaximum allowed summary size in characters. (since 1.0.2).262144
preserve_newlinesWhether 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_ownerMake 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
workflowOrdered 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 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.

(since 0.11)

[timeline]

abbreviated_messagesWhether 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)enabled
default_daysbackDefault number of days displayed in the Timeline, in days. (since 0.9.)30
max_daysbackMaximum number of days (-1 for unlimited) displayable in the Timeline. (since 0.11)90
newticket_formatterWhich 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. (since 0.11).oneliner
ticket_show_detailsEnable the display of all ticket changes in the timeline, not only open / close operations (since 0.9).false

[trac]

auth_cookie_lifetimeLifetime 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_pathPath 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_timeoutInactivity 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_reloadAutomatically reload template files after modification.disabled
backup_dirDatabase backup locationdb
base_urlReference 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_ipWhether the IP address of the user should be checked for authentication (since 0.9).false
databaseDatabase connection string for this projectsqlite:db/trac.db
debug_sqlShow the SQL queries in the Trac log, at DEBUG level. (Since 0.11.5)disabled
default_charsetCharset to be used when in doubt.utf-8
default_date_formatThe 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_formatThe date information format. Valid options are 'relative' for displaying relative format and 'absolute' for displaying absolute format. (since 1.0)relative
default_handlerName 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_languageThe preferred language to use if no user preference has been set. (since 0.12.1)(no default)
default_timezoneThe default timezone to use(no default)
genshi_cache_sizeThe 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_locationBase 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_caseWhether login names should be converted to lower case (since 0.9).false
jquery_locationLocation 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_locationLocation 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_locationLocation 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)
mainnavOrder of the items to display in the mainnav navigation bar, listed by IDs. See also TracNavigation.wiki, timeline, roadmap, browser, tickets, newticket, search
metanavOrder of the items to display in the metanav navigation bar, listed by IDs. See also TracNavigation.login, logout, prefs, help, about
never_obfuscate_mailtoNever obfuscate mailto: links explicitly written in the wiki, even if show_email_addresses is false or the user doesn't have EMAIL_VIEW permission (since 0.11.6).false
permission_policiesList 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_storeName of the component implementing IPermissionStore, which is used for managing user and group permissions.DefaultPermissionStore
pg_dump_pathLocation of pg_dump for Postgres database backupspg_dump
request_filtersOrdered list of filters to apply to all requests (since 0.10).(no default)
resizable_textareasMake <textarea> fields resizable. Requires JavaScript. (since 0.12)true
secure_cookiesRestrict 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)disabled
show_email_addressesShow email addresses instead of usernames. If false, email addresses are obfuscated for users that don't have EMAIL_VIEW permission. (since 0.11)false
show_ip_addressesShow IP addresses for resource edits (e.g. wiki). Since 1.0.5 this option is deprecated and will be removed in 1.3.1. (since 0.11.3)false
timeoutTimeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11)20
use_base_url_for_redirectOptionally 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)disabled
use_xsendfileWhen 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_toolbarsAdd a simple toolbar on top of Wiki <textarea>s. (since 1.0.2)true

[virtualticketpermissions]

group_blacklistGroups that do not affect the common membership check.anonymous, authenticated

[wiki]

ignore_missing_pagesEnable/disable highlighting CamelCase links to missing pages (since 0.9).false
max_sizeMaximum allowed wiki page size in characters. (since 0.11.2)262144
render_unsafe_contentEnable/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_schemesList 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_namesEnable/disable splitting the WikiPageNames with space characters (since 0.10).false

Each user can override these defaults in their Notifications preferences.

For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules.

The subscription rule name on the left side of the = can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the = must be one of the subscribers listed in the above table.

The following attributes of default subscriptions can be configured:

  • .distributor (Default: email)
    • Other values require plugins. For example on-site requires th:OnSiteNotificationsPlugin.
  • .priority (Default: 100)
    • Smaller values override larger values.
    • If you use 0, then users will not be able to override this rule.
  • .adverb (Default: always)
    • never can be used to silence other subscription rules with higher values.
  • .format (Default: text/plain)
    • Other values require plugins. For example text/html requires th:TracHtmlNotificationPlugin.

Example Configuration (default subscriptions)

[notification-subscriber]
always_notify_owner = TicketOwnerSubscriber
always_notify_owner.distributor = email
always_notify_owner.priority = 100
always_notify_owner.adverb = always
always_notify_owner.format = text/plain

always_notify_previous_updater = TicketPreviousUpdatersSubscriber

never_notify_updater = TicketUpdaterSubscriber
never_notify_updater.adverb = never
never_notify_updater.priority = 0

notify_cc_html = CarbonCopySubscriber
notify_cc_html.format = text/html

Customizing the e-mail subject

The e-mail subject can be customized with the ticket_subject_template option, which contains a Genshi text template snippet. The default value is:

${prefix} #${ticket.id}: ${summary}

The following variables are available in the template:

  • env: The project environment object (see env.py).
  • prefix: The prefix defined in smtp_subject_prefix.
  • summary: The ticket summary, with the old value if the summary was edited.
  • ticket: The ticket model object (see model.py). Individual ticket fields can be accessed by appending the field name separated by a dot, eg ${ticket.milestone}.

Customizing the e-mail content

The notification e-mail content is generated based on ticket_notify_email.txt in trac/ticket/templates. You can add your own version of this template by adding a ticket_notify_email.txt to the templates directory of your environment. The default is:

${ticket_body_hdr}
${ticket_props}
# if ticket.new:
${ticket.description}
# else:
#   if changes_body:
${_('Changes (by %(author)s):', author=change.author)}

${changes_body}
#   endif
#   if changes_descr:
#     if not changes_body and not change.comment and change.author:
${_('Description changed by %(author)s:', author=change.author)}
#     endif
${changes_descr}
--
#   endif
#   if change.comment:

${_('Comment:') if changes_body else
  _('Comment (by %(author)s):', author=change.author)}

${change.comment}
#   endif
# endif
--
${_('Ticket URL: <%(link)s>', link=ticket.link)}
${project.name} <${project.url or abs_href()}>
${project.descr}

See the cookbook for additional template customization recipes.

Sample Email

#42: testing
---------------------------+------------------------------------------------
       Id:  42             |      Status:  assigned                
Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
 Severity:  major          |   Milestone:  0.9                     
 Priority:  lowest         |     Version:  0.6                     
    Owner:  anonymous      |    Reporter:  jonas@example.com               
---------------------------+------------------------------------------------
Changes:
  * component:  changeset view => search system
  * priority:  low => highest
  * owner:  jonas => anonymous
  * cc:  daniel@example.com =>
         daniel@example.com, jonas@example.com
  * status:  new => assigned

Comment:
I'm interested too!

--
Ticket URL: <http://example.com/trac/ticket/42>
My Project <http://myproj.example.com/>

Using GMail as the SMTP relay host

Use the following configuration snippet:

[notification]
smtp_enabled = true
use_tls = true
mime_encoding = base64
smtp_server = smtp.gmail.com
smtp_port = 587
smtp_user = user
smtp_password = password

where user and password match an existing GMail account, ie the ones you use to log in on http://gmail.com.

Alternatively, you can use smtp_port = 25.
You should not use smtp_port = 465. Doing so may deadlock your ticket submission. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See #7107 for details.

Troubleshooting

If notifications are not working, inspect the log for error messages.

Notification errors are not always reported through the web interface, so the user who submits a change or creates a ticket may not get notified about a notification failure. The Trac administrator needs to look at the log to find the error message and traceback.

Permission denied error

Typical error message:

  ...
  File ".../smtplib.py", line 303, in connect
    raise socket.error, msg
  error: (13, 'Permission denied')

This error usually comes from a security settings on the server: many Linux distributions do not allow the web server (Apache, ...) to post email messages to the local SMTP server.

Many users get confused when their manual attempts to contact the SMTP server succeed:

telnet localhost 25

This is because a regular user may connect to the SMTP server, but the web server cannot:

sudo -u www-data telnet localhost 25

In such a case, you need to configure your server so that the web server is authorized to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help in the Trac MailingList archive.

Relevant ML threads:

For SELinux in Fedora 10:

$ setsebool -P httpd_can_sendmail 1

Suspected spam error

Some SMTP servers may reject the notification email sent by Trac.

The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger false positive spam detection on sensitive email servers. In such an event, change the default encoding to "quoted-printable" using the mime_encoding option.

Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, stick with the Base64 encoding.


See also: TracTickets, TracIni, TracGuide, TracDev/NotificationApi