| | 1 | = The Trac Configuration File = |
| | 2 | [[TracGuideToc]] |
| | 3 | |
| | 4 | Trac configuration is done by editing the '''`trac.ini`''' config file, located in `<projectenv>/conf/trac.ini`. |
| | 5 | |
| | 6 | == Global Configuration == |
| | 7 | |
| | 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. |
| | 9 | |
| | 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. |
| | 11 | |
| | 12 | == Reference == |
| | 13 | |
| | 14 | This is a brief reference of available configuration options. |
| | 15 | |
| | 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.''' |
| | 20 | |
| | 21 | |
| | 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 | |
| | 118 | This 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. |
| | 119 | |
| | 120 | The 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. |
| | 121 | |
| | 122 | Consider the following configuration snippet: |
| | 123 | {{{ |
| | 124 | [components] |
| | 125 | trac.ticket.report.ReportModule = disabled |
| | 126 | webadmin.* = enabled |
| | 127 | }}} |
| | 128 | |
| | 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].) |
| | 130 | |
| | 131 | See also: TracPlugins |
| | 132 | |
| | 133 | == [changeset] == |
| | 134 | (''since 0.10'') |
| | 135 | |
| | 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. || |
| | 137 | |
| | 138 | ---- |
| | 139 | See also: TracGuide, TracAdmin, TracEnvironment |
