The Trac Configuration File
Trac configuration is done by editing the trac.ini config file, located in <projectenv>/conf/trac.ini. Changes to the configuration are usually reflected immediately, though changes to the [components] or [logging] sections will require restarting the web server. You may also need to restart the web server after creating a global configuration file when none was previously present.
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.
Literally, when you're upgrading to 0.11, you have to add an inherit-section to your project's trac.ini file. Additionally you have to move your customized templates and common images from $prefix/share/trac/... to the new location.
Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
[inherit]
file = /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.
[account-manager]
| account_changes_notify_addresses | List of email addresses that get notified of user changes, ie,
new user, password change and delete user. |
| authentication_url | |
| force_passwd_change | Forge 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 | |
| htdigest_realm | |
| notify_actions | Comma separated list of actions to notify of.
Available actions 'new', 'change', 'delete'. |
| password_file | Path to the users file. Leave blank to locate the users file by reading svnserve.conf |
| password_format | |
| password_store | |
[announcer]
| admit_domains | Comma-separated list of domains that should be considered as
valid for email addresses (such as localdomain) |
| always_notify_component_owner | Whether or not to notify the owner of the ticket's
component. |
| always_notify_owner | The always_notify_owner option mimics the option of the same name
in the notification section, except users can opt-out in their
preferences. Used only if LegacyTicketSubscriber? is enabled. |
| always_notify_reporter | The always_notify_reporter option mimics the option of the
same name in the notification section, except users can opt-out in
their preferences. Used only if LegacyTicketSubscriber? is enabled. |
| always_notify_updater | The always_notify_updater option mimics the option of the
same name in the notification section, except users can opt-out in
their preferences. Used only if LegacyTicketSubscriber? is enabled. |
| default_email_format | The default mime type of the email notifications. This
can be overriden on a per user basis through the announcer
preferences panel. |
| email_address_resolvers | Comma seperated list of email resolver components in the order
they will be called. If an email address is resolved, the remaining
resolvers will no be called. |
| ignore_cc_changes | When true, the system will not send out announcement events if
the only field that was changed was CC. A change to the CC field that
happens at the same as another field will still result in an event
being created. |
| ignore_domains | Comma-separated list of domains that should not be considered
part of email addresses (for usernames with Kerberos domains) |
| joinable_groups | Joinable groups represent 'opt-in' groups that users may
freely join. The name of the groups should be a simple alphanumeric
string. By adding the group name preceeded by @ (such as @sec for
the sec group) to the CC field of a ticket, everyone in that group
will receive an announcement when that ticket is changed. |
| 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_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 see by all recipients (Cc:). |
| smtp_default_domain | Default host/domain to append to address that do not specify one |
| smtp_enabled | Enable SMTP (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_to | Default To: field |
| smtp_user | Username for SMTP server. (since 0.9). |
| ticket_email_header_fields | Comma seperated list of fields to appear in tickets. |
| ticket_email_subject | Format string for ticket email subject. This is
a mini genshi template that is passed the ticket
event and action objects. |
| 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_threaded_delivery | If true, the actual delivery of the message will occur
in a separate thread. Enabling this will improve responsiveness
for requests that end up with an announcement being sent over
email. It requires building Python with threading support
enabled-- which is usually the case. To test, start Python and
type 'import threading' to see if it raises an error. |
| use_tls | Use SSL/TLS to send notifications (since 0.10). |
| watchable_paths | List of URL paths to allow watching. Globs are supported. |
| wiki_email_diff | Should a wiki diff be sent with emails? |
| wiki_email_subject | Format string for the wiki email subject. This is a
mini genshi template and it is passed the page, event
and action objects. |
[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). |
[breadcrumbs]
| ignore pattern | Resource names that match this pattern will not be added to
the breadcrumbs trail. |
| max_crumbs | Indicates the maximum number of breadcrumbs to store per user. |
| paths | List of URL paths to allow breadcrumb tracking. Globs are supported. |
[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_display | Default display mode of topic message 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. |
| 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. |
| closed_states | Set to a comma separated list of workflow states that count as "closed",
where the effort will be treated as zero, e.g. closed_states=closed,another_state.
Defaults to closed. |
| estimation_field | Defines what custom field should be used to calculate estimation charts.
Defaults to 'estimatedhours' |
| estimation_suffix | Suffix used for estimations. Defaults to 'h' |
[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. |
| 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. |
[git]
| cached_repository | wrap GitRepository in CachedRepository |
| git_bin | path to git executable (relative to trac project folder!) |
| persistent_cache | enable persistent caching of commit tree |
| shortrev_len | length rev sha sums should be tried to be abbreviated to (must be >= 4 and <= 40) |
[graphviz]
| cache_dir | The 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 Trac environment's directory. |
| cache_manager | If 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. |
| cache_max_count | The maximum number of files that the cache should
contain. This is the high watermark for the
directory entry count. |
| cache_max_size | The maximum size in bytes that the cache should
consume. This is the high watermark for disk space
used. |
| cache_min_size | When 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. |
| cache_minax_count | The maximum number of files that the cache should
contain. This is the high watermark for the
directory entry count. |
| cmd_path | Full 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. |
| default_graph_dpi | Default dpi setting for graphviz, used during SVG to PNG
rasterization. |
| encoding | The encoding which should be used for communicating with
Graphviz (should match -Gcharset if given). |
| out_format | Graph 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_antialias | If this entry exists in the configuration file,
then PNG outputs will be antialiased.
Note that this requires rsvg to be installed. |
| processor | Graphviz 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. |
| rsvg_path | Full path to where the rsvg binary can be found.
The default is cmd_path + rsvg. |
| alt | Alternative text for the header logo. |
| height | Height of the header logo image in pixels. |
| link | URL to link to from header logo. |
| src | URL of the image to use as header logo. |
| width | Width of the header logo image in pixels. |
[inherit]
| plugins_dir | Path of the directory containing additional plugins.
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) |
[iniadmin]
| excludes | Excludes this options.
Comma separated list as section:name with wildcard characters
(*, ?). |
| passwords | Show input-type as password instead of text.
Comma separated list as section:name with wildcard characters. |
[logging]
| log_file | If log_type is file, this should be a path to the log-file. |
| 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_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). |
[mastertickets]
| dot_path | Path to the dot executable. |
| gs_path | Path to the ghostscript executable. |
| use_gs | If enabled, use ghostscript to produce nicer output. |
[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]
| 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. |
| 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) |
| php_path | Path to the PHP executable (since 0.9). |
| 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. |
| 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) |
| 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 SMTP (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 (since 0.10). |
[privatetickets]
| group_blacklist | Groups that do not affect the common membership check. |
[privatewikis]
| private_wikis | Wikis to protect. |
[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. |
[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) |
[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]
| min_query_length | Minimum length of query string allowed when performing a search. |
[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 |
| ignore_closed_tickets | Do not collect tags from closed tickets. |
| ticket_fields | List of ticket fields to expose as tags. |
[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_type | Default type for newly created tickets (since 0.9). |
| 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). |
| restrict_owner | Make the owner field of tickets use a drop-down menu.
Be sure to understand the performance implications before activating
this option. See
Assign-to as Drop-Down List
(since 0.9). |
| 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 | Path to Subversion
authorization (authz) file |
| authz_module_name | The module prefix used in the authz_file. |
| 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. |
| check_auth_ip | Whether the IP address of the user should be checked for
authentication (since 0.9). |
| 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_timezone | The default timezone to use |
| htdocs_location | Base URL of the core static resources. |
| ignore_auth_case | Whether login names should be converted to lower case
(since 0.9). |
| 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 local repository. This can also be a relative path
(since 0.11). |
| repository_type | Repository connector type. (since 0.10) |
| request_filters | Ordered list of filters to apply to all requests
(since 0.10). |
| 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) |
[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). |
| 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.)
See also: TracPlugins
[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 (the default only has closed and active):
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 # indicates groups that count for overall completion percentage
new = new
new.order = 1
new.css_class = new
new.label = new
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
