43 | | {{{#!html |
44 | | <div class="tracini"><h3 id="attachment-section"><code>[attachment]</code></h3><table class="wiki"><tbody><tr><td><tt>max_size</tt></td><td>Maximum allowed file size (in bytes) for ticket and wiki |
45 | | attachments.</td></tr><tr><td><tt>render_unsafe_content</tt></td><td>Whether attachments should be rendered in the browser, or |
46 | | only made downloadable. |
47 | | |
48 | | Pretty much any file may be interpreted as HTML by the browser, |
49 | | which allows a malicious user to attach a file containing cross-site |
50 | | scripting attacks. |
51 | | |
52 | | For public sites where anonymous users can create attachments it is |
53 | | recommended to leave this option disabled (which is the default).</td></tr></tbody></table><h3 id="browser-section"><code>[browser]</code></h3><table class="wiki"><tbody><tr><td><tt>color_scale</tt></td><td>Enable colorization of the <em>age</em> column. |
54 | | |
55 | | This uses the same color scale as the source code annotation: |
56 | | blue is older, red is newer. |
57 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>downloadable_paths</tt></td><td>List of repository paths that can be downloaded. |
58 | | |
59 | | Leave the option empty if you want to disable all downloads, otherwise |
60 | | set it to a comma-separated list of authorized paths (those paths are |
61 | | glob patterns, i.e. "*" can be used as a wild card) |
62 | | (<em>since 0.10</em>)</td></tr><tr><td><tt>hide_properties</tt></td><td>Comma-separated list of version control properties to hide from |
63 | | the repository browser. |
64 | | (<em>since 0.9</em>)</td></tr><tr><td><tt>intermediate_color</tt></td><td>(r,g,b) color triple to use for the color corresponding |
65 | | to the intermediate color, if two linear interpolations are used |
66 | | for the color scale (see <tt>intermediate_point</tt>). |
67 | | If not set, the intermediate color between <tt>oldest_color</tt> and |
68 | | <tt>newest_color</tt> will be used. |
69 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>intermediate_point</tt></td><td>If set to a value between 0 and 1 (exclusive), this will be the |
70 | | point chosen to set the <tt>intermediate_color</tt> for interpolating |
71 | | the color value. |
72 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>newest_color</tt></td><td>(r,g,b) color triple to use for the color corresponding |
73 | | to the newest color, for the color scale used in <em>blame</em> or |
74 | | the browser <em>age</em> column if <tt>color_scale</tt> is enabled. |
75 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>oldest_color</tt></td><td>(r,g,b) color triple to use for the color corresponding |
76 | | to the oldest color, for the color scale used in <em>blame</em> or |
77 | | the browser <em>age</em> column if <tt>color_scale</tt> is enabled. |
78 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>oneliner_properties</tt></td><td>Comma-separated list of version control properties to render |
79 | | as oneliner wiki content in the repository browser. |
80 | | |
81 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>render_unsafe_content</tt></td><td>Whether raw files should be rendered in the browser, or only made |
82 | | downloadable. |
83 | | |
84 | | Pretty much any file may be interpreted as HTML by the browser, |
85 | | which allows a malicious user to create a file containing cross-site |
86 | | scripting attacks. |
87 | | |
88 | | For open repositories where anyone can check-in a file, it is |
89 | | recommended to leave this option disabled (which is the default).</td></tr><tr><td><tt>wiki_properties</tt></td><td>Comma-separated list of version control properties to render |
90 | | as wiki content in the repository browser. |
91 | | |
92 | | (<em>since 0.11</em>)</td></tr></tbody></table><h3 id="changeset-section"><code>[changeset]</code></h3><table class="wiki"><tbody><tr><td><tt>max_diff_bytes</tt></td><td>Maximum total size in bytes of the modified files (their old size |
93 | | plus their new size) for which the changeset view will attempt to show |
94 | | the diffs inlined (<em>since 0.10</em>).</td></tr><tr><td><tt>max_diff_files</tt></td><td>Maximum number of modified files for which the changeset view will |
95 | | attempt to show the diffs inlined (<em>since 0.10</em>).</td></tr><tr><td><tt>wiki_format_messages</tt></td><td>Whether wiki formatting should be applied to changeset messages. |
96 | | |
97 | | If this option is disabled, changeset messages will be rendered as |
98 | | pre-formatted text.</td></tr></tbody></table><h3 id="header_logo-section"><code>[header_logo]</code></h3><table class="wiki"><tbody><tr><td><tt>alt</tt></td><td>Alternative text for the header logo.</td></tr><tr><td><tt>height</tt></td><td>Height of the header logo image in pixels.</td></tr><tr><td><tt>link</tt></td><td>URL to link to, from the header logo.</td></tr><tr><td><tt>src</tt></td><td>URL of the image to use as header logo. |
99 | | It can be absolute, server relative or relative. |
100 | | |
101 | | If relative, it is relative to one of the <tt>/chrome</tt> locations: |
102 | | <tt>site/your-logo.png</tt> if <tt>your-logo.png</tt> is located in the <tt>htdocs</tt> |
103 | | folder within your <a class="wiki" href="/wiki/TracEnvironment">TracEnvironment</a>; |
104 | | <tt>common/your-logo.png</tt> if <tt>your-logo.png</tt> is located in the |
105 | | folder mapped to the <a class="wiki" href="/wiki/TracIni#trac-section">htdocs_location</a> URL. |
106 | | Only specifying <tt>your-logo.png</tt> is equivalent to the latter.</td></tr><tr><td><tt>width</tt></td><td>Width of the header logo image in pixels.</td></tr></tbody></table><h3 id="inherit-section"><code>[inherit]</code></h3><table class="wiki"><tbody><tr><td><tt>plugins_dir</tt></td><td>Path to the <em>shared plugins directory</em>. |
107 | | |
108 | | Plugins in that directory are loaded in addition to those in the |
109 | | directory of the environment <tt>plugins</tt>, with this one taking |
110 | | precedence. |
111 | | |
112 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>templates_dir</tt></td><td>Path to the <em>shared templates directory</em>. |
113 | | |
114 | | Templates in that directory are loaded in addition to those in the |
115 | | environments <tt>templates</tt> directory, but the latter take precedence. |
116 | | |
117 | | (<em>since 0.11</em>)</td></tr></tbody></table><h3 id="logging-section"><code>[logging]</code></h3><table class="wiki"><tbody><tr><td><tt>log_file</tt></td><td>If <tt>log_type</tt> is <tt>file</tt>, this should be a path to the log-file. |
118 | | Relative paths are resolved relative to the <tt>log</tt> directory of the |
119 | | environment.</td></tr><tr><td><tt>log_format</tt></td><td>Custom logging format. |
120 | | |
121 | | If nothing is set, the following will be used: |
122 | | |
123 | | Trac[$(module)s] $(levelname)s: $(message)s |
124 | | |
125 | | In addition to regular key names supported by the Python logger library |
126 | | (see <a class="ext-link" href="http://docs.python.org/library/logging.html"><span class="icon"> </span>http://docs.python.org/library/logging.html</a>), one could use: |
127 | | - $(path)s the path for the current environment |
128 | | - $(basename)s the last path component of the current environment |
129 | | - $(project)s the project name |
130 | | |
131 | | Note the usage of <tt>$(...)s</tt> instead of <tt>%(...)s</tt> as the latter form |
132 | | would be interpreted by the <a class="missing wiki" href="/wiki/ConfigParser" rel="nofollow">ConfigParser?</a> itself. |
133 | | |
134 | | Example: |
135 | | <tt>($(thread)d) Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s</tt> |
136 | | |
137 | | <em>(since 0.10.5)</em></td></tr><tr><td><tt>log_level</tt></td><td>Level of verbosity in log. |
138 | | |
139 | | Should be one of (<tt>CRITICAL</tt>, <tt>ERROR</tt>, <tt>WARN</tt>, <tt>INFO</tt>, <tt>DEBUG</tt>).</td></tr><tr><td><tt>log_type</tt></td><td>Logging facility to use. |
140 | | |
141 | | Should be one of (<tt>none</tt>, <tt>file</tt>, <tt>stderr</tt>, <tt>syslog</tt>, <tt>winlog</tt>).</td></tr></tbody></table><h3 id="milestone-section"><code>[milestone]</code></h3><table class="wiki"><tbody><tr><td><tt>stats_provider</tt></td><td>Name of the component implementing <tt>ITicketGroupStatsProvider</tt>, |
142 | | which is used to collect statistics on groups of tickets for display |
143 | | in the milestone views.</td></tr></tbody></table><h3 id="mimeviewer-section"><code>[mimeviewer]</code></h3><table class="wiki"><tbody><tr><td><tt>max_preview_size</tt></td><td>Maximum file size for HTML preview. (<em>since 0.9</em>)</td></tr><tr><td><tt>mime_map</tt></td><td>List of additional MIME types and keyword mappings. |
144 | | Mappings are comma-separated, and for each MIME type, |
145 | | there's a colon (":") separated list of associated keywords |
146 | | or file extensions. (<em>since 0.10</em>)</td></tr><tr><td><tt>pygments_default_style</tt></td><td>The default style to use for Pygments syntax highlighting.</td></tr><tr><td><tt>pygments_modes</tt></td><td>List of additional MIME types known by Pygments. |
147 | | |
148 | | For each, a tuple <tt>mimetype:mode:quality</tt> has to be |
149 | | specified, where <tt>mimetype</tt> is the MIME type, |
150 | | <tt>mode</tt> is the corresponding Pygments mode to be used |
151 | | for the conversion and <tt>quality</tt> is the quality ratio |
152 | | associated to this conversion. That can also be used |
153 | | to override the default quality ratio used by the |
154 | | Pygments render.</td></tr><tr><td><tt>tab_width</tt></td><td>Displayed tab width in file preview. (<em>since 0.9</em>)</td></tr><tr><td><tt>treat_as_binary</tt></td><td>Comma-separated list of MIME types that should be treated as |
155 | | binary data. (<em>since 0.11.5</em>)</td></tr></tbody></table><h3 id="notification-section"><code>[notification]</code></h3><table class="wiki"><tbody><tr><td><tt>admit_domains</tt></td><td>Comma-separated list of domains that should be considered as |
156 | | valid for email addresses (such as localdomain).</td></tr><tr><td><tt>always_notify_owner</tt></td><td>Always send notifications to the ticket owner (<em>since 0.9</em>).</td></tr><tr><td><tt>always_notify_reporter</tt></td><td>Always send notifications to any address in the <em>reporter</em> |
157 | | field.</td></tr><tr><td><tt>always_notify_updater</tt></td><td>Always send notifications to the person who causes the ticket |
158 | | property change and to any previous updater of that ticket.</td></tr><tr><td><tt>email_sender</tt></td><td>Name of the component implementing <tt>IEmailSender</tt>. |
159 | | |
160 | | This component is used by the notification system to send emails. |
161 | | Trac currently provides <tt>SmtpEmailSender</tt> for connecting to an SMTP |
162 | | server, and <tt>SendmailEmailSender</tt> for running a <tt>sendmail</tt>-compatible |
163 | | executable. (<em>since 0.12</em>)</td></tr><tr><td><tt>ignore_domains</tt></td><td>Comma-separated list of domains that should not be considered |
164 | | part of email addresses (for usernames with Kerberos domains).</td></tr><tr><td><tt>mime_encoding</tt></td><td>Specifies the MIME encoding scheme for emails. |
165 | | |
166 | | Valid options are 'base64' for Base64 encoding, 'qp' for |
167 | | Quoted-Printable, and 'none' for no encoding, in which case mails will |
168 | | be sent as 7bit if the content is all ASCII, or 8bit otherwise. |
169 | | (<em>since 0.10</em>)</td></tr><tr><td><tt>sendmail_path</tt></td><td>Path to the sendmail executable. |
170 | | |
171 | | The sendmail program must accept the <tt>-i</tt> and <tt>-f</tt> options. |
172 | | (<em>since 0.12</em>)</td></tr><tr><td><tt>smtp_always_bcc</tt></td><td>Email address(es) to always send notifications to, |
173 | | addresses do not appear publicly (Bcc:). (<em>since 0.10</em>).</td></tr><tr><td><tt>smtp_always_cc</tt></td><td>Email address(es) to always send notifications to, |
174 | | addresses can be seen by all recipients (Cc:).</td></tr><tr><td><tt>smtp_default_domain</tt></td><td>Default host/domain to append to address that do not specify |
175 | | one.</td></tr><tr><td><tt>smtp_enabled</tt></td><td>Enable email notification.</td></tr><tr><td><tt>smtp_from</tt></td><td>Sender address to use in notification emails.</td></tr><tr><td><tt>smtp_from_name</tt></td><td>Sender name to use in notification emails.</td></tr><tr><td><tt>smtp_password</tt></td><td>Password for SMTP server. (<em>since 0.9</em>)</td></tr><tr><td><tt>smtp_port</tt></td><td>SMTP server port to use for email notification.</td></tr><tr><td><tt>smtp_replyto</tt></td><td>Reply-To address to use in notification emails.</td></tr><tr><td><tt>smtp_server</tt></td><td>SMTP server hostname to use for email notifications.</td></tr><tr><td><tt>smtp_subject_prefix</tt></td><td>Text to prepend to subject line of notification emails. |
176 | | |
177 | | If the setting is not defined, then the [$project_name] prefix. |
178 | | If no prefix is desired, then specifying an empty option |
179 | | will disable it. (<em>since 0.10.1</em>).</td></tr><tr><td><tt>smtp_user</tt></td><td>Username for SMTP server. (<em>since 0.9</em>)</td></tr><tr><td><tt>ticket_subject_template</tt></td><td>A Genshi text template snippet used to get the notification subject. |
180 | | |
181 | | By default, the subject template is <tt>$prefix #$ticket.id: $summary</tt>. |
182 | | <tt>$prefix</tt> being the value of the <tt>smtp_subject_prefix</tt> option. |
183 | | <em>(since 0.11)</em></td></tr><tr><td><tt>use_public_cc</tt></td><td>Recipients can see email addresses of other CC'ed recipients. |
184 | | |
185 | | If this option is disabled (the default), recipients are put on BCC. |
186 | | (<em>since 0.10</em>)</td></tr><tr><td><tt>use_short_addr</tt></td><td>Permit email address without a host/domain (i.e. username only). |
187 | | |
188 | | The SMTP server should accept those addresses, and either append |
189 | | a FQDN or use local delivery. (<em>since 0.10</em>)</td></tr><tr><td><tt>use_tls</tt></td><td>Use SSL/TLS to send notifications over SMTP. (<em>since 0.10</em>)</td></tr></tbody></table><h3 id="project-section"><code>[project]</code></h3><table class="wiki"><tbody><tr><td><tt>admin</tt></td><td>E-Mail address of the project's administrator.</td></tr><tr><td><tt>admin_trac_url</tt></td><td>Base URL of a Trac instance where errors in this Trac should be |
190 | | reported. |
191 | | |
192 | | This can be an absolute or relative URL, or '.' to reference this |
193 | | Trac instance. An empty value will disable the reporting buttons. |
194 | | (<em>since 0.11.3</em>)</td></tr><tr><td><tt>descr</tt></td><td>Short description of the project.</td></tr><tr><td><tt>footer</tt></td><td>Page footer text (right-aligned).</td></tr><tr><td><tt>icon</tt></td><td>URL of the icon of the project.</td></tr><tr><td><tt>name</tt></td><td>Name of the project.</td></tr><tr><td><tt>url</tt></td><td>URL of the main project web site, usually the website in which |
195 | | the <tt>base_url</tt> resides. This is used in notification e-mails.</td></tr></tbody></table><h3 id="query-section"><code>[query]</code></h3><table class="wiki"><tbody><tr><td><tt>default_anonymous_query</tt></td><td>The default query for anonymous users. The query is either |
196 | | in <a class="wiki" href="/wiki/TracQuery#QueryLanguage">query language</a> syntax, or a URL query |
197 | | string starting with <tt>?</tt> as used in <tt>query:</tt> |
198 | | <a class="wiki" href="/wiki/TracQuery#UsingTracLinks">Trac links</a>. |
199 | | (<em>since 0.11.2</em>)</td></tr><tr><td><tt>default_query</tt></td><td>The default query for authenticated users. The query is either |
200 | | in <a class="wiki" href="/wiki/TracQuery#QueryLanguage">query language</a> syntax, or a URL query |
201 | | string starting with <tt>?</tt> as used in <tt>query:</tt> |
202 | | <a class="wiki" href="/wiki/TracQuery#UsingTracLinks">Trac links</a>. |
203 | | (<em>since 0.11.2</em>)</td></tr><tr><td><tt>items_per_page</tt></td><td>Number of tickets displayed per page in ticket queries, |
204 | | by default (<em>since 0.11</em>)</td></tr><tr><td><tt>ticketlink_query</tt></td><td>The base query to be used when linkifying values of ticket |
205 | | fields. The query is a URL query |
206 | | string starting with <tt>?</tt> as used in <tt>query:</tt> |
207 | | <a class="wiki" href="/wiki/TracQuery#UsingTracLinks">Trac links</a>. |
208 | | (<em>since 0.12</em>)</td></tr></tbody></table><h3 id="revisionlog-section"><code>[revisionlog]</code></h3><table class="wiki"><tbody><tr><td><tt>default_log_limit</tt></td><td>Default value for the limit argument in the <a class="wiki" href="/wiki/TracRevisionLog">TracRevisionLog</a> |
209 | | (<em>since 0.11</em>).</td></tr></tbody></table><h3 id="roadmap-section"><code>[roadmap]</code></h3><table class="wiki"><tbody><tr><td><tt>stats_provider</tt></td><td>Name of the component implementing <tt>ITicketGroupStatsProvider</tt>, |
210 | | which is used to collect statistics on groups of tickets for display |
211 | | in the roadmap views.</td></tr></tbody></table><h3 id="search-section"><code>[search]</code></h3><table class="wiki"><tbody><tr><td><tt>default_disabled_filters</tt></td><td>Specifies which search filters should be disabled by default |
212 | | on the search page. This will also restrict the filters for the |
213 | | quick search function. Search filters can still be manually |
214 | | enabled by the user on the search page. (since 0.12)</td></tr><tr><td><tt>min_query_length</tt></td><td>Minimum length of query string allowed when performing a search.</td></tr></tbody></table><h3 id="sqlite-section"><code>[sqlite]</code></h3><table class="wiki"><tbody><tr><td><tt>extensions</tt></td><td>Paths to sqlite extensions, relative to Trac environment's |
215 | | directory or absolute. (<em>since 0.12</em>)</td></tr></tbody></table><h3 id="svn-section"><code>[svn]</code></h3><table class="wiki"><tbody><tr><td><tt>branches</tt></td><td>Comma separated list of paths categorized as branches. |
216 | | If a path ends with '*', then all the directory entries found below |
217 | | that path will be included. |
218 | | Example: <tt>/trunk, /branches/*, /projectAlpha/trunk, /sandbox/*</tt></td></tr><tr><td><tt>tags</tt></td><td>Comma separated list of paths categorized as tags. |
219 | | |
220 | | If a path ends with '*', then all the directory entries found below |
221 | | that path will be included. |
222 | | Example: <tt>/tags/*, /projectAlpha/tags/A-1.0, /projectAlpha/tags/A-v1.1</tt></td></tr></tbody></table><h3 id="ticket-section"><code>[ticket]</code></h3><table class="wiki"><tbody><tr><td><tt>default_cc</tt></td><td>Default cc: list for newly created tickets.</td></tr><tr><td><tt>default_component</tt></td><td>Default component for newly created tickets.</td></tr><tr><td><tt>default_description</tt></td><td>Default description for newly created tickets.</td></tr><tr><td><tt>default_keywords</tt></td><td>Default keywords for newly created tickets.</td></tr><tr><td><tt>default_milestone</tt></td><td>Default milestone for newly created tickets.</td></tr><tr><td><tt>default_owner</tt></td><td>Default owner for newly created tickets.</td></tr><tr><td><tt>default_priority</tt></td><td>Default priority for newly created tickets.</td></tr><tr><td><tt>default_resolution</tt></td><td>Default resolution for resolving (closing) tickets |
223 | | (<em>since 0.11</em>).</td></tr><tr><td><tt>default_severity</tt></td><td>Default severity for newly created tickets.</td></tr><tr><td><tt>default_summary</tt></td><td>Default summary (title) for newly created tickets.</td></tr><tr><td><tt>default_type</tt></td><td>Default type for newly created tickets (<em>since 0.9</em>).</td></tr><tr><td><tt>default_version</tt></td><td>Default version for newly created tickets.</td></tr><tr><td><tt>max_comment_size</tt></td><td>Don't accept tickets with a too big comment. |
224 | | (<em>since 0.11.2</em>)</td></tr><tr><td><tt>max_description_size</tt></td><td>Don't accept tickets with a too big description. |
225 | | (<em>since 0.11</em>).</td></tr><tr><td><tt>preserve_newlines</tt></td><td>Whether Wiki formatter should respect the new lines present |
226 | | in the Wiki text. |
227 | | If set to 'default', this is equivalent to 'yes' for new environments |
228 | | but keeps the old behavior for upgraded environments (i.e. 'no'). |
229 | | (<em>since 0.11</em>).</td></tr><tr><td><tt>restrict_owner</tt></td><td>Make the owner field of tickets use a drop-down menu. |
230 | | Be sure to understand the performance implications before activating |
231 | | this option. See |
232 | | <a class="wiki" href="/wiki/TracTickets#Assign-toasDrop-DownList">Assign-to as Drop-Down List</a> |
233 | | (<em>since 0.9</em>).</td></tr><tr><td><tt>workflow</tt></td><td>Ordered list of workflow controllers to use for ticket actions |
234 | | (<em>since 0.11</em>).</td></tr></tbody></table><h3 id="timeline-section"><code>[timeline]</code></h3><table class="wiki"><tbody><tr><td><tt>abbreviated_messages</tt></td><td>Whether wiki-formatted event messages should be truncated or not. |
235 | | |
236 | | This only affects the default rendering, and can be overriden by |
237 | | specific event providers, see their own documentation. |
238 | | (<em>Since 0.11</em>)</td></tr><tr><td><tt>changeset_collapse_events</tt></td><td>Whether consecutive changesets from the same author having |
239 | | exactly the same message should be presented as one event. |
240 | | That event will link to the range of changesets in the log view. |
241 | | (<em>since 0.11</em>)</td></tr><tr><td><tt>changeset_long_messages</tt></td><td>Whether wiki-formatted changeset messages should be multiline or |
242 | | not. |
243 | | |
244 | | If this option is not specified or is false and <tt>wiki_format_messages</tt> |
245 | | is set to true, changeset messages will be single line only, losing |
246 | | some formatting (bullet points, etc).</td></tr><tr><td><tt>changeset_show_files</tt></td><td>Number of files to show (<tt>-1</tt> for unlimited, <tt>0</tt> to disable). |
247 | | |
248 | | This can also be <tt>location</tt>, for showing the common prefix for the |
249 | | changed files. (since 0.11).</td></tr><tr><td><tt>default_daysback</tt></td><td>Default number of days displayed in the Timeline, in days. |
250 | | (<em>since 0.9.</em>)</td></tr><tr><td><tt>max_daysback</tt></td><td>Maximum number of days (-1 for unlimited) displayable in the |
251 | | Timeline. (<em>since 0.11</em>)</td></tr><tr><td><tt>newticket_formatter</tt></td><td>Which formatter flavor (e.g. 'html' or 'oneliner') should be |
252 | | used when presenting the description for new tickets. |
253 | | If 'oneliner', the [timeline] abbreviated_messages option applies. |
254 | | (<em>since 0.11</em>).</td></tr><tr><td><tt>ticket_show_details</tt></td><td>Enable the display of all ticket changes in the timeline, not only |
255 | | open / close operations (<em>since 0.9</em>).</td></tr></tbody></table><h3 id="trac-section"><code>[trac]</code></h3><table class="wiki"><tbody><tr><td><tt>auth_cookie_lifetime</tt></td><td>Lifetime of the authentication cookie, in seconds. |
256 | | |
257 | | This value determines how long the browser will cache authentication |
258 | | information, and therefore, after how much inactivity a user will have |
259 | | to log in again. The default value of 0 makes the cookie expire at the |
260 | | end of the browsing session. (<em>since 0.12</em>)</td></tr><tr><td><tt>auth_cookie_path</tt></td><td>Path for the authentication cookie. Set this to the common base path |
261 | | of several Trac instances if you want them to share the cookie. |
262 | | (<em>since 0.12</em>)</td></tr><tr><td><tt>authz_file</tt></td><td>The path to the Subversion |
263 | | <a class="ext-link" href="http://svnbook.red-bean.com/en/1.5/svn.serverconfig.pathbasedauthz.html"><span class="icon"> </span>authorization (authz) file</a>. |
264 | | To enable authz permission checking, the <tt>AuthzSourcePolicy</tt> permission |
265 | | policy must be added to <tt>[trac] permission_policies</tt>.</td></tr><tr><td><tt>authz_module_name</tt></td><td>The module prefix used in the <tt>authz_file</tt> for the default |
266 | | repository. If left empty, the global section is used.</td></tr><tr><td><tt>auto_preview_timeout</tt></td><td>Inactivity timeout in seconds after which the automatic wiki preview |
267 | | triggers an update. This option can contain floating-point values. The |
268 | | lower the setting, the more requests will be made to the server. Set |
269 | | this to 0 to disable automatic preview. The default is 2.0 seconds. |
270 | | (<em>since 0.12</em>)</td></tr><tr><td><tt>auto_reload</tt></td><td>Automatically reload template files after modification.</td></tr><tr><td><tt>backup_dir</tt></td><td>Database backup location</td></tr><tr><td><tt>base_url</tt></td><td>Reference URL for the Trac deployment. |
271 | | |
272 | | This is the base URL that will be used when producing documents that |
273 | | will be used outside of the web browsing context, like for example |
274 | | when inserting URLs pointing to Trac resources in notification |
275 | | e-mails.</td></tr><tr><td><tt>check_auth_ip</tt></td><td>Whether the IP address of the user should be checked for |
276 | | authentication (<em>since 0.9</em>).</td></tr><tr><td><tt>database</tt></td><td>Database connection |
277 | | <a class="wiki" href="/wiki/TracEnvironment#DatabaseConnectionStrings">string</a> for this |
278 | | project</td></tr><tr><td><tt>debug_sql</tt></td><td>Show the SQL queries in the Trac log, at DEBUG level. |
279 | | <em>(Since 0.11.5)</em></td></tr><tr><td><tt>default_charset</tt></td><td>Charset to be used when in doubt.</td></tr><tr><td><tt>default_handler</tt></td><td>Name of the component that handles requests to the base URL. |
280 | | |
281 | | Options include <tt>TimelineModule</tt>, <tt>RoadmapModule</tt>, <tt>BrowserModule</tt>, |
282 | | <tt>QueryModule</tt>, <tt>ReportModule</tt>, <tt>TicketModule</tt> and <tt>WikiModule</tt>. The |
283 | | default is <tt>WikiModule</tt>. (<em>since 0.9</em>)</td></tr><tr><td><tt>default_language</tt></td><td>The preferred language to use if no user preference has been set. |
284 | | (<em>since 0.12.1</em>)</td></tr><tr><td><tt>default_timezone</tt></td><td>The default timezone to use</td></tr><tr><td><tt>genshi_cache_size</tt></td><td>The maximum number of templates that the template loader will cache |
285 | | in memory. The default value is 128. You may want to choose a higher |
286 | | value if your site uses a larger number of templates, and you have |
287 | | enough memory to spare, or you can reduce it if you are short on |
288 | | memory.</td></tr><tr><td><tt>htdocs_location</tt></td><td>Base URL for serving the core static resources below |
289 | | <tt>/chrome/common/</tt>. |
290 | | |
291 | | It can be left empty, and Trac will simply serve those resources |
292 | | itself. |
293 | | |
294 | | Advanced users can use this together with |
295 | | <a class="wiki" href="/wiki/TracAdmin">trac-admin ... deploy <deploydir></a> to allow serving the |
296 | | static resources for Trac directly from the web server. |
297 | | Note however that this only applies to the <tt><deploydir>/htdocs/common</tt> |
298 | | directory, the other deployed resources (i.e. those from plugins) |
299 | | will not be made available this way and additional rewrite |
300 | | rules will be needed in the web server.</td></tr><tr><td><tt>ignore_auth_case</tt></td><td>Whether login names should be converted to lower case |
301 | | (<em>since 0.9</em>).</td></tr><tr><td><tt>mainnav</tt></td><td>Order of the items to display in the <tt>mainnav</tt> navigation bar, |
302 | | listed by IDs. See also <a class="wiki" href="/wiki/TracNavigation">TracNavigation</a>.</td></tr><tr><td><tt>metanav</tt></td><td>Order of the items to display in the <tt>metanav</tt> navigation bar, |
303 | | listed by IDs. See also <a class="wiki" href="/wiki/TracNavigation">TracNavigation</a>.</td></tr><tr><td><tt>mysqldump_path</tt></td><td>Location of mysqldump for MySQL database backups</td></tr><tr><td><tt>never_obfuscate_mailto</tt></td><td>Never obfuscate <tt>mailto:</tt> links explicitly written in the wiki, |
304 | | even if <tt>show_email_addresses</tt> is false and the user doesn't have the |
305 | | EMAIL_VIEW permission (<em>since 0.11.6</em>).</td></tr><tr><td><tt>permission_policies</tt></td><td>List of components implementing <tt>IPermissionPolicy</tt>, in the order in |
306 | | which they will be applied. These components manage fine-grained access |
307 | | control to Trac resources. |
308 | | Defaults to the <a class="missing wiki" href="/wiki/DefaultPermissionPolicy" rel="nofollow">DefaultPermissionPolicy?</a> (pre-0.11 behavior) and |
309 | | <a class="missing wiki" href="/wiki/LegacyAttachmentPolicy" rel="nofollow">LegacyAttachmentPolicy?</a> (map ATTACHMENT_* permissions to realm specific |
310 | | ones)</td></tr><tr><td><tt>permission_store</tt></td><td>Name of the component implementing <tt>IPermissionStore</tt>, which is used |
311 | | for managing user and group permissions.</td></tr><tr><td><tt>pg_dump_path</tt></td><td>Location of pg_dump for Postgres database backups</td></tr><tr><td><tt>repository_dir</tt></td><td>Path to the default repository. This can also be a relative path |
312 | | (<em>since 0.11</em>). |
313 | | |
314 | | This option is deprecated, and repositories should be defined in the |
315 | | <a class="wiki" href="/wiki/TracIni#repositories-section">repositories</a> section, or using the |
316 | | "Repositories" admin panel. (<em>since 0.12</em>)</td></tr><tr><td><tt>repository_sync_per_request</tt></td><td>List of repositories that should be synchronized on every page |
317 | | request. |
318 | | |
319 | | Leave this option empty if you have set up post-commit hooks calling |
320 | | <tt>trac-admin $ENV changeset added</tt> on all your repositories |
321 | | (recommended). Otherwise, set it to a comma-separated list of |
322 | | repository names. Note that this will negatively affect performance, |
323 | | and will prevent changeset listeners from receiving events from the |
324 | | repositories specified here. The default is to synchronize the default |
325 | | repository, for backward compatibility. (<em>since 0.12</em>)</td></tr><tr><td><tt>repository_type</tt></td><td>Default repository connector type. (<em>since 0.10</em>) |
326 | | |
327 | | This is also used as the default repository type for repositories |
328 | | defined in <a class="wiki" href="/wiki/TracIni#repositories-section repositories">TracIni#repositories-section repositories</a> or using the |
329 | | "Repositories" admin panel. (<em>since 0.12</em>)</td></tr><tr><td><tt>request_filters</tt></td><td>Ordered list of filters to apply to all requests |
330 | | (<em>since 0.10</em>).</td></tr><tr><td><tt>resizable_textareas</tt></td><td>Make <tt><textarea></tt> fields resizable. Requires JavaScript. |
331 | | (<em>since 0.12</em>)</td></tr><tr><td><tt>secure_cookies</tt></td><td>Restrict cookies to HTTPS connections. |
332 | | |
333 | | When true, set the <tt>secure</tt> flag on all cookies so that they are |
334 | | only sent to the server on HTTPS connections. Use this if your Trac |
335 | | instance is only accessible through HTTPS. (<em>since 0.11.2</em>)</td></tr><tr><td><tt>show_email_addresses</tt></td><td>Show email addresses instead of usernames. If false, we obfuscate |
336 | | email addresses. (<em>since 0.11</em>)</td></tr><tr><td><tt>show_ip_addresses</tt></td><td>Show IP addresses for resource edits (e.g. wiki). |
337 | | (<em>since 0.11.3</em>)</td></tr><tr><td><tt>timeout</tt></td><td>Timeout value for database connection, in seconds. |
338 | | Use '0' to specify <em>no timeout</em>. <em>(Since 0.11)</em></td></tr><tr><td><tt>use_base_url_for_redirect</tt></td><td>Optionally use <tt>[trac] base_url</tt> for redirects. |
339 | | |
340 | | In some configurations, usually involving running Trac behind a HTTP |
341 | | proxy, Trac can't automatically reconstruct the URL that is used to |
342 | | access it. You may need to use this option to force Trac to use the |
343 | | <tt>base_url</tt> setting also for redirects. This introduces the obvious |
344 | | limitation that this environment will only be usable when accessible |
345 | | from that URL, as redirects are frequently used. <em>(since 0.10.5)</em></td></tr></tbody></table><h3 id="versioncontrol-section"><code>[versioncontrol]</code></h3><table class="wiki"><tbody><tr><td><tt>allowed_repository_dir_prefixes</tt></td><td>Comma-separated list of allowed prefixes for repository |
346 | | directories when adding and editing repositories in the repository |
347 | | admin panel. If the list is empty, all repository directories are |
348 | | allowed. (<em>since 0.12.1</em>)</td></tr></tbody></table><h3 id="wiki-section"><code>[wiki]</code></h3><table class="wiki"><tbody><tr><td><tt>ignore_missing_pages</tt></td><td>Enable/disable highlighting <a class="wiki" href="/wiki/CamelCase">CamelCase</a> links to missing pages |
349 | | (<em>since 0.9</em>).</td></tr><tr><td><tt>max_size</tt></td><td>Maximum allowed wiki page size in bytes. (<em>since 0.11.2</em>)</td></tr><tr><td><tt>render_unsafe_content</tt></td><td>Enable/disable the use of unsafe HTML tags such as <tt><script></tt> or |
350 | | <tt><embed></tt> with the HTML <a class="wiki" href="/wiki/WikiProcessors">WikiProcessor</a> |
351 | | (<em>since 0.10.4</em>). |
352 | | |
353 | | For public sites where anonymous users can edit the wiki it is |
354 | | recommended to leave this option disabled (which is the default).</td></tr><tr><td><tt>safe_schemes</tt></td><td>List of URI schemes considered "safe", that will be rendered as |
355 | | external links even if <tt>[wiki] render_unsafe_content</tt> is <tt>false</tt>. |
356 | | (<em>since 0.11.8</em>)</td></tr><tr><td><tt>split_page_names</tt></td><td>Enable/disable splitting the <a class="wiki" href="/wiki/WikiPageNames">WikiPageNames</a> with space characters |
357 | | (<em>since 0.10</em>).</td></tr></tbody></table></div> |
358 | | }}} |
| 44 | [[TracIni]] |