| Version 1 (modified by trac, 16 years ago) |
|---|
The Trac Configuration File
Table of Contents
Trac configuration is done by editing the trac.ini config file, located in <projectenv>/conf/trac.ini.
Global Configuration
Since version 0.9, Trac can also read the configuration from a global trac.ini file. These global options will then be merged with the environment-specific options, where local options override global options.
The global configuration is by default localted in $prefix/share/trac/conf/trac.ini. It can be moved to a different location (for example, /etc/trac.ini), but that requires changing the file trac/siteconfig.py which gets created when Trac is installed.
Reference
This is a brief reference of available configuration options.
[attachment]
| max_size | Maximum allowed file size 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). |
[browser]
| 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). |
| hide_properties | List of subversion properties to hide from the repository browser (since 0.9) |
| 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) |
[changeset]
| 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. |
| max_diff_files | Maximum number of modified files for which the changeset view will attempt to show the diffs inlined (since 0.10). |
| 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). |
[header_logo]
| width | Width of the header logo image in pixels. |
| height | Height of the header logo image in pixels. |
| alt | Alternative text for the header logo. |
| src | URL of the image to use as header logo. |
| link | URL to link to from header logo. |
[logging]
| log_level | Level of verbosity in log. Should be one of (CRITICAL, ERROR, WARN, INFO, DEBUG). |
| 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 library (see http://docs.python.org/lib/node422.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_file | If log_type is file, this should be a path to the log-file. |
| log_type | Logging facility to use. Should be one of (none, file, stderr, syslog, winlog). |
[mimeviewer]
| php_path | Path to the PHP executable (since 0.9). |
| silvercity_modes | List of additional MIME types known by SilverCity?. For each, a tuple mimetype:mode:quality has to be specified, where mimetype is the MIME type, mode is the corresponding SilverCity? 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 SilverCity? render, which is 3 (since 0.10). |
| tab_width | Displayed tab width in file preview (since 0.9). |
| 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). |
| enscript_modes | List 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). |
| enscript_path | Path to the Enscript executable. |
[mtn]
| xtracerts | List of user certs to be displayed. |
| cachespec | Select a caching mechanism. |
| mtn_binary | Full path to the monotone binary. |
[notification]
| smtp_always_bcc | Email address(es) to always send notifications to, addresses do not appear publicly (Bcc:). (since 0.10). |
| always_notify_updater | Always send notifications to the person who causes the ticket property change. |
| smtp_user | Username for SMTP server. (since 0.9). |
| always_notify_owner | Always send notifications to the ticket owner (since 0.9). |
| 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_replyto | Reply-To address to use in notification emails. |
| smtp_port | SMTP server port to use for email notification. |
| smtp_from | Sender address to use in notification emails. |
| use_tls | Use SSL/TLS to send notifications (since 0.10). |
| smtp_default_domain | Default host/domain to append to address that do not specify one |
| always_notify_reporter | Always send notifications to any address in the reporter field. |
| smtp_enabled | Enable SMTP (email) notification. |
| 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. Note that the no encoding means that non-ASCII characters in text are going to cause problems with notifications (since 0.10). |
| smtp_always_cc | Email address(es) to always send notifications to, addresses can be see by all recipients (Cc:). |
| smtp_password | Password for SMTP server. (since 0.9). |
| smtp_server | SMTP server hostname to use for email notifications. |
| 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). |
[project]
| url | URL of the main project web site. |
| name | Name of the project. |
| icon | URL of the icon of the project. |
| footer | Page footer text (right-aligned). |
| descr | Short description of the project. |
[search]
| min_query_length | Minimum length of query string allowed when performing a search. |
[spam-filter]
| trust_authenticated | Whether content submissions by authenticated users should be trusted without checking for potential spam or other abuse. |
| min_karma | The minimum score required for a submission to be allowed. |
| extlinks_karma | By how many points too many external links in a submission impact the overall score. |
| ip_blacklist_servers | Servers used for IP blacklisting. |
| akismet_karma | By how many points an Akismet reject impacts the overall karma of a submission. |
| logging_enabled | Whether all content submissions and spam filtering activity should be logged to the database. |
| bayes_min_training | The minimum number of submissions in the training database required for the filter to start impacting the karma of submissions. |
| ip_blacklist_karma | By how many points blacklisting by a single server impacts the overall karma of a submission. |
| akismet_api_key | Wordpress key required to use the Akismet API. |
| regex_karma | By how many points a match with a pattern on the BadContent? page impacts the overall karma of a submission. |
| bayes_karma | By what factor Bayesian spam probability score affects the overall karma of a submission. |
| purge_age | The number of days after which log entries should be purged. |
| 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. |
| ip_throttle_karma | By how many points exceeding the configured maximum number of posts per hour impacts the overall score. |
| akismet_api_url | URL of the Akismet service. |
| 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. |
| attachment_sample_size | The number of bytes from an attachment to pass through the spam filters. |
[ticket]
| default_version | Default version for newly created tickets. |
| restrict_owner | Make the owner field of tickets use a drop-down menu. See Assign-to as Drop-Down List (since 0.9). |
| default_type | Default type for newly created tickets (since 0.9). |
| default_priority | Default priority for newly created tickets. |
| default_milestone | Default milestone for newly created tickets. |
| default_component | Default component for newly created tickets |
[timeline]
| 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). |
| default_daysback | Default number of days displayed in the Timeline, in days. (since 0.9.) |
| ticket_show_details | Enable the display of all ticket changes in the timeline (since 0.9). |
| changeset_show_files | Number of files to show (-1 for unlimited, 0 to disable). |
[trac]
| authz_file | Path to Subversion authorization (authz) file |
| database | Database connection string for this project |
| ignore_auth_case | Whether case should be ignored for login names (since 0.9). |
| metanav | List of items IDs to display in the navigation bar metanav. |
| default_charset | Charset to be used when in doubt. |
| 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) |
| default_handler | Name of the component that handles requests to the base URL. Options include TimelineModule, RoadmapModule, BrowserModule, QueryModule, ReportModule and NewticketModule (since 0.9). |
| htdocs_location | Base URL of the core static resources. |
| permission_store | Name of the component implementing IPermissionStore, which is used for managing user and group permissions. |
| templates_dir | Path to the ClearSilver templates. |
| repository_dir | Path to local repository |
| repository_type | Repository connector type. (since 0.10) |
| request_filters | Ordered list of filters to apply to all requests (since 0.10). |
| 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. |
| timeout | Timeout value for database connection, in seconds. Use '0' to specify no timeout. (Since 0.11) |
| check_auth_ip | Whether the IP address of the user should be checked for authentication (since 0.9). |
| mainnav | List of item IDs to display in the navigation bar mainnav. |
| authz_module_name | The module prefix used in the authz_file. |
[tracbzr]
| include_sideline_changes | Include sideline changes in the list of changes. This option controls whether sideline changes (i.e. changes with dotted revision numbers only) are included in the list of changes as reported by the timeline view. Note that there might be other plugins using that information as well, so there might be other components beside the timeline view that get affected by this setting. Defaults to True. |
| primary_branches | Ordered list of primary branches. These will be listed first in the Branches macro. When viewing the timeline, each changeset will be associated with the first primary branch that contains it. The value is a comma separated list of globs, as used by the fnmatch module. An empty list element can be used to denote the branch at the root of the repository. Defaults to 'trunk'. |
[wiki]
| ignore_missing_pages | Enable/disable highlighting CamelCase links to missing pages (since 0.9). |
| 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). |
| split_page_names | Enable/disable splitting the WikiPageNames with space characters (since 0.10). |
[components]
(since 0.9)
This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to enabled or on will enable the component, any other value (typically disabled or off) will disable the component.
The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.
Consider the following configuration snippet:
[components] trac.ticket.report.ReportModule = disabled webadmin.* = enabled
The first option tells Trac to disable the report module. The second option instructs Trac to enable all components in the webadmin package. Note that the trailing wildcard is required for module/package matching.
See the Plugins page on About Trac to get the list of active components (requires CONFIG_VIEW permissions.)
See also: TracPlugins
Note that prior to Trac r2335 (that applies to 0.9b1 and 0.9b2), you would use a [disabled_components] section instead. See a previous version of this page for the details.
See also: TracGuide, TracAdmin, TracEnvironment
