Changes between Version 4 and Version 5 of TracIni

07/23/11 10:54:29 (6 years ago)



  • TracIni

    v4 v5  
    11= The Trac Configuration File = 
    4 Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. 
     5Trac 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. 
     7The `trac.ini` configuration file should be writable by the web server, as Trac currently relies on the possibility to trigger a complete environment reload to flush its caches. 
    69== Global Configuration == 
    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. 
     11In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or /etc/trac/trac.ini, depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.  Literally, when you're upgrading to 0.11, you have to add an `[inherit]` section to your project's `trac.ini` file. Additionally, you have to move your customized templates and common images from `$prefix/share/trac/...` to the new location. 
    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/` which gets created when Trac is installed.  
     13Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows: 
     16file = /path/to/global/trac.ini 
     18Multiple files can be specified using a comma-separated list. 
    12 == Reference == 
     20Note that you can also specify a global option file when creating a new project,  by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command.  If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those set in the global file. 
    14 This is a brief reference of available configuration options. 
     22There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there. 
    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.''' 
     24Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there, notably if you override a default template be sure to refresh your modifications when you upgrade to a new version of Trac (the preferred way to perform TracInterfaceCustomization being still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation). 
     26== Reference for settings 
    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 [ authorization (authz) file]. || 
    29 || `authz_module_name` || The module prefix used in the `authz_file` (See [ 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 || 
     28This is a brief reference of available configuration options, and their default settings. 
    38 == [diff] == 
    39 || `tab_width` || ''deprecated since 0.9 in favor of the `tab_width` option in the `[mimeviewer]` section'' || 
    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) || 
    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. 
     32== Reference for special sections 
    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 
    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). || 
    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'') || 
    84 See also: TracNotification 
    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'') || 
    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] || 
    101 == [ticket-custom] == 
    102 Creates [wiki:TracTicketsCustomFields user-defined ticket fields]. 
    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?'')|| 
    109 == [browser] == 
    110 || `hide_properties` || List of subversion properties to hide from the repository browser (''since 0.9'') || 
    112 == [wiki] == 
    113 || `ignore_missing_pages` || enable/disable highlighting CamelCase links to missing pages (''since 0.9'') || 
    115 == [components] == 
    116 (''since 0.9'') 
     35=== [components] === #components-section 
    11836This 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. 
    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].) 
     47The 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. 
     49See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].) 
    13151See also: TracPlugins 
    133 == [changeset] == 
    134 (''since 0.10'') 
     53=== [milestone-groups] === #milestone-groups-section 
     54''(since 0.11)'' 
    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. || 
     56As the workflow for tickets is now configurable, there can be many ticket states, 
     57and simply displaying closed tickets vs. all the others is maybe not appropriate  
     58in all cases. This section enables one to easily create ''groups'' of states  
     59that will be shown in different colors in the milestone progress bar. 
     61Example configuration (the default only has closed and active): 
     63closed = closed 
     64# sequence number in the progress bar 
     65closed.order = 0 
     66# optional extra param for the query (two additional columns: created and modified and sort on created) 
     67closed.query_args = group=resolution,order=time,col=id,col=summary,col=owner,col=type,col=priority,col=component,col=severity,col=time,col=changetime 
     68# indicates groups that count for overall completion percentage 
     69closed.overall_completion = true 
     71new = new 
     72new.order = 1 
     73new.css_class = new 
     74new.label = new 
     76# one catch-all group is allowed 
     77active = * 
     78active.order = 2 
     79# CSS class for this interval 
     80active.css_class = open 
     81# Displayed label for this group 
     82active.label = in progress 
     85The definition consists in a comma-separated list of accepted status. 
     86Also, '*' means any status and could be used to associate all remaining 
     87states to one catch-all group. 
     89The CSS class can be one of: new (yellow), open (no color) or 
     90closed (green). New styles can easily be added using the following 
     91selector:  `table.progress td.<class>` 
     93=== [repositories] === #repositories-section 
     95(''since 0.12'' multirepos) 
     97One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. 
     99This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. 
     101See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. 
     103=== [svn:externals] === #svn:externals-section 
     104''(since 0.11)'' 
     106The TracBrowser for Subversion can interpret the `svn:externals` property of folders. 
     107By default, it only turns the URLs into links as Trac can't browse remote repositories. 
     109However, if you have another Trac instance (or an other repository browser like [ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL. 
     111This mapping is done in the `[svn:externals]` section of the TracIni 
     1161 = svn://server/repos1                       http://trac/proj1/browser/$path?rev=$rev 
     1172 = svn://server/repos2                       http://trac/proj2/browser/$path?rev=$rev 
     1183 =       http://ourserver/viewvc/svn/$path/?pathrev=25914 
     1194 = svn://  http://ourserver/tracs/tools/browser/$path?rev=$rev 
     121With the above, the `svn://` external will be mapped to `http://ourserver/tracs/tools/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 [ SVN Book on externals] for more details). 
     123Note 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. 
     125Finally, the relative URLs introduced in [ Subversion 1.5] are not yet supported. 
     127=== [ticket-custom] === #ticket-custom-section 
     129In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. 
     131=== [ticket-workflow] === #ticket-workflow-section 
     132''(since 0.11)'' 
     134The workflow for tickets is controlled by plugins.  
     135By default, there's only a `ConfigurableTicketWorkflow` component in charge.  
     136That component allows the workflow to be configured via this section in the trac.ini file. 
     137See TracWorkflow for more details.