| 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. |
| | 9 | Global 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] |
| | 12 | file = /usr/share/trac/conf/trac.ini |
| | 13 | }}} |
| | 14 | |
| | 15 | Note 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. |
| | 17 | If you would not do this but nevertheless intend to use a global option file with your new environment, |
| | 18 | you would have to go through the newly generated conf/trac.ini file and delete the entries that would |
| | 19 | otherwise override those set in the global file. |
| | 20 | |
| 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 || |
| | 26 | [[TracIni()]] |
| 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 | | == [darcs] == |
| 92 | | || `cachedir` || By default the darcs backend keeps a cache of the visited files at various revision inside the repository itself, in `_darcs/trac_cache`, that may be overridden by this option, setting it to the desired directory that needs to be writeable by the trac process. || |
| 93 | | || `command` || Name of the external darcs executable, default to `darcs`. This can be used to set up the environment as well, like in "`DARCS_DONT_ESCAPE_ANYTHING=1 /usr/local/bin/darcs`" || |
| 94 | | || `dont_escape_8bit` || This is a shortcut for "`command=DARCS_DONT_ESCAPE_8BIT=1 darcs`" (true, false). Default to false. || |
| 95 | | |
| 96 | | == [components] == |
| 97 | | (''since 0.9'') |
| 98 | | |
| | 29 | == [components] == #components-section |
| 116 | | ''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.'' |
| | 47 | == [ticket-custom] == #ticket-custom-section |
| | 48 | |
| | 49 | In 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 | |
| | 54 | The workflow for tickets is controlled by plugins. |
| | 55 | By default, there's only a `ConfigurableTicketWorkflow` component in charge. |
| | 56 | That component allows the workflow to be configured via this section in the trac.ini file. |
| | 57 | See TracWorkflow for more details. |
| | 58 | |
| | 59 | == [milestone-groups] == #milestone-groups-section |
| | 60 | ''(since 0.11)'' |
| | 61 | |
| | 62 | As the workflow for tickets is now configurable, there can be many ticket states, |
| | 63 | and simply displaying closed tickets vs. all the others is maybe not appropriate |
| | 64 | in all cases. This section enables one to easily create ''groups'' of states |
| | 65 | that will be shown in different colors in the milestone progress bar. |
| | 66 | |
| | 67 | Example configuration (which is also the default): |
| | 68 | {{{ |
| | 69 | closed = closed |
| | 70 | closed.order = 0 # sequence number in the progress bar |
| | 71 | closed.query_args = group=resolution # optional extra param for the query |
| | 72 | closed.overall_completion = true # count for overall completion |
| | 73 | |
| | 74 | active = * # one catch-all group is allowed |
| | 75 | active.order = 1 |
| | 76 | active.css_class = open # CSS class for this interval |
| | 77 | active.label = in progress # Displayed label for this group |
| | 78 | }}} |
| | 79 | |
| | 80 | The definition consists in a comma-separated list of accepted status. |
| | 81 | Also, '*' means any status and could be used to associate all remaining |
| | 82 | states to one catch-all group. |
| | 83 | |
| | 84 | The CSS class can be one of: new (yellow), open (no color) or |
| | 85 | closed (green). New styles can easily be added using the following |
| | 86 | selector: `table.progress td.<class>` |
| | 87 | |
| | 88 | == [svn:externals] == #svn:externals-section |
| | 89 | ''(since 0.11)'' |
| | 90 | |
| | 91 | The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box. |
| | 92 | However, 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 | |
| | 94 | This mapping is done in the `[svn:externals]` section of the TracIni |
| | 95 | |
| | 96 | Example: |
| | 97 | {{{ |
| | 98 | [svn:externals] |
| | 99 | 1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev |
| | 100 | 2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev |
| | 101 | 3 = http://theirserver.org/svn/eng-soft http://ourserver/viewvc/svn/$path/?pathrev=25914 |
| | 102 | 4 = svn://anotherserver.com/tools_repository http://ourserver/trac/support/browser/$path?rev=$rev |
| | 103 | }}} |
| | 104 | With 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 | |
| | 106 | 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. |
