Context Navigation

Last modified 17 years ago Last modified on 08/20/08 13:35:24

The Trac Configuration File

Global Configuration

In versions prior to 0.11, the global configuration was by default located in $prefix/share/trac/conf/trac.ini or sometimes /etc/trac/trac.ini depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.

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 = /usr/share/trac/conf/trac.ini

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

Reference

This is a brief reference of available configuration options.

`[TracPM]`

`active_goal_statuses`	List of statuses for goal-type tickets that are active
`default_estimate`	Default work for an unestimated task, same units as estimate
`estimate_pad`	How much work may be remaining when a task goes over estimate, same units as estimate
`fields.estimate`	Ticket field to use as the data source for estimated work
`fields.finish`	Ticket field to use as the data source for finish date
`fields.parent`	Ticket field to use as the data source for the parent
`fields.percent`	Ticket field to use as the data source for the percent complete column.
`fields.pred`	Ticket field to use as the data source for predecessor list
`fields.start`	Ticket field to use as the data source for start date
`fields.succ`	Ticket field to use as the data source for successor list
`fields.worked`	Ticket field to use as the data source for completed work
`goal_ticket_type`	Ticket type for milestone-like tickets
`hours_per_estimate`	Hours represented by each unit of estimated work
`incomplete_milestone_goal_status`	Status to give goal-type tickets representing incomplete Trac milestones
`milestone_type`	Ticket type for milestone-like tickets (Deprecated; use goal_ticket_type.)
`parent_format`	Format of ticket IDs in parent field
`useActuals`	Use actual start, finish date for tickets

`[account-manager]`

`account_changes_notify_addresses`	List of email addresses that get notified of user changes, ie, new user, password change and delete user.
`allow_delete_account`	Allow users to delete their own account.
`authentication_url`	URL of the HTTP authentication service
`force_passwd_change`	Force the user to change password when it's reset.
`generated_password_length`	Length of the randomly-generated passwords created when resetting the password for an account.
`hash_method`	Default hash type of new/updated passwords
`htdigest_realm`	Realm to select relevant htdigest file entries
`htpasswd_hash_type`	Default hash type of new/updated passwords
`login_opt_list`	Set to True, to switch login page style showing alternative actions in a single listing together.
`password_format`
`password_store`
`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.
`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.
`reset_password`	Set to False, if there is no email system setup.
`username_char_blacklist`	Always exclude some special characters from usernames. This is enforced upon new user registration.
`verify_email`	Verify the email address of Trac users.

`[attachment]`

`max_size`	Maximum allowed file size (in bytes) for ticket and wiki attachments.
`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).

`[autowikify]`

`exclude`	List of Wiki pages to exclude from auto-wikification.
`explicitly_wikify`	List of Wiki pages to always Wikify, regardless of size.
`minimum_length`	Minimum page length to perform auto-wikification on.

`[batchmod]`

`fields_as_list`	field names modified as a value list(separated by ',')
`list_connector_string`	Connector string for 'list' fields. Defaults to a space.
`list_separator_regex`	separator regex used for 'list' fields

`[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)
`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*)
`hide_properties`	Comma-separated list of version control properties to hide from the repository browser. (since 0.9)
`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)
`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)
`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)
`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)
`oneliner_properties`	Comma-separated list of version control properties to render as oneliner wiki content in the repository browser. (since 0.11)
`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).
`wiki_properties`	Comma-separated list of version control properties to render as wiki content in the repository browser. (since 0.11)

`[changeset]`

`max_diff_bytes`	Maximum total size in bytes of the modified files (their old size plus their new size) for which the changeset view will attempt to show the diffs inlined (since 0.10).
`max_diff_files`	Maximum number of modified files for which the changeset view will attempt to show the diffs inlined (since 0.10).
`wiki_format_messages`	Whether wiki formatting should be applied to changeset messages. If this option is disabled, changeset messages will be rendered as pre-formatted text.

`[discussion]`

