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 || |
| 24 | Note 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). |
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 | | |
| 35 | === [components] === #components-section |
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.'' |
| 53 | === [milestone-groups] === #milestone-groups-section |
| 54 | ''(since 0.11)'' |
| 55 | |
| 56 | As the workflow for tickets is now configurable, there can be many ticket states, |
| 57 | and simply displaying closed tickets vs. all the others is maybe not appropriate |
| 58 | in all cases. This section enables one to easily create ''groups'' of states |
| 59 | that will be shown in different colors in the milestone progress bar. |
| 60 | |
| 61 | Example configuration (the default only has closed and active): |
| 62 | {{{ |
| 63 | closed = closed |
| 64 | # sequence number in the progress bar |
| 65 | closed.order = 0 |
| 66 | # optional extra param for the query (two additional columns: created and modified and sort on created) |
| 67 | closed.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 |
| 69 | closed.overall_completion = true |
| 70 | |
| 71 | new = new |
| 72 | new.order = 1 |
| 73 | new.css_class = new |
| 74 | new.label = new |
| 75 | |
| 76 | # one catch-all group is allowed |
| 77 | active = * |
| 78 | active.order = 2 |
| 79 | # CSS class for this interval |
| 80 | active.css_class = open |
| 81 | # Displayed label for this group |
| 82 | active.label = in progress |
| 83 | }}} |
| 84 | |
| 85 | The definition consists in a comma-separated list of accepted status. |
| 86 | Also, '*' means any status and could be used to associate all remaining |
| 87 | states to one catch-all group. |
| 88 | |
| 89 | The CSS class can be one of: new (yellow), open (no color) or |
| 90 | closed (green). New styles can easily be added using the following |
| 91 | selector: `table.progress td.<class>` |
| 92 | |
| 93 | === [repositories] === #repositories-section |
| 94 | |
| 95 | (''since 0.12'' multirepos) |
| 96 | |
| 97 | One of the alternatives for registering new repositories is to populate the `[repositories]` section of the trac.ini. |
| 98 | |
| 99 | This is especially suited for setting up convenience aliases, short-lived repositories, or during the initial phases of an installation. |
| 100 | |
| 101 | See [TracRepositoryAdmin#Intrac.ini TracRepositoryAdmin] for details about the format adopted for this section and the rest of that page for the other alternatives. |
| 102 | |
| 103 | === [svn:externals] === #svn:externals-section |
| 104 | ''(since 0.11)'' |
| 105 | |
| 106 | The TracBrowser for Subversion can interpret the `svn:externals` property of folders. |
| 107 | By default, it only turns the URLs into links as Trac can't browse remote repositories. |
| 108 | |
| 109 | However, if you have another Trac instance (or an other repository browser like [http://www.viewvc.org/ ViewVC]) configured to browse the target repository, then you can instruct Trac which other repository browser to use for which external URL. |
| 110 | |
| 111 | This mapping is done in the `[svn:externals]` section of the TracIni |
| 112 | |
| 113 | Example: |
| 114 | {{{ |
| 115 | [svn:externals] |
| 116 | 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev |
| 117 | 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev |
| 118 | 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 |
| 119 | 4 = svn://anotherserver.com/tools_repository http://ourserver/tracs/tools/browser/$path?rev=$rev |
| 120 | }}} |
| 121 | With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` 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 [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details). |
| 122 | |
| 123 | Note 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. |
| 124 | |
| 125 | Finally, the relative URLs introduced in [http://subversion.tigris.org/svn_1.5_releasenotes.html#externals Subversion 1.5] are not yet supported. |
| 126 | |
| 127 | === [ticket-custom] === #ticket-custom-section |
| 128 | |
| 129 | In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details. |
| 130 | |
| 131 | === [ticket-workflow] === #ticket-workflow-section |
| 132 | ''(since 0.11)'' |
| 133 | |
| 134 | The workflow for tickets is controlled by plugins. |
| 135 | By default, there's only a `ConfigurableTicketWorkflow` component in charge. |
| 136 | That component allows the workflow to be configured via this section in the trac.ini file. |
| 137 | See TracWorkflow for more details. |