Changes between Version 4 and Version 5 of TracIni


Ignore:
Timestamp:
Mar 27, 2008, 7:31:47 AM (11 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v4 v5  
    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`.  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.
    55
    66== Global Configuration ==
    77
    8 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.
     8In previous versions, 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.
    99
    10 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.
     10Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
     11{{{
     12[inherit]
     13file = /usr/share/trac/conf/trac.ini
     14}}}
    1115
    1216== Reference ==
     
    1418This is a brief reference of available configuration options.
    1519
    16 == [trac] ==
    17 || `database`        || [wiki:TracEnvironment#DatabaseConnectionStrings Database connection string] for this project ||
    18 || `default_charset` || Charset used in text files in the subversion repository (default is `iso-8859-15`) ||
    19 || `default_handler` || Name of the component that handles requests to the base URL (default is `WikiHandler`) (''since 0.9'') ||
    20 || `repository_dir`  || Path to local Subversion repository ||
    21 || `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]. ||
    22 || `authz_module_name` || The module prefix used in the `authz_file` (See FineGrainedPermissions)||
    23 || `check_auth_ip` || Whether the IP address of the user should be checked for authentication (true, false) (''since 0.9'') ||
    24 || `ignore_auth_case` || Whether case should be ignored for login names (true, false) (''since 0.9'') ||
    25 || `templates_dir`   || Path to the !ClearSilver templates ||
     20[[TracIni]]
    2621
    27 == [project] ==
    28 || `name`   || Project name ||
    29 || `descr`  || Short project description ||
    30 || `url`    || URL to the main project website ||
    31 || `icon`   || URL to icon file to use as shortcut icon (favicon) ||
    32 || `footer` || Page footer text (right-aligned) ||
    33 
    34 == [header_logo] ==
    35 || `src`    || URL to image to use as header logo ||
    36 || `link`   || Destination URL to link to from header logo ||
    37 || `alt`    || ''alt'' text for header logo ||
    38 || `width`  || Header logo width in pixels ||
    39 || `height` || Header logo height in pixels ||
    40 See also: TracInterfaceCustomization.
    41 
    42 == [logging] ==
    43 || `log_type`  || Logging facility to use. (none, file, stderr, syslog, winlog) ||
    44 || `log_file`  || If ''log_type'' is ''file'', this should be a path to the log-file ||
    45 || `log_level` || Level of verbosity in log (CRITICAL, ERROR, WARN, INFO, DEBUG) ||
    46 See also: TracLogging
    47 
    48 == [attachment] ==
    49 || `max_size` || Maximum allowed file size for ticket and wiki attachments ||
    50 
    51 == [notification] ==
    52 || `smtp_enabled`   || Enable SMTP (email) notification (true, false) ||
    53 || `smtp_server`    || SMTP server to use for email notifications ||
    54 || `smtp_user`      || Username for SMTP server (''since 0.9'') ||
    55 || `smtp_password`  || Password for SMTP server (''since 0.9'') ||
    56 || `smtp_from`      || Sender address to use in notification emails ||
    57 || `smtp_replyto`   || Reply-To address to use in notification emails ||
    58 || `smtp_always_cc` || Email address(es) to always send notifications to ||
    59 || `always_notify_reporter` || Always send notifications to any address in the ''reporter'' field ||
    60 || `always_notify_owner` || Always send notifications to the ticket owner (''since 0.9'') ||
    61 See also: TracNotification
    62 
    63 == [mimeviewer] ==
    64 || `enscript_path` || Path to the Enscript program ||
    65 || `php_path` || Path to the PHP program ||
    66 || `max_preview_size` || Maximum file size for HTML preview (''since 0.9'') ||
    67 || `tab_width` || Displayed tab width in file preview (''since 0.9'') ||
    68 
    69 == [ticket] ==
    70 || `default_version`   || Default version for newly created tickets ||
    71 || `default_severity`  || Default severity for newly created tickets ||
    72 || `default_priority`  || Default priority for newly created tickets ||
    73 || `default_milestone` || Default milestone for newly created tickets ||
    74 || `default_component` || Default component for newly created tickets ||
    75 || `restrict_owner`    || Make the owner field of tickets use a drop-down menu (''since 0.9'') ||
    76 
    77 == [ticket-custom] ==
    78 Creates [wiki:TracTicketsCustomFields user-defined ticket fields].
    79 
    80 == [timeline] ==
    81 || `default_daysback` || Default "depth" of the Timeline, in days (''since 0.9'') ||
    82 || `changeset_show_files` || Number of files to show (-1 for unlimited, 0 to disable) ||
    83 || `ticket_show_details` || Enable the display of all ticket changes in the timeline ||
    84 
    85 == [browser] ==
    86 || `hide_properties` || List of subversion properties to hide from the repository browser (''since 0.9'') ||
    87 
    88 == [wiki] ==
    89 || `ignore_missing_pages` || enable/disable highlighting CamelCase links to missing pages (''since 0.9'') ||
    90 
    91 == [components] ==
    92 (''since 0.9'')
    93 
     22== [components] == #components-section
    9423This 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.
    9524
     
    10938See also: TracPlugins
    11039
    111   ''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.''
     40== [ticket-custom] == #ticket-custom-section
     41
     42In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.
     43
     44== [ticket-workflow] == #ticket-workflow-section
     45''(since 0.11)''
     46
     47The workflow for tickets is controlled by plugins.
     48By default, there's only a `ConfigurableTicketWorkflow` component in charge.
     49That component allows the workflow to be configured via this section in the trac.ini file.
     50See TracWorkflow for more details.
     51
     52== [milestone-groups] == #milestone-groups-section
     53''(since 0.11)''
     54
     55As the workflow for tickets is now configurable, there can be many ticket states,
     56and simply displaying closed tickets vs. all the others is maybe not appropriate
     57in all cases. This section enables one to easily create ''groups'' of states
     58that will be shown in different colors in the milestone progress bar.
     59
     60Example configuration (which is also the default):
     61{{{
     62closed = closed
     63closed.order = 0                     # sequence number in the progress bar
     64closed.query_args = group=resolution # optional extra param for the query
     65closed.overall_completion = true     # count for overall completion
     66
     67active = *                           # one catch-all group is allowed
     68active.order = 1
     69active.css_class = open              # CSS class for this interval
     70}}}
     71
     72The definition consists in a comma-separated list of accepted status.
     73Also, '*' means any status and could be used to associate all remaining
     74states to one catch-all group.
     75
     76The CSS class can be one of: new (yellow), open (no color) or
     77closed (green). New styles can easily be added using the following
     78selector:  `table.progress td.<class>`
     79
     80== [svn:externals] == #svn:externals-section
     81''(since 0.11)''
     82
     83The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
     84However, 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.
     85
     86This mapping is done in the `[svn:externals]` section of the TracIni
     87
     88Example:
     89{{{
     90[svn:externals]
     91http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
     92svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
     93}}}
     94With 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).
     95
    11296
    11397----