`default_message_display`	Default display mode for topic messages list.
`default_topic_display`	Default display mode for forum topics list.
`forum_sort`	Column by which will be sorted forum lists. Possible values are: id group name subject time moderators description topics replies lasttopic lastreply
`forum_sort_direction`	Direction of forum lists sorting. Possible values are: asc desc.
`messages_per_page`	Number of messages per page in message list.
`smtp_always_cc`
`title`	Main navigation bar button title.
`topic_sort`	Column by which will be sorted topic lists. Possible values are: id forum subject time author body replies lastreply.
`topic_sort_direction`	Direction of topic lists sorting. Possible values are: asc desc.
`topics_per_page`	Number of topics per page in topic list.

`[fullblog]`

`default_postname`	Option for a default naming scheme for new posts. The string can include substitution markers for time (UTC) and user: %Y=year, %m=month, %d=day, %H=hour, %M=minute, %S=second, $USER. Example template string: `%Y/%m/%d/my_topic`
`month_names`	Ability to specify a list of month names for display in groupings. If empty it will make a list from default locale setting. Enter list of 12 months like: `month_names = January, February, ..., December`
`num_items_front`	Option to specify how many recent posts to display on the front page of the Blog (and RSS feeds).
`personal_blog`	When using the Blog as a personal blog (only one author), setting to 'True' will disable the display of 'Browse by author:' in sidebar, and also removes various author links and references.

`[google.analytics]`

`admin_logging`	Disabling this option will prevent all logged in admins from showing up on your Google Analytics reports.
`authenticated_logging`	Disabling this option will prevent all authenticated users from showing up on your Google Analytics reports.
`extensions`	Enter any extensions of files you would like to be tracked as a download. For example to track all MP3s and PDFs enter: mp3,pdf Outbound link tracking must be enabled for downloads to be tracked.
`google_external_path`	This will be the path shown on Google Analytics regarding external links. Consider the following link: http://trac.edgewall.org/" The above link will be shown as for example: /external/trac.edgewall.org/ This way you will be able to track outgoing links. Outbound link tracking must be enabled for external links to be tracked.
`outbound_link_tracking`	Disabling this option will turn off the tracking of outbound links. It's recommended not to disable this option unless you're a privacy advocate (now why would you be using Google Analytics in the first place?) or it's causing some kind of weird issue.
`tracking_domain_name`	If you're tracking multiple subdomains with the same Google Analytics profile, like what's talked about in: https://www.google.com/support/googleanalytics/bin/answer.py?answer=55524 enter your main domain here. For more info, please visit the previous link.
`uid`	Google Analytics' UID. The UID is needed for Google Analytics to log your website stats. Your UID can be found by looking in the JavaScript Google Analytics gives you to put on your page. Look for your UID in between `var pageTracker = _gat._getTracker("UA-111111-11");` in the javascript. In this example you would put UA-11111-1 in the UID box.

`[header_logo]`

`alt`	Alternative text for the header logo.
`height`	Height of the header logo image in pixels.
`link`	URL to link to, from the header logo.
`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.
`width`	Width of the header logo image in pixels.

`[importer]`

csv_default_encoding Default encoding of CSV file

`[inherit]`

`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)
`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)

`[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.
`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)
`log_level`	Level of verbosity in log. Should be one of (`CRITICAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`).
`log_type`	Logging facility to use. Should be one of (`none`, `file`, `stderr`, `syslog`, `winlog`).

`[milestone]`

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

`[mimeviewer]`

`max_preview_size`	Maximum file size for HTML preview. (since 0.9)
`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)
`pygments_default_style`	The default style to use for Pygments syntax highlighting.
`pygments_modes`	List of additional MIME types known by Pygments. For each, a tuple `mimetype:mode:quality` has to be specified, where `mimetype` is the MIME type, `mode` is the corresponding Pygments mode to be used for the conversion and `quality` is the quality ratio associated to this conversion. That can also be used to override the default quality ratio used by the Pygments render.
`tab_width`	Displayed tab width in file preview. (since 0.9)
`treat_as_binary`	Comma-separated list of MIME types that should be treated as binary data. (since 0.11.5)

