Changes between Version 2 and Version 3 of TracIni


Ignore:
Timestamp:
Jan 25, 2009 10:55:12 AM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v2 v3  
    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}}}. 
     5== Global Configuration == 
     6 
     7In 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. 
     8 
     9Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
     10{{{ 
     11[inherit] 
     12file = /usr/share/trac/conf/trac.ini 
     13}}} 
     14 
     15Note that you can also specify a global option file when creating a new project,  by adding the option 
     16`--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command. 
     17If you would not do this but nevertheless intend to use a global option file with your new environment,  
     18you would have to go through the newly generated conf/trac.ini file and delete the entries that would 
     19otherwise override those set in the global file. 
     20 
     21 
     22== Reference == 
    523 
    624This is a brief reference of available configuration options. 
    725 
    8 == [trac] == 
    9 || `database`        || [wiki:TracEnvironment#DatabaseConnectionStrings Database connection string] for this project || 
    10 || `default_charset` || Charset used in text files in the subversion repository (default is `iso-8859-15`) || 
    11 || `default_handler` || Name of the component that handles requests to the base URL (default is `WikiHandler`) (''since 0.9'') || 
    12 || `repository_dir`  || Path to local Subversion repository || 
    13 || `authz_file`      || Path to Subversion [http://svnbook.red-bean.com/en/1.1/ch06s04.html#svn-ch-6-sect-4.4.2 authorization (authz) file]. || 
    14 || `check_auth_ip` || Whether the IP address of the user should be checked for authentication (true, false) (''since 0.9'') || 
    15 || `ignore_auth_case` || Whether case should be ignored for login names (true, false) (''since 0.9'') || 
    16 || `templates_dir`   || Path to the !ClearSilver templates || 
     26[[TracIni()]] 
    1727 
    18 == [project] == 
    19 || `name`   || Project name || 
    20 || `descr`  || Short project description || 
    21 || `url`    || URL to the main project website || 
    22 || `icon`   || URL to icon file to use as shortcut icon (favicon) || 
    23 || `footer` || Page footer text (right-aligned) || 
    2428 
    25 == [header_logo] == 
    26 || `src`    || URL to image to use as header logo || 
    27 || `link`   || Destination URL to link to from header logo || 
    28 || `alt`    || ''alt'' text for header logo || 
    29 || `width`  || Header logo width in pixels || 
    30 || `height` || Header logo height in pixels || 
     29== [components] == #components-section 
     30This 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. 
    3131 
    32 == [logging] == 
    33 || `log_type`  || Logging facility to use. (none, file, stderr, syslog, winlog) || 
    34 || `log_file`  || If ''log_type'' is ''file'', this should be a path to the log-file || 
    35 || `log_level` || Level of verbosity in log (CRITICAL, ERROR, WARN, INFO, DEBUG) || 
    36 See also: TracLogging 
     32The 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. 
    3733 
    38 == [attachment] == 
    39 || `max_size` || Maximum allowed file size for ticket and wiki attachments || 
     34Consider the following configuration snippet: 
     35{{{ 
     36[components] 
     37trac.ticket.report.ReportModule = disabled 
     38webadmin.* = enabled 
     39}}} 
    4040 
    41 == [notification] == 
    42 || `smtp_enabled`   || Enable SMTP (email) notification (true, false) || 
    43 || `smtp_server`    || SMTP server to use for email notifications || 
    44 || `smtp_user`      || Username for SMTP server (''since 0.9'') || 
    45 || `smtp_password`  || Password for SMTP server (''since 0.9'') || 
    46 || `smtp_from`      || Sender address to use in notification emails || 
    47 || `smtp_replyto`   || Reply-To address to use in notification emails || 
    48 || `smtp_always_cc` || Email address(es) to always send notifications to || 
    49 || `always_notify_reporter` || Always send notifications to any address in the ''reporter'' field || 
    50 || `always_notify_owner` || Always send notifications to the ticket owner (''since 0.9'') || 
    51 See also: TracNotification 
     41The 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. 
    5242 
    53 == [mimeviewer] == 
    54 || `enscript_path` || Path to the Enscript program || 
    55 || `php_path` || Path to the PHP program || 
    56 || `max_preview_size` || Maximum file size for HTML preview (''since 0.9'') || 
    57 || `tab_width` || Displayed tab width in file preview (''since 0.9'') || 
     43See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    5844 
    59 == [ticket] == 
    60 || `default_version`   || Default version for newly created tickets || 
    61 || `default_severity`  || Default severity for newly created tickets || 
    62 || `default_priority`  || Default priority for newly created tickets || 
    63 || `default_milestone` || Default milestone for newly created tickets || 
    64 || `default_component` || Default component for newly created tickets || 
    65 || `restrict_owner`    || Make the owner field of tickets use a drop-down menu (''since 0.9'') || 
     45See also: TracPlugins 
    6646 
    67 == [ticket-custom] == 
    68 Creates user-defined ticket fields. 
    69 See TracTicketsCustomFields. 
     47== [ticket-custom] == #ticket-custom-section 
    7048 
    71 == [timeline] == 
    72 || `changeset_show_files` || Number of files to show (-1 for unlimited, 0 to disable) || 
    73 || `default_daysback` || Default "depth" of the Timeline, in days (''since 0.9'') || 
     49In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
    7450 
    75 == [browser] == 
    76 || `hide_properties` || List of subversion properties to hide from the repository browser (''since 0.9'') || 
     51== [ticket-workflow] == #ticket-workflow-section 
     52''(since 0.11)'' 
    7753 
    78 == [wiki] == 
    79 || `ignore_missing_pages` || enable/disable highlighting CamelCase links to missing pages (''since 0.9'') || 
     54The workflow for tickets is controlled by plugins.  
     55By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     56That component allows the workflow to be configured via this section in the trac.ini file. 
     57See TracWorkflow for more details. 
    8058 
    81 == [disabled_components] == 
    82 You can disable any Trac component by listing its name in this section and assigning a truth value (e.g. ''yes''). See the ''Plugins'' page on ''About Trac'' to get the list of active components. 
    83 (''since 0.9'') 
     59== [milestone-groups] == #milestone-groups-section 
     60''(since 0.11)'' 
     61 
     62As the workflow for tickets is now configurable, there can be many ticket states, 
     63and simply displaying closed tickets vs. all the others is maybe not appropriate  
     64in all cases. This section enables one to easily create ''groups'' of states  
     65that will be shown in different colors in the milestone progress bar. 
     66 
     67Example configuration (which is also the default): 
     68{{{ 
     69closed = closed 
     70closed.order = 0                     # sequence number in the progress bar 
     71closed.query_args = group=resolution # optional extra param for the query 
     72closed.overall_completion = true     # count for overall completion 
     73 
     74active = *                           # one catch-all group is allowed 
     75active.order = 1 
     76active.css_class = open              # CSS class for this interval 
     77active.label = in progress           # Displayed label for this group 
     78}}} 
     79 
     80The definition consists in a comma-separated list of accepted status. 
     81Also, '*' means any status and could be used to associate all remaining 
     82states to one catch-all group. 
     83 
     84The CSS class can be one of: new (yellow), open (no color) or 
     85closed (green). New styles can easily be added using the following 
     86selector:  `table.progress td.<class>` 
     87 
     88== [svn:externals] == #svn:externals-section 
     89''(since 0.11)'' 
     90 
     91The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. 
     92However, if those externals are ''not'' using the `http:` protocol, or if a link to a different repository browser (such another Trac or [http://www.viewvc.org/ ViewVC]) is desired, then Trac needs to be able to map an external prefix to this other URL. 
     93 
     94This mapping is done in the `[svn:externals]` section of the TracIni 
     95 
     96Example: 
     97{{{ 
     98[svn:externals] 
     991 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev 
     1002 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev 
     1013 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914 
     1024 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev 
     103}}} 
     104With 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 [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details). 
     105 
     106Note 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. 
    84107 
    85108----