Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Apr 13, 2011, 9:03:52 PM (14 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    1 = trac.ini Reference =
     1= The Trac Configuration File =
     2
    23[[TracGuideToc]]
    34
    4 Trac configuration is done by editing the ''trac.ini'' config file, located in {{{<projectenv>/conf/trac.ini}}}.
     5Trac 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.
    56
    6 This is a brief reference of available configuration options.
     7The `trac.ini` configuration file should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches.
    78
    8 == [project] ==
    9 || name   || Project name ||
    10 || descr  || Short project description ||
    11 || url    || URL to the main project website ||
    12 || icon   || URL to icon file to use as shortcut icon (favicon) ||
    13 || footer || Page footer text (right-aligned) ||
     9== Global Configuration ==
    1410
    15 == [trac] ==
    16 || repository_dir  || Path to local Subversion repository ||
    17 || htdocs_location || Base URL for static Trac graphics and CSS files ||
    18 || database        || Database to use for this project ||
    19 || templates_dir   || Path of Clearsilver templates ||
    20 || default_charset || Source files uses this charset ||
     11In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.  Literally, when you're upgrading to 0.11, you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location.
    2112
    22 == [logging] ==
    23 || log_type  || Logging facility to use. (none, file, stderr, syslog, winlog) ||
    24 || log_file  || If ''log_type'' is ''file'', this should be a path to the log-file ||
    25 || log_level || Level of verbosity in log (CRITICAL, ERROR, WARN, INFO, DEBUG) ||
     13Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     14{{{
     15[inherit]
     16file = /path/to/global/trac.ini
     17}}}
     18Multiple files can be specified using a comma-separated list.
    2619
    27 See also: TracLogging
     20Note that you can also specify a global option file when creating a new project,  by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command.  If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those set in the global file.
    2821
    29 == [ticket] ==
    30 || default_version   || Default version for newly created tickets ||
    31 || default_severity  || Default severity for newly created tickets ||
    32 || default_priority  || Default priority for newly created tickets ||
    33 || default_milestone || Default milestone for newly created tickets ||
    34 || default_component || Default component for newly created tickets ||
     22There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there.
    3523
    36 See also: TracTicketsCustomFields
     24Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation).
    3725
    38 == [attachment] ==
    39 || max_size || Maximum allowed file size for ticket and wiki attachments ||
     26== Reference for settings
    4027
    41 == [notification] ==
    42 || smtp_enabled   || Enable SMTP (email) notification (true, false) ||
    43 || smtp_server    || SMTP server to use for email notifications ||
    44 || smtp_from      || Sender address to use in notification emails ||
    45 || smtp_replyto   || Reply-To address to use in notification emails ||
    46 || smtp_always_cc || Email address(es) to always send notifications to ||
    47 || always_notify_reporter || Always send notifications to any address in the ''reporter'' field ||
     28This is a brief reference of available configuration options, and their default settings.
    4829
    49 See also: TracNotification
     30[[TracIni]]
    5031
    51 == [header_logo] ==
    52 || src    || URL to image to use as header logo ||
    53 || link   || Destination URL to link to from header logo ||
    54 || alt    || ''alt'' text for header logo ||
    55 || width  || Header logo width in pixels ||
    56 || height || Header logo height in pixels ||
     32== Reference for special sections
     33[[PageOutline(3,,inline)]]
    5734
    58 == [mimeviewer] ==
    59 || enscript_path || Path to Enscript program ||
     35=== [components] === #components-section
     36This 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.
    6037
    61 == [timeline] ==
    62 || changeset_show_files || Number of files to show (-1 for unlimited, 0 to disable) ||
     38The 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.
    6339
    64 == [diff] ==
    65 || tab_width || Displayed tab width in changeset diffs ||
     40Consider the following configuration snippet:
     41{{{
     42[components]
     43trac.ticket.report.ReportModule = disabled
     44webadmin.* = enabled
     45}}}
    6646
    67 [[BR]]
     47The first option tells Trac to disable the [wiki:TracReports 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.
     48
     49See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
     50
     51See also: TracPlugins
     52
     53=== [milestone-groups] === #milestone-groups-section
     54''(since 0.11)''
     55
     56As the workflow for tickets is now configurable, there can be many ticket states,
     57and simply displaying closed tickets vs. all the others is maybe not appropriate
     58in all cases. This section enables one to easily create ''groups'' of states
     59that will be shown in different colors in the milestone progress bar.
     60
     61Example configuration (the default only has closed and active):
     62{{{
     63closed = closed
     64# sequence number in the progress bar
     65closed.order = 0
     66# optional extra param for the query (two additional columns: created and modified and sort on created)
     67closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime
     68# indicates groups that count for overall completion percentage
     69closed.overall_completion = true
     70
     71new = new
     72new.order = 1
     73new.css_class = new
     74new.label = new
     75
     76# one catch-all group is allowed
     77active = *
     78active.order = 2
     79# CSS class for this interval
     80active.css_class = open
     81# Displayed label for this group
     82active.label = in progress
     83}}}
     84
     85The definition consists in a comma-separated list of accepted status.
     86Also, '*' means any status and could be used to associate all remaining
     87states to one catch-all group.
     88
     89The CSS class can be one of: new (yellow), open (no color) or
     90closed (green). New styles can easily be added using the following
     91selector:  `table.progress td.<class>`
     92
     93=== [repositories] === #repositories-section
     94
     95(''since 0.12'' multirepos)
     96
     97One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini.
     98
     99This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation.
     100
     101See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives.
     102
     103=== [svn:externals] === #svn:externals-section
     104''(since 0.11)''
     105
     106The TracBrowser for Subversion can interpret the `svn:externals` property of folders.
     107By default, it only turns the URLs into links as Trac can't browse remote repositories.
     108
     109However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL.
     110
     111This mapping is done in the `[svn:externals]` section of the TracIni
     112
     113Example:
     114{{{
     115[svn:externals]
     1161 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev
     1172 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev
     1183 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
     1194 = svn://anotherserver.com/tools_repository  http://ourserver/tracs/tools/browser/$path?rev=$rev
     120}}}
     121With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` external will be mapped to `http://ourserver/tracs/tools/browser/tags/1.1/tools?rev=` (and `rev` will be set to the appropriate revision number if the external additionally specifies a revision, see the [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details).
     122
     123Note 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.
     124
     125Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported.
     126
     127=== [ticket-custom] === #ticket-custom-section
     128
     129In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     130
     131=== [ticket-workflow] === #ticket-workflow-section
     132''(since 0.11)''
     133
     134The workflow for tickets is controlled by plugins.
     135By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     136That component allows the workflow to be configured via this section in the trac.ini file.
     137See TracWorkflow for more details.
     138
    68139----
    69 See also: TracGuide, TracAdmin
     140See also: TracGuide, TracAdmin, TracEnvironment