`[notification]`

`admit_domains`	Comma-separated list of domains that should be considered as valid for email addresses (such as localdomain).
`always_notify_owner`	Always send notifications to the ticket owner (since 0.9).
`always_notify_reporter`	Always send notifications to any address in the reporter field.
`always_notify_updater`	Always send notifications to the person who causes the ticket property change and to any previous updater of that ticket.
`ambiguous_char_width`	Which width of ambiguous characters (e.g. 'single' or 'double') should be used in the table of notification mail. If 'single', the same width as characters in US-ASCII. This is expected by most users. If 'double', twice the width of US-ASCII characters. This is expected by CJK users. (since 0.12.2)
`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)
`ignore_domains`	Comma-separated list of domains that should not be considered part of email addresses (for usernames with Kerberos domains).
`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)
`sendmail_path`	Path to the sendmail executable. The sendmail program must accept the `-i` and `-f` options. (since 0.12)
`smtp_always_bcc`	Email address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10).
`smtp_always_cc`	Email address(es) to always send notifications to, addresses can be seen by all recipients (Cc:).
`smtp_default_domain`	Default host/domain to append to address that do not specify one.
`smtp_enabled`	Enable email notification.
`smtp_from`	Sender address to use in notification emails.
`smtp_from_name`	Sender name to use in notification emails.
`smtp_password`	Password for SMTP server. (since 0.9)
`smtp_port`	SMTP server port to use for email notification.
`smtp_replyto`	Reply-To address to use in notification emails.
`smtp_server`	SMTP server hostname to use for email notifications.
`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).
`smtp_user`	Username for SMTP server. (since 0.9)
`ticket_subject_template`	A Genshi text template snippet used to get the notification subject. By default, the subject template is `$prefix #$ticket.id: $summary`. `$prefix` being the value of the `smtp_subject_prefix` option. (since 0.11)
`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)
`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)
`use_tls`	Use SSL/TLS to send notifications over SMTP. (since 0.10)

`[project]`

