Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Jan 30, 2006, 11:09:12 PM (16 years ago)
Author:
trac
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.
     
    1220|| `repository_dir`  || Path to local Subversion repository ||
    1321|| `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)||
    1423|| `check_auth_ip` || Whether the IP address of the user should be checked for authentication (true, false) (''since 0.9'') ||
    1524|| `ignore_auth_case` || Whether case should be ignored for login names (true, false) (''since 0.9'') ||
     
    2938|| `width`  || Header logo width in pixels ||
    3039|| `height` || Header logo height in pixels ||
     40See also: TracInterfaceCustomization.
    3141
    3242== [logging] ==
     
    6676
    6777== [ticket-custom] ==
    68 Creates user-defined ticket fields.
    69 See TracTicketsCustomFields.
     78Creates [wiki:TracTicketsCustomFields user-defined ticket fields].
    7079
    7180== [timeline] ==
     81|| `default_daysback` || Default "depth" of the Timeline, in days (''since 0.9'') ||
    7282|| `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'') ||
     83|| `ticket_show_details` || Enable the display of all ticket changes in the timeline ||
    7484
    7585== [browser] ==
     
    7989|| `ignore_missing_pages` || enable/disable highlighting CamelCase links to missing pages (''since 0.9'') ||
    8090
    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.
     91== [components] ==
    8392(''since 0.9'')
     93
     94This 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.
     95
     96The 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.
     97
     98Consider the following configuration snippet:
     99{{{
     100[components]
     101trac.ticket.report.ReportModule = disabled
     102webadmin.* = enabled
     103}}}
     104
     105The 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.
     106
     107See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)
     108
     109See also: TracPlugins
     110
     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.''
    84112
    85113----