Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
10/02/09 15:20:53 (11 years ago)
Author:
trac
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v2  
    11= The Trac Configuration File = 
     2 
    23[[TracGuideToc]] 
    3  
    4 Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. 
    54 
    65== Global Configuration == 
    76 
    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. 
     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. 
    98 
    10 The global configuration is by default located 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.  
     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 
    1121 
    1222== Reference == 
     
    1424This is a brief reference of available configuration options. 
    1525 
    16 '''Note: since [milestone:0.10], the TracIni reference is auto-generated 
    17 from the source code, using the TracIniMacro. But in this page, we will keep 
    18 the old ''wiki'' content, so that documentation fixes could be easily  
    19 contributed by the community, as before.''' 
     26[[TracIni()]] 
    2027 
    2128 
    22 == [trac] == 
    23 || `base_url` || Base URL of the Trac deployment.[[BR]]In most configurations, Trac will automatically reconstruct the URL that is used to access it automatically. However, in more complex setups, usually involving running Trac behind a HTTP proxy, you may need to use this option to force Trac to use the correct URL. || 
    24 || `database`        || [wiki:TracEnvironment#DatabaseConnectionStrings Database connection string] for this project || 
    25 || `default_charset` || Charset used in text files in the subversion repository (default is `iso-8859-15`) || 
    26 || `default_handler` || Name of the component that handles requests to the base URL (default is `WikiModule`. Some other options are `TimelineModule`, `RoadmapModule`, `BrowserModule`, `QueryModule`, ` ReportModule` and `NewticketModule`) (''since 0.9'') || 
    27 || `repository_dir`  || Path to local Subversion repository || 
    28 || `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]. || 
    29 || `authz_module_name` || The module prefix used in the `authz_file` (See [http://projects.edgewall.com/trac/wiki/FineGrainedPermissions FineGrainedPermissions])|| 
    30 || `check_auth_ip` || Whether the IP address of the user should be checked for authentication (true, false) (''since 0.9'') || 
    31 || `ignore_auth_case` || Whether case should be ignored for login names (true, false) (''since 0.9'') || 
    32 || `templates_dir`   || Path to the !ClearSilver templates || 
    33 || `htdocs_location`   || Path to the static resources (default is `/trac`)|| 
    34 || `permissions_store` || || 
    35 || `metanav` || The order of the sections displayed in the meta nav bar, adding or removing section in this list is done with [wiki:TracPermissions trac's permission system] || 
    36 || `mainnav` || The order of the sections displayed in the main nav bar || 
    37  
    38 == [diff] == 
    39 || `tab_width` || ''deprecated since 0.9 in favor of the `tab_width` option in the `[mimeviewer]` section'' || 
    40   
    41 == [project] == 
    42 || `name`   || Project name || 
    43 || `descr`  || Short project description || 
    44 || `url`    || URL to the main project website || 
    45 || `icon`   || URL to icon file to use as shortcut icon (favicon) || 
    46 || `footer` || Page footer text (right-aligned) || 
    47  
    48 == [header_logo] == 
    49 || `src`    || URL to image to use as header logo || 
    50 || `link`   || Destination URL to link to from header logo || 
    51 || `alt`    || ''alt'' text for header logo || 
    52 || `width`  || Header logo width in pixels || 
    53 || `height` || Header logo height in pixels || 
    54 See also: TracInterfaceCustomization. 
    55  
    56 == [logging] == 
    57 || `log_type`  || Logging facility to use. (none, file, stderr, syslog, winlog) || 
    58 || `log_file`  || If ''log_type'' is ''file'', this should be a path to the log-file || 
    59 || `log_level` || Level of verbosity in log (CRITICAL, ERROR, WARN, INFO, DEBUG) || 
    60 See also: TracLogging 
    61  
    62 == [attachment] == 
    63 || `max_size` || Maximum allowed file size for ticket and wiki attachments || 
    64 || `render_unsafe_content` || Whether non-binary attachments should be rendered in the browser, or only made downloadable. Pretty much any text file may be interpreted as HTML by the browser, which allows a malicious user to attach a file containing cross-site scripting attacks. For public sites where anonymous users can create attachments, it is recommended to leave this option off (which is the default). || 
    65  
    66 == [notification] == 
    67 || `smtp_enabled`   || Enable SMTP (email) notification (true, false) || 
    68 || `smtp_server`    || SMTP server hostname to use for email notifications (default: `localhost`) || 
    69 || `smtp_port`      || SMTP server port to use for email notifications (default: `25`)|| 
    70 || `smtp_user`      || Username for SMTP server (''since 0.9'') || 
    71 || `smtp_password`  || Password for SMTP server (''since 0.9'') || 
    72 || `smtp_from`      || Sender address to use in notification emails || 
    73 || `smtp_replyto`   || Reply-To address to use in notification emails || 
    74 || `smtp_default_domain` || Append the specified domain to addresses that do not contain one (''since 0.10'') || 
    75 || `smtp_always_cc` || Email address(es) to always send notifications to || 
    76 || `smtp_always_bcc` || Email address(es) to always send notifications to, but keep addresses not visible from other recipients (''since 0.10'') || 
    77 || `use_public_cc` || Recipients can see email addresses of other CC'ed recipients (''since 0.10'') || 
    78 || `use_short_addr` || Send username/login as is to the SMTP server (''since 0.10'') || 
    79 || `always_notify_reporter` || Always send notifications to any address in the ''reporter'' field || 
    80 || `always_notify_owner` || Always send notifications to the ticket owner (''since 0.9'') || 
    81 || `always_notify_updater` || The updater of a ticket receives a notification of his own changes (''since 0.10'') || 
    82 || `mime_encoding` || Specify the MIME encoding scheme for emails (''since 0.10'') || 
    83  
    84 See also: TracNotification 
    85  
    86 == [mimeviewer] == 
    87 || `enscript_path` || Path to the Enscript program || 
    88 || `php_path` || Path to the PHP program || 
    89 || `max_preview_size` || Maximum file size for HTML preview (''since 0.9'') || 
    90 || `tab_width` || Displayed tab width in file preview (''since 0.9'') || 
    91  
    92 == [ticket] == 
    93 || `default_version`   || Default version for newly created tickets || 
    94 || `default_severity`  || Default severity for newly created tickets || 
    95 || `default_priority`  || Default priority for newly created tickets || 
    96 || `default_milestone` || Default milestone for newly created tickets || 
    97 || `default_component` || Default component for newly created tickets || 
    98 || `default_type`      || Default type for newly created tickets || 
    99 || `restrict_owner`    || Make the owner field of tickets use a drop-down menu (''since 0.9''). See [wiki:TracTickets#Assign-toasDrop-DownList AssignToAsDropDownList] || 
    100  
    101 == [ticket-custom] == 
    102 Creates [wiki:TracTicketsCustomFields user-defined ticket fields]. 
    103  
    104 == [timeline] == 
    105 || `default_daysback` || Default "depth" of the Timeline, in days (''since 0.9'') || 
    106 || `changeset_show_files` || Number of files to show (-1 for unlimited, 0 to disable) || 
    107 || `ticket_show_details` || Enable the display of all ticket changes in the timeline (''since 0.9?'')|| 
    108  
    109 == [browser] == 
    110 || `hide_properties` || List of subversion properties to hide from the repository browser (''since 0.9'') || 
    111  
    112 == [wiki] == 
    113 || `ignore_missing_pages` || enable/disable highlighting CamelCase links to missing pages (''since 0.9'') || 
    114  
    115 == [components] == 
    116 (''since 0.9'') 
    117  
     29== [components] == #components-section 
    11830This 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. 
    11931 
     
    12739}}} 
    12840 
    129 The 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. To get a list of active components for your installation, see the ''Plugins'' page on ''About Trac'' (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
     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. 
     42 
     43See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    13044 
    13145See also: TracPlugins 
    13246 
    133 == [changeset] == 
    134 (''since 0.10'') 
     47== [ticket-custom] == #ticket-custom-section 
    13548 
    136 || `max_diff_bytes` || A limit for the sum of the size of all old ''and'' new files involved in a changeset. [[br]] Note that when requesting a diff precisely on a very big file (e.g. by the use of the ''Last Change'' link), the size limit will ''not'' be taken into account and the diffs will always be computed. || 
     49In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     50 
     51== [ticket-workflow] == #ticket-workflow-section 
     52''(since 0.11)'' 
     53 
     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. 
     58 
     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. 
    137107 
    138108----