Changes between Version 1 and Version 2 of TracIni

Show
Ignore:
Author:
trac (IP: 127.0.0.1)
Timestamp:
04/11/07 02:52:20 (3 months ago)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracIni

    v1 v2  
    1 = trac.ini Reference = 
     1= The Trac Configuration File = 
    22[[TracGuideToc]] 
    33 
    4 Trac configuration is done by editing the ''trac.ini'' config file, located in {{{<projectenv>/conf/trac.ini}}}. 
     4Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. 
     5 
     6== Global Configuration == 
     7 
     8Since 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. 
     9 
     10The 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.  
     11 
     12== Reference == 
    513 
    614This is a brief reference of available configuration options. 
    715 
    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) || 
     16[[TracIni]] 
    1417 
    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 || 
     18== [components] == 
     19(''since 0.9'') 
    2120 
    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) || 
     21This 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. 
    2622 
    27 See also: TracLogging 
     23The 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. 
    2824 
    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 || 
     25Consider the following configuration snippet: 
     26{{{ 
     27[components] 
     28trac.ticket.report.ReportModule = disabled 
     29webadmin.* = enabled 
     30}}} 
    3531 
    36 See also: TracTicketsCustomFields 
     32The 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. 
    3733 
    38 == [attachment] == 
    39 || max_size || Maximum allowed file size for ticket and wiki attachments || 
     34See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    4035 
    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 || 
     36See also: TracPlugins 
    4837 
    49 See also: TracNotification 
     38  ''Note that prior to Trac r2335 (that applies to 0.9b1 and 0.9b2), you would use a `[disabled_components]` section instead. See a [http://projects.edgewall.com/trac/wiki/TracIni?version=42 previous version] of this page for the details.'' 
    5039 
    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 || 
     40---- 
     41See also: TracGuide, TracAdmin, TracEnvironment 
    5742 
    58 == [mimeviewer] == 
    59 || enscript_path || Path to Enscript program || 
    60  
    61 == [timeline] == 
    62 || changeset_show_files || Number of files to show (-1 for unlimited, 0 to disable) || 
    63  
    64 == [diff] == 
    65 || tab_width || Displayed tab width in changeset diffs || 
    66  
    67 [[BR]] 
    68 ---- 
    69 See also: TracGuide, TracAdmin