`admin`	E-Mail address of the project's administrator.
`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.
`footer`	Page footer text (right-aligned).
`icon`	URL of the icon of the project.
`name`	Name of the 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.

`[query]`

`default_anonymous_query`	The default query for anonymous users. The query is either in query language syntax, or a URL query string starting with `?` as used in `query:` Trac links. (since 0.11.2)
`default_query`	The default query for authenticated users. The query is either in query language syntax, or a URL query string starting with `?` as used in `query:` Trac links. (since 0.11.2)
`items_per_page`	Number of tickets displayed per page in ticket queries, by default (since 0.11)
`ticketlink_query`	The base query to be used when linkifying values of ticket fields. The query is a URL query string starting with `?` as used in `query:` Trac links. (since 0.12)

`[report]`

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

`[revisionlog]`

default_log_limit Default value for the limit argument in the TracRevisionLog (since 0.11).

`[roadmap]`

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

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

min_query_length Minimum length of query string allowed when performing a search.

`[spam-filter]`

`akismet_api_key`	Wordpress key required to use the Akismet API.
`akismet_api_url`	URL of the Akismet service.
`akismet_karma`	By how many points an Akismet reject impacts the overall karma of a submission.
`attachment_karma`	The karma given to attachments.
`attachment_sample_size`	The number of bytes from an attachment to pass through the spam filters.
`authenticated_karma`	The karma given to authenticated users, in case `trust_authenticated` is false.
`badcontent_file`	Local file to be loaded to get BadContent. Can be used in addition to BadContent wiki page.
`blogspam_api_url`	URL of the BlogSpam service.
`blogspam_karma`	By how many points an BlogSpam reject impacts the overall karma of a submission.
`blogspam_skip_tests`	Comma separated list of tests to skip.
`captcha`	CAPTCHA method to use for verifying humans.
`captcha_expression_ceiling`	Maximum value of individual terms in numeric CAPTCHA expression.
`captcha_expression_terms`	Number of terms in numeric CAPTCHA expression.
`captcha_image_alphabet`	Alphabet to choose image CAPTCHA challenge from.
`captcha_image_font_size`	Font size to use in image CAPTCHA.
`captcha_image_fonts`	Set of fonts to choose from when generating image CAPTCHA.
`captcha_image_letters`	Number of letters to use in image CAPTCHA challenge.
`captcha_karma`	By how many points a successful CAPTCHA response increases the overall score.
`captcha_karma_lifetime`	Time in seconds that a successful CAPTCHA response increases karma.
`captcha_lifetime`	Time in seconds before database cleanup is called.
`captcha_recaptcha_private_key`	Private key for recaptcha usage..
`captcha_recaptcha_public_key`	Public key for recaptcha usage..
`defensio_api_key`	Defensio key required to use the API.
`defensio_api_url`	URL of the Defensio service.
`defensio_karma`	By how many points a Defensio reject impacts the overall karma of a submission.
`extlinks_allowed_domains`	List of domains that should be allowed in external links
`extlinks_karma`	By how many points too many external links in a submission impact the overall score.
`ip_throttle_karma`	By how many points exceeding the configured maximum number of posts per hour impacts the overall score.
`ipbadcontent_file`	Local file to be loaded to get BadIP. Can be used in addition to BadIP wiki page.
`ipregex_karma`	By how many points a match with a pattern on the BadIP page impacts the overall karma of a submission.
`is_forwarded`	Interpret X-Forwarded-For header for IP checks.
`linksleeve_karma`	By how many points a LinkSleeve reject impacts the overall karma of a submission.
`logging_enabled`	Whether all content submissions and spam filtering activity should be logged to the database.
`max_external_links`	The maximum number of external links allowed in a submission until that submission gets negative karma.
`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.
`min_karma`	The minimum score required for a submission to be allowed.
`purge_age`	The number of days after which log entries should be purged.
`regex_karma`	By how many points a match with a pattern on the BadContent page impacts the overall karma of a submission.
`reject_handler`	The handler used to reject content.
`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.
`show_blacklisted`	Show the matched bad content patterns in rejection message.
`show_blacklisted_ip`	Show the matched bad IP patterns in rejection message.
`stopforumspam_api_key`	API key used to report SPAM.
`stopforumspam_karma`	By how many points a StopForumSpam reject impacts the overall karma of a submission.
`train_external`	Allow training of external services.
`trust_authenticated`	Whether content submissions by authenticated users should be trusted without checking for potential spam or other abuse.
`typepad_api_key`	TypePad key required to use the TypePad AntiSpam API.
`typepad_api_url`	URL of the TypePad service.
`typepad_karma`	By how many points an TypePad reject impacts the overall karma of a submission.
`use_external`	Allow usage of external services.

`[sqlite]`

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

`[svn]`

`branches`	Comma separated list of paths categorized as branches. If a path ends with '', then all the directory entries found below that path will be included. Example: `/trunk, /branches/, /projectAlpha/trunk, /sandbox/*`
`tags`	Comma separated list of paths categorized as tags. If a path ends with '', then all the directory entries found below that path will be included. Example: `/tags/, /projectAlpha/tags/A-1.0, /projectAlpha/tags/A-v1.1`

`[tags]`

listtagged_items_per_page Number of tagged resources displayed per page in tag queries, by default

`[ticket]`

`default_cc`	Default cc: list for newly created tickets.
`default_component`	Default component for newly created tickets.
`default_description`	Default description for newly created tickets.
`default_keywords`	Default keywords for newly created tickets.
`default_milestone`	Default milestone for newly created tickets.
`default_owner`	Default owner for newly created tickets.
`default_priority`	Default priority for newly created tickets.
`default_resolution`	Default resolution for resolving (closing) tickets (since 0.11).
`default_severity`	Default severity for newly created tickets.
`default_summary`	Default summary (title) for newly created tickets.
`default_version`	Default version for newly created tickets.
`max_comment_size`	Don't accept tickets with a too big comment. (since 0.11.2)
`max_description_size`	Don't accept tickets with a too big description. (since 0.11).
`preserve_newlines`	Whether Wiki formatter should respect the new lines present in the Wiki text. If set to 'default', this is equivalent to 'yes' for new environments but keeps the old behavior for upgraded environments (i.e. 'no'). (since 0.11).
`workflow`	Ordered list of workflow controllers to use for ticket actions (since 0.11).

`[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)
`changeset_collapse_events`	Whether consecutive changesets from the same author having exactly the same message should be presented as one event. That event will link to the range of changesets in the log view. (since 0.11)
`changeset_long_messages`	Whether wiki-formatted changeset messages should be multiline or not. If this option is not specified or is false and `wiki_format_messages` is set to true, changeset messages will be single line only, losing some formatting (bullet points, etc).
`changeset_show_files`	Number of files to show (`-1` for unlimited, `0` to disable). This can also be `location`, for showing the common prefix for the changed files. (since 0.11).
`default_daysback`	Default number of days displayed in the Timeline, in days. (since 0.9.)
`max_daysback`	Maximum number of days (-1 for unlimited) displayable in the Timeline. (since 0.11)
`newticket_formatter`	Which formatter flavor (e.g. 'html' or 'oneliner') should be used when presenting the description for new tickets. If 'oneliner', the [timeline] abbreviated_messages option applies. (since 0.11).
`ticket_show_details`	Enable the display of all ticket changes in the timeline, not only open / close operations (since 0.9).

`[trac]`

`authz_file`	The path to the Subversion authorization (authz) file. To enable authz permission checking, the `AuthzSourcePolicy` permission policy must be added to `[trac] permission_policies`.
`authz_module_name`	The module prefix used in the `authz_file` for the default repository. If left empty, the global section is used.
`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)
`auto_reload`	Automatically reload template files after modification.
`backup_dir`	Database backup location
`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.
`database`	Database connection string for this project
`debug_sql`	Show the SQL queries in the Trac log, at DEBUG level. (Since 0.11.5)
`default_charset`	Charset to be used when in doubt.
`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)
`default_language`	The preferred language to use if no user preference has been set. (since 0.12.1)
`default_timezone`	The default timezone to use
`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.
`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.
`mainnav`	Order of the items to display in the `mainnav` navigation bar, listed by IDs. See also TracNavigation.
`metanav`	Order of the items to display in the `metanav` navigation bar, listed by IDs. See also TracNavigation.
`mysqldump_path`	Location of mysqldump for MySQL database backups
`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).
`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)
`permission_store`	Name of the component implementing `IPermissionStore`, which is used for managing user and group permissions.
`pg_dump_path`	Location of pg_dump for Postgres database backups
`repository_dir`	Path to the default repository. This can also be a relative path (since 0.11). This option is deprecated, and repositories should be defined in the repositories section, or using the "Repositories" admin panel. (since 0.12)
`repository_sync_per_request`	List of repositories that should be synchronized on every page request. Leave this option empty if you have set up post-commit hooks calling `trac-admin $ENV changeset added` on all your repositories (recommended). Otherwise, set it to a comma-separated list of repository names. Note that this will negatively affect performance, and will prevent changeset listeners from receiving events from the repositories specified here. The default is to synchronize the default repository, for backward compatibility. (since 0.12)
`repository_type`	Default repository connector type. (since 0.10) This is also used as the default repository type for repositories defined in TracIni#repositories-section repositories or using the "Repositories" admin panel. (since 0.12)
`request_filters`	Ordered list of filters to apply to all requests (since 0.10).
`resizable_textareas`	Make `<textarea>` fields resizable. Requires JavaScript. (since 0.12)
`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)
`show_email_addresses`	Show email addresses instead of usernames. If false, we obfuscate email addresses. (since 0.11)
`show_ip_addresses`	Show IP addresses for resource edits (e.g. wiki). (since 0.11.3)
`timeout`	Timeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11)
`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)

`[trac-jsgantt]`

`option.caption`	Caption to follow task in Gantt
`option.colorBy`	Field to use to color tasks
`option.comp`	Show percent complete column
`option.dateDisplay`	Format to display dates
`option.display`	Display filter for tickets in the form 'field1:value1\|field2:value2' or 'field:value1\|value2'; displays tickets where field1==value1, etc.
`option.doResourceLeveling`	Resource level (1) or not (0)
`option.dur`	Show duration column
`option.endDate`	Show finish date column
`option.expandClosedTickets`	Show children of closed tasks in the task hierarchy
`option.format`	Initial format of Gantt chart
`option.formats`	Formats to show for Gantt chart
`option.hoursPerDay`	Hours worked per day
`option.lwidth`	Width (in pixels) of left table
`option.omitMilestones`	Omit milestones
`option.openLevel`	How many levels of task hierarchy to show open
`option.order`	Fields to sort tasks by before display. May include tickets fields (including custom fields) or 'wbs'.
`option.res`	Show resource column
`option.sample`	Show sample Gantt
`option.schedule`	Schedule algorithm: alap or asap
`option.scrollTo`	Date to scroll chart to (yyyy-mm--dd or 'today')
`option.showdep`	Show dependencies in Gantt
`option.startDate`	Show start date column
`option.userMap`	Map user IDs to user names

`[versioncontrol]`

allowed_repository_dir_prefixes Comma-separated list of allowed prefixes for repository directories when adding and editing repositories in the repository admin panel. If the list is empty, all repository directories are allowed. (since 0.12.1)

`[wiki]`

`ignore_missing_pages`	Enable/disable highlighting CamelCase links to missing pages (since 0.9).
`max_size`	Maximum allowed wiki page size in bytes. (since 0.11.2)
`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).
`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)
`split_page_names`	Enable/disable splitting the WikiPageNames with space characters (since 0.10).

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

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

[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 (which is also the default):

closed = closed
closed.order = 0                     # sequence number in the progress bar
closed.query_args = group=resolution # optional extra param for the query
closed.overall_completion = true     # count for overall completion

active = *                           # one catch-all group is allowed
active.order = 1
active.css_class = open              # CSS class for this interval
active.label = in progress           # Displayed label for this group

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>

[svn:externals]

(since 0.11)

The TracBrowser for Subversion can interpret the svn:externals property of folders out of the box. However, if those externals are not using the http: protocol, or if a link to a different repository browser (such another Trac or ViewVC) is desired, then Trac needs to be able to map an external prefix to this other 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/trac/support/browser/$path?rev=$rev

With the above, the svn://anotherserver.com/tools_repository/tags/1.1/tools external will be mapped to http://ourserver/trac/support/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.

See also: TracGuide, TracAdmin, TracEnvironment

Download in other formats:

Plain Text

Context Navigation

The Trac Configuration File

Table of Contents

Global Configuration

Reference

[TracPM]

[account-manager]

[attachment]

[autowikify]

[batchmod]

[browser]

[changeset]

[discussion]

[fullblog]

[google.analytics]

[header_logo]

[importer]

[inherit]

[logging]

[milestone]

[mimeviewer]

[notification]

[project]

[query]

[report]

[revisionlog]

[roadmap]

[search]

[spam-filter]

[sqlite]

[svn]

[tags]

[ticket]

[timeline]

[trac]

[trac-jsgantt]

[versioncontrol]

[wiki]

[components]

[ticket-custom]

[ticket-workflow]

[milestone-groups]

[svn:externals]

Download in other formats:

`[TracPM]`

`[account-manager]`

`[attachment]`

`[autowikify]`

`[batchmod]`

`[browser]`

`[changeset]`

`[discussion]`

`[fullblog]`

`[google.analytics]`

`[header_logo]`

`[importer]`

`[inherit]`

`[logging]`

`[milestone]`

`[mimeviewer]`

`[notification]`

`[project]`

`[query]`

`[report]`

`[revisionlog]`

`[roadmap]`

`[search]`

`[spam-filter]`

`[sqlite]`

`[svn]`

`[tags]`

`[ticket]`

`[timeline]`

`[trac]`

`[trac-jsgantt]`

`[versioncontrol]`

`[wiki]`