]>
Commit | Line | Data |
---|---|---|
84fb5b46 MKG |
1 | # |
2 | # RT was configured with: | |
3 | # | |
af59614d | 4 | # $ ./configure --prefix=/www/var/rt/ --with-web-user=httpd --with-web-group=httpd --with-rt-group=uio-rt --with-db-type=Pg --with-db-dba=postgres --disable-gpg |
84fb5b46 MKG |
5 | # |
6 | ||
7 | package RT; | |
8 | ||
9 | ############################# WARNING ############################# | |
10 | # # | |
11 | # NEVER EDIT RT_Config.pm ! # | |
12 | # # | |
13 | # Instead, copy any sections you want to change to # | |
14 | # RT_SiteConfig.pm and edit them there. Otherwise, # | |
15 | # your changes will be lost when you upgrade RT. # | |
16 | # # | |
17 | ############################# WARNING ############################# | |
18 | ||
19 | =head1 NAME | |
20 | ||
21 | RT::Config | |
22 | ||
23 | =head1 Base configuration | |
24 | ||
25 | =over 4 | |
26 | ||
27 | =item C<$rtname> | |
28 | ||
29 | C<$rtname> is the string that RT will look for in mail messages to | |
30 | figure out what ticket a new piece of mail belongs to. | |
31 | ||
32 | Your domain name is recommended, so as not to pollute the namespace. | |
33 | Once you start using a given tag, you should probably never change it; | |
34 | otherwise, mail for existing tickets won't get put in the right place. | |
35 | ||
36 | =cut | |
37 | ||
38 | Set($rtname, "example.com"); | |
39 | ||
40 | =item C<$Organization> | |
41 | ||
42 | You should set this to your organization's DNS domain. For example, | |
43 | I<fsck.com> or I<asylum.arkham.ma.us>. It is used by the linking | |
44 | interface to guarantee that ticket URIs are unique and easy to | |
45 | construct. Changing it after you have created tickets in the system | |
46 | will B<break> all existing ticket links! | |
47 | ||
48 | =cut | |
49 | ||
50 | Set($Organization, "example.com"); | |
51 | ||
52 | =item C<$CorrespondAddress>, C<$CommentAddress> | |
53 | ||
54 | RT is designed such that any mail which already has a ticket-id | |
55 | associated with it will get to the right place automatically. | |
56 | ||
57 | C<$CorrespondAddress> and C<$CommentAddress> are the default addresses | |
58 | that will be listed in From: and Reply-To: headers of correspondence | |
59 | and comment mail tracked by RT, unless overridden by a queue-specific | |
60 | address. They should be set to email addresses which have been | |
61 | configured as aliases for F<rt-mailgate>. | |
62 | ||
63 | =cut | |
64 | ||
65 | Set($CorrespondAddress, ''); | |
66 | ||
67 | Set($CommentAddress, ''); | |
68 | ||
69 | =item C<$WebDomain> | |
70 | ||
71 | Domain name of the RT server, e.g. 'www.example.com'. It should not | |
72 | contain anything except the server name. | |
73 | ||
74 | =cut | |
75 | ||
76 | Set($WebDomain, "localhost"); | |
77 | ||
78 | =item C<$WebPort> | |
79 | ||
80 | If we're running as a superuser, run on port 80. Otherwise, pick a | |
81 | high port for this user. | |
82 | ||
83 | 443 is default port for https protocol. | |
84 | ||
85 | =cut | |
86 | ||
87 | Set($WebPort, 80); | |
88 | ||
89 | =item C<$WebPath> | |
90 | ||
91 | If you're putting the web UI somewhere other than at the root of your | |
92 | server, you should set C<$WebPath> to the path you'll be serving RT | |
93 | at. | |
94 | ||
95 | C<$WebPath> requires a leading / but no trailing /, or it can be | |
96 | blank. | |
97 | ||
98 | In most cases, you should leave C<$WebPath> set to "" (an empty | |
99 | value). | |
100 | ||
101 | =cut | |
102 | ||
103 | Set($WebPath, ""); | |
104 | ||
105 | =item C<$Timezone> | |
106 | ||
107 | C<$Timezone> is the default timezone, used to convert times entered by | |
108 | users into GMT, as they are stored in the database, and back again; | |
109 | users can override this. It should be set to a timezone recognized by | |
110 | your server. | |
111 | ||
112 | =cut | |
113 | ||
114 | Set($Timezone, "US/Eastern"); | |
115 | ||
116 | =item C<@Plugins> | |
117 | ||
118 | Set C<@Plugins> to a list of external RT plugins that should be | |
119 | enabled (those plugins have to be previously downloaded and | |
120 | installed). | |
121 | ||
122 | Example: | |
123 | ||
124 | C<Set(@Plugins, (qw(Extension::QuickDelete RT::Extension::CommandByMail)));> | |
125 | ||
126 | =cut | |
127 | ||
128 | Set(@Plugins, ()); | |
129 | ||
af59614d MKG |
130 | =item C<@StaticRoots> |
131 | ||
132 | Set C<@StaticRoots> to serve extra paths with a static handler. The | |
133 | contents of each hashref should be the the same arguments as | |
134 | L<Plack::Middleware::Static> takes. These paths will be checked before | |
135 | any plugin or core static paths. | |
136 | ||
137 | Example: | |
138 | ||
139 | Set( @StaticRoots, | |
140 | { | |
141 | path => qr{^/static/}, | |
142 | root => '/local/path/to/static/parent', | |
143 | }, | |
144 | ); | |
145 | ||
146 | =cut | |
147 | ||
148 | Set( @StaticRoots, () ); | |
149 | ||
84fb5b46 MKG |
150 | =back |
151 | ||
152 | ||
153 | ||
154 | ||
155 | =head1 Database connection | |
156 | ||
157 | =over 4 | |
158 | ||
159 | =item C<$DatabaseType> | |
160 | ||
161 | Database driver being used; case matters. Valid types are "mysql", | |
162 | "Oracle" and "Pg". | |
163 | ||
164 | =cut | |
165 | ||
166 | Set($DatabaseType, "Pg"); | |
167 | ||
168 | =item C<$DatabaseHost>, C<$DatabaseRTHost> | |
169 | ||
170 | The domain name of your database server. If you're running MySQL and | |
171 | on localhost, leave it blank for enhanced performance. | |
172 | ||
173 | C<DatabaseRTHost> is the fully-qualified hostname of your RT server, | |
174 | for use in granting ACL rights on MySQL. | |
175 | ||
176 | =cut | |
177 | ||
178 | Set($DatabaseHost, "localhost"); | |
179 | Set($DatabaseRTHost, "localhost"); | |
180 | ||
181 | =item C<$DatabasePort> | |
182 | ||
183 | The port that your database server is running on. Ignored unless it's | |
184 | a positive integer. It's usually safe to leave this blank; RT will | |
185 | choose the correct default. | |
186 | ||
187 | =cut | |
188 | ||
189 | Set($DatabasePort, ""); | |
190 | ||
191 | =item C<$DatabaseUser> | |
192 | ||
193 | The name of the user to connect to the database as. | |
194 | ||
195 | =cut | |
196 | ||
197 | Set($DatabaseUser, "rt_user"); | |
198 | ||
199 | =item C<$DatabasePassword> | |
200 | ||
201 | The password the C<$DatabaseUser> should use to access the database. | |
202 | ||
203 | =cut | |
204 | ||
205 | Set($DatabasePassword, q{rt_pass}); | |
206 | ||
207 | =item C<$DatabaseName> | |
208 | ||
209 | The name of the RT database on your database server. For Oracle, the | |
210 | SID and database objects are created in C<$DatabaseUser>'s schema. | |
211 | ||
212 | =cut | |
213 | ||
214 | Set($DatabaseName, q{rt4}); | |
215 | ||
216 | =item C<$DatabaseRequireSSL> | |
217 | ||
218 | If you're using PostgreSQL and have compiled in SSL support, set | |
219 | C<$DatabaseRequireSSL> to 1 to turn on SSL communication with the | |
220 | database. | |
221 | ||
222 | =cut | |
223 | ||
224 | Set($DatabaseRequireSSL, undef); | |
225 | ||
af59614d MKG |
226 | =item <$DatabaseAdmin> |
227 | ||
228 | The name of the database administrator to connect to the database as | |
229 | during upgrades. | |
230 | ||
231 | =cut | |
232 | ||
233 | Set($DatabaseAdmin, "postgres"); | |
234 | ||
84fb5b46 MKG |
235 | =back |
236 | ||
237 | ||
238 | ||
239 | ||
240 | =head1 Logging | |
241 | ||
242 | The default is to log anything except debugging information to syslog. | |
243 | Check the L<Log::Dispatch> POD for information about how to get things | |
244 | by syslog, mail or anything else, get debugging info in the log, etc. | |
245 | ||
246 | It might generally make sense to send error and higher by email to | |
247 | some administrator. If you do this, be careful that this email isn't | |
248 | sent to this RT instance. Mail loops will generate a critical log | |
249 | message. | |
250 | ||
251 | =over 4 | |
252 | ||
af59614d | 253 | =item C<$LogToSyslog>, C<$LogToSTDERR> |
84fb5b46 MKG |
254 | |
255 | The minimum level error that will be logged to the specific device. | |
256 | From lowest to highest priority, the levels are: | |
257 | ||
258 | debug info notice warning error critical alert emergency | |
259 | ||
260 | Many syslogds are configured to discard or file debug messages away, so | |
261 | if you're attempting to debug RT you may need to reconfigure your | |
262 | syslogd or use one of the other logging options. | |
263 | ||
264 | Logging to your screen affects scripts run from the command line as well | |
265 | as the STDERR sent to your webserver (so these logs will usually show up | |
266 | in your web server's error logs). | |
267 | ||
268 | =cut | |
269 | ||
270 | Set($LogToSyslog, "info"); | |
af59614d | 271 | Set($LogToSTDERR, "info"); |
84fb5b46 MKG |
272 | |
273 | =item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed> | |
274 | ||
275 | Logging to a standalone file is also possible. The file needs to both | |
276 | exist and be writable by all direct users of the RT API. This generally | |
277 | includes the web server and whoever rt-crontool runs as. Note that | |
278 | rt-mailgate and the RT CLI go through the webserver, so their users do | |
279 | not need to have write permissions to this file. If you expect to have | |
280 | multiple users of the direct API, Best Practical recommends using syslog | |
281 | instead of direct file logging. | |
282 | ||
283 | You should set C<$LogToFile> to one of the levels documented above. | |
284 | ||
285 | =cut | |
286 | ||
287 | Set($LogToFile, undef); | |
288 | Set($LogDir, q{var/log}); | |
289 | Set($LogToFileNamed, "rt.log"); #log to rt.log | |
290 | ||
291 | =item C<$LogStackTraces> | |
292 | ||
293 | If set to a log level then logging will include stack traces for | |
294 | messages with level equal to or greater than specified. | |
295 | ||
296 | NOTICE: Stack traces include parameters supplied to functions or | |
297 | methods. It is possible for stack trace logging to reveal sensitive | |
298 | information such as passwords or ticket content in your logs. | |
299 | ||
300 | =cut | |
301 | ||
302 | Set($LogStackTraces, ""); | |
303 | ||
304 | =item C<@LogToSyslogConf> | |
305 | ||
af59614d MKG |
306 | Additional options to pass to L<Log::Dispatch::Syslog>; the most |
307 | interesting flags include C<facility>, C<logopt>, and possibly C<ident>. | |
308 | See the L<Log::Dispatch::Syslog> documentation for more information. | |
84fb5b46 MKG |
309 | |
310 | =cut | |
311 | ||
312 | Set(@LogToSyslogConf, ()); | |
313 | ||
314 | =back | |
315 | ||
316 | ||
317 | ||
318 | =head1 Incoming mail gateway | |
319 | ||
320 | =over 4 | |
321 | ||
322 | =item C<$EmailSubjectTagRegex> | |
323 | ||
324 | This regexp controls what subject tags RT recognizes as its own. If | |
325 | you're not dealing with historical C<$rtname> values, you'll likely | |
326 | never have to change this configuration. | |
327 | ||
328 | Be B<very careful> with it. Note that it overrides C<$rtname> for | |
af59614d | 329 | subject token matching. |
84fb5b46 MKG |
330 | |
331 | The setting below would make RT behave exactly as it does without the | |
332 | setting enabled. | |
333 | ||
334 | =cut | |
335 | ||
336 | # Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i ); | |
337 | ||
338 | =item C<$OwnerEmail> | |
339 | ||
340 | C<$OwnerEmail> is the address of a human who manages RT. RT will send | |
af59614d MKG |
341 | errors generated by the mail gateway to this address; it will also be |
342 | displayed as the contact person on the RT's login page. Because RT | |
343 | sends errors to this address, it should I<not> be an address that's | |
344 | managed by your RT instance, to avoid mail loops. | |
84fb5b46 MKG |
345 | |
346 | =cut | |
347 | ||
348 | Set($OwnerEmail, 'root'); | |
349 | ||
350 | =item C<$LoopsToRTOwner> | |
351 | ||
352 | If C<$LoopsToRTOwner> is defined, RT will send mail that it believes | |
353 | might be a loop to C<$OwnerEmail>. | |
354 | ||
355 | =cut | |
356 | ||
357 | Set($LoopsToRTOwner, 1); | |
358 | ||
359 | =item C<$StoreLoops> | |
360 | ||
361 | If C<$StoreLoops> is defined, RT will record messages that it believes | |
362 | to be part of mail loops. As it does this, it will try to be careful | |
363 | not to send mail to the sender of these messages. | |
364 | ||
365 | =cut | |
366 | ||
367 | Set($StoreLoops, undef); | |
368 | ||
369 | =item C<$MaxAttachmentSize> | |
370 | ||
371 | C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments | |
dab09ea8 MKG |
372 | stored in the database. This setting is irrelevant unless one of |
373 | $TruncateLongAttachments or $DropLongAttachments (below) are set. | |
84fb5b46 | 374 | |
84fb5b46 MKG |
375 | =cut |
376 | ||
84fb5b46 MKG |
377 | Set($MaxAttachmentSize, 10_000_000); |
378 | ||
379 | =item C<$TruncateLongAttachments> | |
380 | ||
381 | If this is set to a non-undef value, RT will truncate attachments | |
382 | longer than C<$MaxAttachmentSize>. | |
383 | ||
384 | =cut | |
385 | ||
386 | Set($TruncateLongAttachments, undef); | |
387 | ||
388 | =item C<$DropLongAttachments> | |
389 | ||
390 | If this is set to a non-undef value, RT will silently drop attachments | |
391 | longer than C<MaxAttachmentSize>. C<$TruncateLongAttachments>, above, | |
392 | takes priority over this. | |
393 | ||
394 | =cut | |
395 | ||
396 | Set($DropLongAttachments, undef); | |
397 | ||
398 | =item C<$RTAddressRegexp> | |
399 | ||
400 | C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a | |
401 | ticket CC if C<$ParseNewMessageForTicketCcs>, above, is enabled. It | |
402 | is important that you set this to a regular expression that matches | |
403 | all addresses used by your RT. This lets RT avoid sending mail to | |
404 | itself. It will also hide RT addresses from the list of "One-time Cc" | |
405 | and Bcc lists on ticket reply. | |
406 | ||
407 | If you have a number of addresses configured in your RT database | |
408 | already, you can generate a naive first pass regexp by using: | |
409 | ||
410 | perl etc/upgrade/generate-rtaddressregexp | |
411 | ||
af59614d MKG |
412 | If left blank, RT will compare each address to your configured |
413 | C<$CorrespondAddress> and C<$CommentAddress> before searching for a | |
414 | Queue configured with a matching "Reply Address" or "Comment Address" | |
415 | on the Queue Admin page. | |
84fb5b46 MKG |
416 | |
417 | =cut | |
418 | ||
419 | Set($RTAddressRegexp, undef); | |
420 | ||
421 | =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace> | |
422 | ||
423 | RT provides functionality which allows the system to rewrite incoming | |
424 | email addresses. In its simplest form, you can substitute the value | |
425 | in C<CanonicalizeEmailAddressReplace> for the value in | |
426 | C<CanonicalizeEmailAddressMatch> (These values are passed to the | |
427 | C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>) | |
428 | ||
429 | By default, that routine performs a C<s/$Match/$Replace/gi> on any | |
430 | address passed to it. | |
431 | ||
432 | =cut | |
433 | ||
434 | # Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$'); | |
435 | # Set($CanonicalizeEmailAddressReplace, '@example.com'); | |
436 | ||
437 | =item C<$CanonicalizeOnCreate> | |
438 | ||
439 | Set this to 1 and the create new user page will use the values that | |
440 | you enter in the form but use the function CanonicalizeUserInfo in | |
441 | F<RT/User_Local.pm> | |
442 | ||
443 | =cut | |
444 | ||
445 | Set($CanonicalizeOnCreate, 0); | |
446 | ||
447 | =item C<$ValidateUserEmailAddresses> | |
448 | ||
af59614d | 449 | By default C<$ValidateUserEmailAddresses> is 1, and RT will refuse to create |
84fb5b46 MKG |
450 | users with an invalid email address (as specified in RFC 2822) or with |
451 | an email address made of multiple email addresses. | |
452 | ||
af59614d MKG |
453 | Set this to 0 to skip any email address validation. Doing so may open up |
454 | vulnerabilities. | |
455 | ||
84fb5b46 MKG |
456 | =cut |
457 | ||
af59614d | 458 | Set($ValidateUserEmailAddresses, 1); |
84fb5b46 MKG |
459 | |
460 | =item C<@MailPlugins> | |
461 | ||
462 | C<@MailPlugins> is a list of authentication plugins for | |
463 | L<RT::Interface::Email> to use; see L<rt-mailgate> | |
464 | ||
465 | =cut | |
466 | ||
467 | =item C<$UnsafeEmailCommands> | |
468 | ||
469 | C<$UnsafeEmailCommands>, if set to 1, enables 'take' and 'resolve' | |
470 | as possible actions via the mail gateway. As its name implies, this | |
471 | is very unsafe, as it allows email with a forged sender to possibly | |
472 | resolve arbitrary tickets! | |
473 | ||
474 | =cut | |
475 | ||
476 | =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch> | |
477 | ||
478 | The default "extract remote tracking tags" scrip settings; these | |
479 | detect when your RT is talking to another RT, and adjust the subject | |
480 | accordingly. | |
481 | ||
482 | =cut | |
483 | ||
c36a7e1d | 484 | Set($ExtractSubjectTagMatch, qr/\[[^\]]+? #\d+\]/); |
84fb5b46 MKG |
485 | Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex} |
486 | ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/ | |
487 | : qr/\[\Q$RT::rtname\E #\d+\]/)); | |
488 | ||
403d7b0b MKG |
489 | =item C<$CheckMoreMSMailHeaders> |
490 | ||
491 | Some email clients create a plain text version of HTML-formatted | |
492 | email to help other clients that read only plain text. | |
493 | Unfortunately, the plain text parts sometimes end up with | |
494 | doubled newlines and these can then end up in RT. This | |
495 | is most often seen in MS Outlook. | |
496 | ||
497 | Enable this option to have RT check for additional mail headers | |
498 | and attempt to identify email from MS Outlook. When detected, | |
499 | RT will then clean up double newlines. Note that it may | |
500 | clean up intentional double newlines as well. | |
501 | ||
502 | =cut | |
503 | ||
504 | Set( $CheckMoreMSMailHeaders, 0); | |
505 | ||
84fb5b46 MKG |
506 | =back |
507 | ||
508 | ||
509 | ||
510 | =head1 Outgoing mail | |
511 | ||
512 | =over 4 | |
513 | ||
514 | =item C<$MailCommand> | |
515 | ||
516 | C<$MailCommand> defines which method RT will use to try to send mail. | |
517 | We know that 'sendmailpipe' works fairly well. If 'sendmailpipe' | |
af59614d MKG |
518 | doesn't work well for you, try 'sendmail'. 'qmail' is also a supported |
519 | value. | |
84fb5b46 MKG |
520 | |
521 | For testing purposes, or to simply disable sending mail out into the | |
522 | world, you can set C<$MailCommand> to 'testfile' which writes all mail | |
523 | to a temporary file. RT will log the location of the temporary file | |
524 | so you can extract mail from it afterward. | |
525 | ||
01e3b242 MKG |
526 | On shutdown, RT will clean up the temporary file created when using |
527 | the 'testfile' option. If testing while the RT server is still running, | |
528 | you can find the files in the location noted in the log file. If you run | |
529 | a tool like C<rt-crontool> however, or if you look after stopping the server, | |
530 | the files will have been deleted when the process completed. If you need to | |
531 | keep the files for development or debugging, you can manually set | |
532 | C<< UNLINK => 0 >> where the testfile config is processed in | |
533 | F<lib/RT/Interface/Email.pm>. | |
534 | ||
84fb5b46 MKG |
535 | =cut |
536 | ||
537 | Set($MailCommand, "sendmailpipe"); | |
538 | ||
539 | =item C<$SetOutgoingMailFrom> | |
540 | ||
541 | C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the | |
542 | Correspond mail address of the ticket's queue. | |
543 | ||
544 | Warning: If you use this setting, bounced mails will appear to be | |
545 | incoming mail to the system, thus creating new tickets. | |
546 | ||
01e3b242 MKG |
547 | If the value contains an C<@>, it is assumed to be an email address and used as |
548 | a global envelope sender. Expected usage in this case is to simply set the | |
549 | same envelope sender on all mail from RT, without defining | |
550 | C<$OverrideOutgoingMailFrom>. If you do define C<$OverrideOutgoingMailFrom>, | |
551 | anything specified there overrides the global value (including Default). | |
552 | ||
5b0d0914 MKG |
553 | This option only works if C<$MailCommand> is set to 'sendmailpipe'. |
554 | ||
84fb5b46 MKG |
555 | =cut |
556 | ||
557 | Set($SetOutgoingMailFrom, 0); | |
558 | ||
559 | =item C<$OverrideOutgoingMailFrom> | |
560 | ||
561 | C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond | |
562 | address of the queue as it is handed to sendmail -f. This helps force | |
563 | the From_ header away from www-data or other email addresses that show | |
564 | up in the "Sent by" line in Outlook. | |
565 | ||
566 | The option is a hash reference of queue name to email address. If | |
567 | there is no ticket involved, then the value of the C<Default> key will | |
568 | be used. | |
569 | ||
5b0d0914 MKG |
570 | This option only works if C<$SetOutgoingMailFrom> is enabled and |
571 | C<$MailCommand> is set to 'sendmailpipe'. | |
84fb5b46 MKG |
572 | |
573 | =cut | |
574 | ||
575 | Set($OverrideOutgoingMailFrom, { | |
576 | # 'Default' => 'admin@rt.example.com', | |
577 | # 'General' => 'general@rt.example.com', | |
578 | }); | |
579 | ||
580 | =item C<$DefaultMailPrecedence> | |
581 | ||
582 | C<$DefaultMailPrecedence> is used to control the default Precedence | |
583 | level of outgoing mail where none is specified. By default it is | |
584 | C<bulk>, but if you only send mail to your staff, you may wish to | |
585 | change it. | |
586 | ||
587 | Note that you can set the precedence of individual templates by | |
588 | including an explicit Precedence header. | |
589 | ||
590 | If you set this value to C<undef> then we do not set a default | |
591 | Precedence header to outgoing mail. However, if there already is a | |
592 | Precedence header, it will be preserved. | |
593 | ||
594 | =cut | |
595 | ||
596 | Set($DefaultMailPrecedence, "bulk"); | |
597 | ||
598 | =item C<$DefaultErrorMailPrecedence> | |
599 | ||
600 | C<$DefaultErrorMailPrecedence> is used to control the default | |
601 | Precedence level of outgoing mail that indicates some kind of error | |
602 | condition. By default it is C<bulk>, but if you only send mail to your | |
603 | staff, you may wish to change it. | |
604 | ||
605 | If you set this value to C<undef> then we do not add a Precedence | |
606 | header to error mail. | |
607 | ||
608 | =cut | |
609 | ||
610 | Set($DefaultErrorMailPrecedence, "bulk"); | |
611 | ||
612 | =item C<$UseOriginatorHeader> | |
613 | ||
614 | C<$UseOriginatorHeader> is used to control the insertion of an | |
615 | RT-Originator Header in every outgoing mail, containing the mail | |
616 | address of the transaction creator. | |
617 | ||
618 | =cut | |
619 | ||
620 | Set($UseOriginatorHeader, 1); | |
621 | ||
622 | =item C<$UseFriendlyFromLine> | |
623 | ||
624 | By default, RT sets the outgoing mail's "From:" header to "SenderName | |
625 | via RT". Setting C<$UseFriendlyFromLine> to 0 disables it. | |
626 | ||
627 | =cut | |
628 | ||
629 | Set($UseFriendlyFromLine, 1); | |
630 | ||
631 | =item C<$FriendlyFromLineFormat> | |
632 | ||
633 | C<sprintf()> format of the friendly 'From:' header; its arguments are | |
634 | SenderName and SenderEmailAddress. | |
635 | ||
636 | =cut | |
637 | ||
638 | Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>"); | |
639 | ||
640 | =item C<$UseFriendlyToLine> | |
641 | ||
642 | RT can optionally set a "Friendly" 'To:' header when sending messages | |
643 | to Ccs or AdminCcs (rather than having a blank 'To:' header. | |
644 | ||
645 | This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you | |
646 | are using sendmail, rather than postfix, qmail, exim or some other | |
647 | MTA, you _must_ disable this option. | |
648 | ||
649 | =cut | |
650 | ||
651 | Set($UseFriendlyToLine, 0); | |
652 | ||
653 | =item C<$FriendlyToLineFormat> | |
654 | ||
655 | C<sprintf()> format of the friendly 'To:' header; its arguments are | |
656 | WatcherType and TicketId. | |
657 | ||
658 | =cut | |
659 | ||
660 | Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;"); | |
661 | ||
662 | =item C<$NotifyActor> | |
663 | ||
664 | By default, RT doesn't notify the person who performs an update, as | |
665 | they already know what they've done. If you'd like to change this | |
666 | behavior, Set C<$NotifyActor> to 1 | |
667 | ||
668 | =cut | |
669 | ||
670 | Set($NotifyActor, 0); | |
671 | ||
672 | =item C<$RecordOutgoingEmail> | |
673 | ||
674 | By default, RT records each message it sends out to its own internal | |
675 | database. To change this behavior, set C<$RecordOutgoingEmail> to 0 | |
676 | ||
dab09ea8 MKG |
677 | If this is disabled, users' digest mail delivery preferences |
678 | (i.e. EmailFrequency) will also be ignored. | |
679 | ||
84fb5b46 MKG |
680 | =cut |
681 | ||
682 | Set($RecordOutgoingEmail, 1); | |
683 | ||
684 | =item C<$VERPPrefix>, C<$VERPDomain> | |
685 | ||
686 | Setting these options enables VERP support | |
687 | L<http://cr.yp.to/proto/verp.txt>. | |
688 | ||
689 | Uncomment the following two directives to generate envelope senders | |
690 | of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}> | |
691 | (i.e. rt-jesse=fsck.com@rt.example.com ). | |
692 | ||
693 | This currently only works with sendmail and sendmailpipe. | |
694 | ||
695 | =cut | |
696 | ||
697 | # Set($VERPPrefix, "rt-"); | |
698 | # Set($VERPDomain, $RT::Organization); | |
699 | ||
700 | ||
701 | =item C<$ForwardFromUser> | |
702 | ||
703 | By default, RT forwards a message using queue's address and adds RT's | |
704 | tag into subject of the outgoing message, so recipients' replies go | |
705 | into RT as correspondents. | |
706 | ||
707 | To change this behavior, set C<$ForwardFromUser> to 1 and RT | |
708 | will use the address of the current user and remove RT's subject tag. | |
709 | ||
710 | =cut | |
711 | ||
712 | Set($ForwardFromUser, 0); | |
713 | ||
714 | =back | |
715 | ||
716 | =head2 Email dashboards | |
717 | ||
718 | =over 4 | |
719 | ||
720 | =item C<$DashboardAddress> | |
721 | ||
722 | The email address from which RT will send dashboards. If none is set, | |
723 | then C<$OwnerEmail> will be used. | |
724 | ||
725 | =cut | |
726 | ||
727 | Set($DashboardAddress, ''); | |
728 | ||
729 | =item C<$DashboardSubject> | |
730 | ||
731 | Lets you set the subject of dashboards. Arguments are the frequency (Daily, | |
732 | Weekly, Monthly) of the dashboard and the dashboard's name. | |
733 | ||
734 | =cut | |
735 | ||
736 | Set($DashboardSubject, "%s Dashboard: %s"); | |
737 | ||
738 | =item C<@EmailDashboardRemove> | |
739 | ||
740 | A list of regular expressions that will be used to remove content from | |
741 | mailed dashboards. | |
742 | ||
743 | =cut | |
744 | ||
745 | Set(@EmailDashboardRemove, ()); | |
746 | ||
747 | =back | |
748 | ||
749 | ||
750 | ||
751 | =head2 Sendmail configuration | |
752 | ||
753 | These options only take effect if C<$MailCommand> is 'sendmail' or | |
754 | 'sendmailpipe' | |
755 | ||
756 | =over 4 | |
757 | ||
758 | =item C<$SendmailArguments> | |
759 | ||
760 | C<$SendmailArguments> defines what flags to pass to C<$SendmailPath> | |
af59614d | 761 | These options are good for most sendmail wrappers and work-a-likes. |
84fb5b46 MKG |
762 | |
763 | These arguments are good for sendmail brand sendmail 8 and newer: | |
af59614d | 764 | C<Set($SendmailArguments,"-oi -ODeliveryMode=b -OErrorMode=m");> |
84fb5b46 MKG |
765 | |
766 | =cut | |
767 | ||
af59614d | 768 | Set($SendmailArguments, "-oi"); |
84fb5b46 MKG |
769 | |
770 | ||
771 | =item C<$SendmailBounceArguments> | |
772 | ||
773 | C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail> | |
774 | assuming RT needs to send an error (i.e. bounce). | |
775 | ||
776 | =cut | |
777 | ||
778 | Set($SendmailBounceArguments, '-f "<>"'); | |
779 | ||
780 | =item C<$SendmailPath> | |
781 | ||
782 | If you selected 'sendmailpipe' above, you MUST specify the path to | |
783 | your sendmail binary in C<$SendmailPath>. | |
784 | ||
785 | =cut | |
786 | ||
787 | Set($SendmailPath, "/usr/sbin/sendmail"); | |
788 | ||
789 | ||
84fb5b46 MKG |
790 | =back |
791 | ||
792 | =head2 Other mailers | |
793 | ||
794 | =over 4 | |
795 | ||
796 | =item C<@MailParams> | |
797 | ||
798 | C<@MailParams> defines a list of options passed to $MailCommand if it | |
af59614d | 799 | is not 'sendmailpipe' or 'sendmail'; |
84fb5b46 MKG |
800 | |
801 | =cut | |
802 | ||
803 | Set(@MailParams, ()); | |
804 | ||
805 | =back | |
806 | ||
807 | ||
808 | =head1 Web interface | |
809 | ||
810 | =over 4 | |
811 | ||
812 | =item C<$WebDefaultStylesheet> | |
813 | ||
814 | This determines the default stylesheet the RT web interface will use. | |
815 | RT ships with several themes by default: | |
816 | ||
af59614d | 817 | rudder The default theme for RT 4.2 |
84fb5b46 | 818 | aileron The default layout for RT 4.0 |
af59614d | 819 | web2 The default layout for RT 3.8 |
84fb5b46 MKG |
820 | ballard Theme which doesn't rely on JavaScript for menuing |
821 | ||
af59614d | 822 | This value actually specifies a directory in F<share/static/css/> |
84fb5b46 MKG |
823 | from which RT will try to load the file main.css (which should @import |
824 | any other files the stylesheet needs). This allows you to easily and | |
825 | cleanly create your own stylesheets to apply to RT. This option can | |
826 | be overridden by users in their preferences. | |
827 | ||
828 | =cut | |
829 | ||
af59614d | 830 | Set($WebDefaultStylesheet, "rudder"); |
84fb5b46 MKG |
831 | |
832 | =item C<$DefaultQueue> | |
833 | ||
834 | Use this to select the default queue name that will be used for | |
835 | creating new tickets. You may use either the queue's name or its | |
836 | ID. This only affects the queue selection boxes on the web interface. | |
837 | ||
838 | =cut | |
839 | ||
840 | # Set($DefaultQueue, "General"); | |
841 | ||
842 | =item C<$RememberDefaultQueue> | |
843 | ||
844 | When a queue is selected in the new ticket dropdown, make it the new | |
845 | default for the new ticket dropdown. | |
846 | ||
847 | =cut | |
848 | ||
849 | # Set($RememberDefaultQueue, 1); | |
850 | ||
851 | =item C<$EnableReminders> | |
852 | ||
853 | Hide all links and portlets related to Reminders by setting this to 0 | |
854 | ||
855 | =cut | |
856 | ||
857 | Set($EnableReminders, 1); | |
858 | ||
859 | =item C<@CustomFieldValuesSources> | |
860 | ||
861 | Set C<@CustomFieldValuesSources> to a list of class names which extend | |
862 | L<RT::CustomFieldValues::External>. This can be used to pull lists of | |
863 | custom field values from external sources at runtime. | |
864 | ||
865 | =cut | |
866 | ||
867 | Set(@CustomFieldValuesSources, ()); | |
868 | ||
af59614d MKG |
869 | =item C<%CustomFieldGroupings> |
870 | ||
871 | This option affects the display of ticket and user custom fields in the | |
872 | web interface. It does not address the sorting of custom fields within | |
873 | the groupings; which is controlled by the Ticket Custom Fields tab in | |
874 | Queue Configuration in the Admin UI. | |
875 | ||
876 | A nested datastructure defines how to group together custom fields | |
877 | under a mix of built-in and arbitrary headings ("groupings"). | |
878 | ||
879 | Set C<%CustomFieldGroupings> to a nested structure similar to the following: | |
880 | ||
881 | Set(%CustomFieldGroupings, | |
882 | 'RT::Ticket' => [ | |
883 | 'Grouping Name' => ['CF Name', 'Another CF'], | |
884 | 'Another Grouping' => ['Some CF'], | |
885 | 'Dates' => ['Shipped date'], | |
886 | ], | |
887 | 'RT::User' => [ | |
888 | 'Phones' => ['Fax number'], | |
889 | ], | |
890 | ); | |
891 | ||
892 | The first level keys are record types for which CFs may be used, and the | |
893 | values are either hashrefs or arrayrefs -- if arrayrefs, then the | |
894 | ordering is preserved during display, otherwise groupings are displayed | |
895 | alphabetically. The second level keys are the grouping names and the | |
896 | values are array refs containing a list of CF names. | |
897 | ||
898 | There are several special built-in groupings which RT displays in | |
899 | specific places (usually the collapsible box of the same title). The | |
900 | ordering of these standard groupings cannot be modified. You may also | |
901 | only append Custom Fields to the list in these boxes, not reorder or | |
902 | remove core fields. | |
903 | ||
904 | For C<RT::Ticket>, these groupings are: C<Basics>, C<Dates>, C<Links>, C<People> | |
905 | ||
906 | For C<RT::User>: C<Identity>, C<Access control>, C<Location>, C<Phones> | |
907 | ||
908 | Extensions may also add their own built-in groupings, refer to the individual | |
909 | extension documentation for those. | |
910 | ||
84fb5b46 MKG |
911 | =item C<$CanonicalizeRedirectURLs> |
912 | ||
913 | Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when | |
914 | redirecting rather than the one we get from C<%ENV>. | |
915 | ||
916 | Apache's UseCanonicalName directive changes the hostname that RT | |
917 | finds in C<%ENV>. You can read more about what turning it On or Off | |
918 | means in the documentation for your version of Apache. | |
919 | ||
920 | If you use RT behind a reverse proxy, you almost certainly want to | |
921 | enable this option. | |
922 | ||
923 | =cut | |
924 | ||
925 | Set($CanonicalizeRedirectURLs, 0); | |
926 | ||
af59614d | 927 | =item C<$CanonicalizeURLsInFeeds> |
84fb5b46 | 928 | |
af59614d MKG |
929 | Set C<$CanonicalizeURLsInFeeds> to 1 to use C<$WebURL> in feeds |
930 | rather than the one we get from request. | |
84fb5b46 | 931 | |
af59614d MKG |
932 | If you use RT behind a reverse proxy, you almost certainly want to |
933 | enable this option. | |
b5747ff2 | 934 | |
84fb5b46 MKG |
935 | =cut |
936 | ||
af59614d MKG |
937 | Set($CanonicalizeURLsInFeeds, 0); |
938 | ||
939 | =item C<@JSFiles> | |
940 | ||
941 | A list of additional JavaScript files to be included in head. | |
942 | ||
943 | =cut | |
944 | ||
945 | Set(@JSFiles, qw//); | |
84fb5b46 MKG |
946 | |
947 | =item C<$JSMinPath> | |
948 | ||
949 | Path to the jsmin binary; if specified, it will be used to minify | |
950 | C<JSFiles>. The default, and the fallback if the binary cannot be | |
951 | found, is to simply concatenate the files. | |
952 | ||
953 | jsmin can be installed by running 'make jsmin' from the RT install | |
954 | directory, or from http://www.crockford.com/javascript/jsmin.html | |
955 | ||
956 | =cut | |
957 | ||
958 | # Set($JSMinPath, "/path/to/jsmin"); | |
959 | ||
960 | =item C<@CSSFiles> | |
961 | ||
962 | A list of additional CSS files to be included in head. | |
963 | ||
b5747ff2 MKG |
964 | If you're a plugin author, refer to RT->AddStyleSheets. |
965 | ||
84fb5b46 MKG |
966 | =cut |
967 | ||
968 | Set(@CSSFiles, qw//); | |
969 | ||
970 | =item C<$UsernameFormat> | |
971 | ||
af59614d MKG |
972 | This determines how user info is displayed. 'concise' will show the |
973 | first of RealName, Name or EmailAddress that has a value. 'verbose' will | |
974 | show EmailAddress, and the first of RealName or Name which is defined. | |
975 | ||
976 | =cut | |
977 | ||
978 | Set($UsernameFormat, "role"); | |
979 | ||
980 | =item C<$UserSearchResultFormat> | |
981 | ||
982 | This controls the display of lists of users returned from the User | |
983 | Summary Search. The display of users in the Admin interface is | |
984 | controlled by C<%AdminSearchResultFormat>. | |
985 | ||
986 | =cut | |
987 | ||
988 | Set($UserSearchResultFormat, | |
989 | q{ '<a href="__WebPath__/User/Summary.html?id=__id__">__id__</a>/TITLE:#'} | |
990 | .q{,'<a href="__WebPath__/User/Summary.html?id=__id__">__Name__</a>/TITLE:Name'} | |
991 | .q{,__RealName__, __EmailAddress__} | |
992 | ); | |
993 | ||
994 | =item C<@UserSummaryPortlets> | |
995 | ||
996 | A list of portlets to be displayed on the User Summary page. | |
997 | By default, we show all of the available portlets. | |
998 | Extensions may provide their own portlets for this page. | |
999 | ||
1000 | =cut | |
1001 | ||
1002 | Set(@UserSummaryPortlets, (qw/ExtraInfo CreateTicket ActiveTickets InactiveTickets/)); | |
1003 | ||
1004 | =item C<$UserSummaryExtraInfo> | |
1005 | ||
1006 | This controls what information is displayed on the User Summary | |
1007 | portal. By default the user's Real Name, Email Address and Username | |
1008 | are displayed. You can remove these or add more as needed. This | |
1009 | expects a Format string of user attributes. Please note that not all | |
1010 | the attributes are supported in this display because we're not | |
1011 | building a table. | |
84fb5b46 MKG |
1012 | |
1013 | =cut | |
1014 | ||
af59614d MKG |
1015 | Set($UserSummaryExtraInfo, "RealName, EmailAddress, Name"); |
1016 | ||
1017 | =item C<$UserSummaryTicketListFormat> | |
1018 | ||
1019 | Control the appearance of the Active and Inactive ticket lists in the | |
1020 | User Summary. | |
1021 | ||
1022 | =cut | |
1023 | ||
1024 | Set($UserSummaryTicketListFormat, q{ | |
1025 | '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#', | |
1026 | '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject', | |
1027 | Status, | |
1028 | QueueName, | |
1029 | Owner, | |
1030 | Priority, | |
1031 | '__NEWLINE__', | |
1032 | '', | |
1033 | '<small>__Requestors__</small>', | |
1034 | '<small>__CreatedRelative__</small>', | |
1035 | '<small>__ToldRelative__</small>', | |
1036 | '<small>__LastUpdatedRelative__</small>', | |
1037 | '<small>__TimeLeft__</small>' | |
1038 | }); | |
84fb5b46 MKG |
1039 | |
1040 | =item C<$WebBaseURL>, C<$WebURL> | |
1041 | ||
1042 | Usually you don't want to set these options. The only obvious reason | |
1043 | is if RT is accessible via https protocol on a non standard port, e.g. | |
1044 | 'https://rt.example.com:9999'. In all other cases these options are | |
1045 | computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>. | |
1046 | ||
1047 | C<$WebBaseURL> is the scheme, server and port | |
1048 | (e.g. 'http://rt.example.com') for constructing URLs to the web | |
1049 | UI. C<$WebBaseURL> doesn't need a trailing /. | |
1050 | ||
1051 | C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for | |
1052 | example: 'http://www.example.com/rt/'. | |
1053 | ||
1054 | =cut | |
1055 | ||
1056 | my $port = RT->Config->Get('WebPort'); | |
1057 | Set($WebBaseURL, | |
1058 | ($port == 443? 'https': 'http') .'://' | |
1059 | . RT->Config->Get('WebDomain') | |
1060 | . ($port != 80 && $port != 443? ":$port" : '') | |
1061 | ); | |
1062 | ||
1063 | Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/"); | |
1064 | ||
1065 | =item C<$WebImagesURL> | |
1066 | ||
1067 | C<$WebImagesURL> points to the base URL where RT can find its images. | |
1068 | Define the directory name to be used for images in RT web documents. | |
1069 | ||
1070 | =cut | |
1071 | ||
af59614d | 1072 | Set($WebImagesURL, RT->Config->Get('WebPath') . "/static/images/"); |
84fb5b46 MKG |
1073 | |
1074 | =item C<$LogoURL> | |
1075 | ||
1076 | C<$LogoURL> points to the URL of the RT logo displayed in the web UI. | |
1077 | This can also be configured via the web UI. | |
1078 | ||
1079 | =cut | |
1080 | ||
1081 | Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png"); | |
1082 | ||
1083 | =item C<$LogoLinkURL> | |
1084 | ||
1085 | C<$LogoLinkURL> is the URL that the RT logo hyperlinks to. | |
1086 | ||
1087 | =cut | |
1088 | ||
1089 | Set($LogoLinkURL, "http://bestpractical.com"); | |
1090 | ||
1091 | =item C<$LogoAltText> | |
1092 | ||
1093 | C<$LogoAltText> is a string of text for the alt-text of the logo. It | |
1094 | will be passed through C<loc> for localization. | |
1095 | ||
1096 | =cut | |
1097 | ||
1098 | Set($LogoAltText, "Best Practical Solutions, LLC corporate logo"); | |
1099 | ||
1100 | =item C<$LogoImageHeight> | |
1101 | ||
1102 | C<$LogoImageHeight> is the value of the C<height> attribute of the logo | |
1103 | C<img> tag. | |
1104 | ||
1105 | =cut | |
1106 | ||
1107 | Set($LogoImageHeight, 38); | |
1108 | ||
1109 | =item C<$LogoImageWidth> | |
1110 | ||
1111 | C<$LogoImageWidth> is the value of the C<width> attribute of the logo | |
1112 | C<img> tag. | |
1113 | ||
1114 | =cut | |
1115 | ||
1116 | Set($LogoImageWidth, 181); | |
1117 | ||
1118 | =item C<$WebNoAuthRegex> | |
1119 | ||
1120 | What portion of RT's URL space should not require authentication. The | |
1121 | default is almost certainly correct, and should only be changed if you | |
1122 | are extending RT. | |
1123 | ||
1124 | =cut | |
1125 | ||
1126 | Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x ); | |
1127 | ||
1128 | =item C<$SelfServiceRegex> | |
1129 | ||
1130 | What portion of RT's URLspace should be accessible to Unprivileged | |
1131 | users This does not override the redirect from F</Ticket/Display.html> | |
1132 | to F</SelfService/Display.html> when Unprivileged users attempt to | |
1133 | access ticked displays. | |
1134 | ||
1135 | =cut | |
1136 | ||
1137 | Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x ); | |
1138 | ||
1139 | =item C<$WebFlushDbCacheEveryRequest> | |
1140 | ||
1141 | By default, RT clears its database cache after every page view. This | |
1142 | ensures that you've always got the most current information when | |
1143 | working in a multi-process (mod_perl or FastCGI) Environment. Setting | |
1144 | C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will | |
1145 | speed RT up a bit, at the expense of a tiny bit of data accuracy. | |
1146 | ||
1147 | =cut | |
1148 | ||
1149 | Set($WebFlushDbCacheEveryRequest, 1); | |
1150 | ||
1151 | =item C<%ChartFont> | |
1152 | ||
1153 | The L<GD> module (which RT uses for graphs) ships with a built-in font | |
1154 | that doesn't have full Unicode support. You can use a given TrueType | |
1155 | font for a specific language by setting %ChartFont to (language =E<gt> | |
1156 | the absolute path of a font) pairs. Your GD library must have support | |
1157 | for TrueType fonts to use this option. If there is no entry for a | |
1158 | language in the hash then font with 'others' key is used. | |
1159 | ||
1160 | RT comes with two TrueType fonts covering most available languages. | |
1161 | ||
1162 | =cut | |
1163 | ||
1164 | Set( | |
1165 | %ChartFont, | |
1166 | 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf", | |
1167 | 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf", | |
1168 | 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf", | |
1169 | 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf", | |
1170 | ); | |
1171 | ||
1172 | =item C<$ChartsTimezonesInDB> | |
1173 | ||
1174 | RT stores dates using the UTC timezone in the DB, so charts grouped by | |
1175 | dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1 | |
1176 | to enable timezone conversions using your DB's capabilities. You may | |
1177 | need to do some work on the DB side to use this feature, read more in | |
1178 | F<docs/customizing/timezones_in_charts.pod>. | |
1179 | ||
1180 | At this time, this feature only applies to MySQL and PostgreSQL. | |
1181 | ||
1182 | =cut | |
1183 | ||
1184 | Set($ChartsTimezonesInDB, 0); | |
1185 | ||
af59614d MKG |
1186 | =item C<@ChartColors> |
1187 | ||
1188 | An array of 6-digit hexadecimal RGB color values used for chart series. By | |
1189 | default there are 12 distinct colors. | |
1190 | ||
1191 | =cut | |
1192 | ||
1193 | Set(@ChartColors, qw( | |
1194 | 66cc66 ff6666 ffcc66 663399 | |
1195 | 3333cc 339933 993333 996633 | |
1196 | 33cc33 cc3333 cc9933 6633cc | |
1197 | )); | |
1198 | ||
84fb5b46 MKG |
1199 | =back |
1200 | ||
1201 | ||
1202 | ||
1203 | =head2 Home page | |
1204 | ||
1205 | =over 4 | |
1206 | ||
1207 | =item C<$DefaultSummaryRows> | |
1208 | ||
1209 | C<$DefaultSummaryRows> is default number of rows displayed in for | |
1210 | search results on the front page. | |
1211 | ||
1212 | =cut | |
1213 | ||
1214 | Set($DefaultSummaryRows, 10); | |
1215 | ||
1216 | =item C<$HomePageRefreshInterval> | |
1217 | ||
1218 | C<$HomePageRefreshInterval> is default number of seconds to refresh | |
1219 | the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200]. | |
1220 | ||
1221 | =cut | |
1222 | ||
1223 | Set($HomePageRefreshInterval, 0); | |
1224 | ||
1225 | =item C<$HomepageComponents> | |
1226 | ||
1227 | C<$HomepageComponents> is an arrayref of allowed components on a | |
1228 | user's customized homepage ("RT at a glance"). | |
1229 | ||
1230 | =cut | |
1231 | ||
5b0d0914 MKG |
1232 | Set( |
1233 | $HomepageComponents, | |
1234 | [ | |
af59614d | 1235 | qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches FindUser) # loc_qw |
5b0d0914 MKG |
1236 | ] |
1237 | ); | |
84fb5b46 MKG |
1238 | |
1239 | =back | |
1240 | ||
1241 | ||
1242 | ||
1243 | ||
1244 | =head2 Ticket search | |
1245 | ||
1246 | =over 4 | |
1247 | ||
1248 | =item C<$UseSQLForACLChecks> | |
1249 | ||
1250 | Historically, ACLs were checked on display, which could lead to empty | |
af59614d MKG |
1251 | search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 0 |
1252 | to go back to this method; this will reduce the complexity of the | |
1253 | generated SQL statements, at the cost of the aforementioned bugs. | |
84fb5b46 MKG |
1254 | |
1255 | =cut | |
1256 | ||
af59614d | 1257 | Set($UseSQLForACLChecks, 1); |
84fb5b46 MKG |
1258 | |
1259 | =item C<$TicketsItemMapSize> | |
1260 | ||
1261 | On the display page of a ticket from search results, RT provides links | |
1262 | to the first, next, previous and last ticket from the results. In | |
1263 | order to build these links, RT needs to fetch the full result set from | |
1264 | the database, which can be resource-intensive. | |
1265 | ||
1266 | Set C<$TicketsItemMapSize> to number of tickets you want RT to examine | |
1267 | to build these links. If the full result set is larger than this | |
1268 | number, RT will omit the "last" link in the menu. Set this to zero to | |
1269 | always examine all results. | |
1270 | ||
1271 | =cut | |
1272 | ||
1273 | Set($TicketsItemMapSize, 1000); | |
1274 | ||
1275 | =item C<$SearchResultsRefreshInterval> | |
1276 | ||
1277 | C<$SearchResultsRefreshInterval> is default number of seconds to | |
1278 | refresh search results in RT. Choose from [0, 120, 300, 600, 1200, | |
1279 | 3600, 7200]. | |
1280 | ||
1281 | =cut | |
1282 | ||
1283 | Set($SearchResultsRefreshInterval, 0); | |
1284 | ||
1285 | =item C<$DefaultSearchResultFormat> | |
1286 | ||
1287 | C<$DefaultSearchResultFormat> is the default format for RT search | |
1288 | results | |
1289 | ||
1290 | =cut | |
1291 | ||
1292 | Set ($DefaultSearchResultFormat, qq{ | |
1293 | '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#', | |
1294 | '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject', | |
1295 | Status, | |
1296 | QueueName, | |
af59614d | 1297 | Owner, |
84fb5b46 MKG |
1298 | Priority, |
1299 | '__NEWLINE__', | |
1300 | '', | |
1301 | '<small>__Requestors__</small>', | |
1302 | '<small>__CreatedRelative__</small>', | |
1303 | '<small>__ToldRelative__</small>', | |
1304 | '<small>__LastUpdatedRelative__</small>', | |
1305 | '<small>__TimeLeft__</small>'}); | |
1306 | ||
1307 | =item C<$DefaultSelfServiceSearchResultFormat> | |
1308 | ||
1309 | C<$DefaultSelfServiceSearchResultFormat> is the default format of | |
1310 | searches displayed in the SelfService interface. | |
1311 | ||
1312 | =cut | |
1313 | ||
1314 | Set($DefaultSelfServiceSearchResultFormat, qq{ | |
1315 | '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#', | |
1316 | '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject', | |
1317 | Status, | |
1318 | Requestors, | |
af59614d | 1319 | Owner}); |
84fb5b46 MKG |
1320 | |
1321 | =item C<%FullTextSearch> | |
1322 | ||
1323 | Full text search (FTS) without database indexing is a very slow | |
1324 | operation, and is thus disabled by default. | |
1325 | ||
1326 | Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for | |
1327 | the full details of FTS on your particular database. | |
1328 | ||
1329 | It is possible to enable FTS without database indexing support, simply | |
1330 | by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0. | |
1331 | This is not generally suggested, as unindexed full-text searching can | |
1332 | cause severe performance problems. | |
1333 | ||
1334 | =cut | |
1335 | ||
1336 | Set(%FullTextSearch, | |
1337 | Enable => 0, | |
1338 | Indexed => 0, | |
1339 | ); | |
1340 | ||
5b0d0914 MKG |
1341 | =item C<$DontSearchFileAttachments> |
1342 | ||
1343 | If C<$DontSearchFileAttachments> is set to 1, then uploaded files | |
1344 | (attachments with file names) are not searched during content | |
1345 | search. | |
1346 | ||
1347 | Note that if you use indexed FTS then named attachments are still | |
1348 | indexed by default regardless of this option. | |
1349 | ||
1350 | =cut | |
1351 | ||
1352 | Set($DontSearchFileAttachments, undef); | |
84fb5b46 MKG |
1353 | |
1354 | =item C<$OnlySearchActiveTicketsInSimpleSearch> | |
1355 | ||
1356 | When query in simple search doesn't have status info, use this to only | |
1357 | search active ones. | |
1358 | ||
1359 | =cut | |
1360 | ||
1361 | Set($OnlySearchActiveTicketsInSimpleSearch, 1); | |
1362 | ||
1363 | =item C<$SearchResultsAutoRedirect> | |
1364 | ||
1365 | When only one ticket is found in search, use this to redirect to the | |
1366 | ticket display page automatically. | |
1367 | ||
1368 | =cut | |
1369 | ||
1370 | Set($SearchResultsAutoRedirect, 0); | |
1371 | ||
1372 | =back | |
1373 | ||
1374 | ||
1375 | ||
1376 | =head2 Ticket display | |
1377 | ||
1378 | =over 4 | |
1379 | ||
1380 | =item C<$ShowMoreAboutPrivilegedUsers> | |
1381 | ||
1382 | This determines if the 'More about requestor' box on | |
1383 | Ticket/Display.html is shown for Privileged Users. | |
1384 | ||
1385 | =cut | |
1386 | ||
1387 | Set($ShowMoreAboutPrivilegedUsers, 0); | |
1388 | ||
1389 | =item C<$MoreAboutRequestorTicketList> | |
1390 | ||
1391 | This can be set to Active, Inactive, All or None. It controls what | |
1392 | ticket list will be displayed in the 'More about requestor' box on | |
1393 | Ticket/Display.html. This option can be controlled by users also. | |
1394 | ||
1395 | =cut | |
1396 | ||
1397 | Set($MoreAboutRequestorTicketList, "Active"); | |
1398 | ||
af59614d MKG |
1399 | =item C<$MoreAboutRequestorTicketListFormat> |
1400 | ||
1401 | Control the appearance of the ticket lists in the 'More About Requestors' box. | |
1402 | ||
1403 | =cut | |
1404 | ||
1405 | Set($MoreAboutRequestorTicketListFormat, q{ | |
1406 | '<a href="__WebPath__/Ticket/Display.html?id=__id__">__id__</a>', | |
1407 | '__Owner__', | |
1408 | '<a href="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a>', | |
1409 | '__Status__', | |
1410 | }); | |
1411 | ||
1412 | ||
84fb5b46 MKG |
1413 | =item C<$MoreAboutRequestorExtraInfo> |
1414 | ||
1415 | By default, the 'More about requestor' box on Ticket/Display.html | |
1416 | shows the Requestor's name and ticket list. If you would like to see | |
1417 | extra information about the user, this expects a Format string of user | |
1418 | attributes. Please note that not all the attributes are supported in | |
1419 | this display because we're not building a table. | |
1420 | ||
1421 | Example: | |
1422 | C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")> | |
1423 | ||
1424 | =cut | |
1425 | ||
1426 | Set($MoreAboutRequestorExtraInfo, ""); | |
1427 | ||
1428 | =item C<$MoreAboutRequestorGroupsLimit> | |
1429 | ||
1430 | By default, the 'More about requestor' box on Ticket/Display.html | |
1431 | shows all the groups of the Requestor. Use this to limit the number | |
1432 | of groups; a value of undef removes the group display entirely. | |
1433 | ||
1434 | =cut | |
1435 | ||
1436 | Set($MoreAboutRequestorGroupsLimit, 0); | |
1437 | ||
1438 | =item C<$UseSideBySideLayout> | |
1439 | ||
1440 | Should the ticket create and update forms use a more space efficient | |
1441 | two column layout. This layout may not work in narrow browsers if you | |
1442 | set a MessageBoxWidth (below). | |
1443 | ||
1444 | =cut | |
1445 | ||
1446 | Set($UseSideBySideLayout, 1); | |
1447 | ||
1448 | =item C<$EditCustomFieldsSingleColumn> | |
1449 | ||
1450 | When displaying a list of Ticket Custom Fields for editing, RT | |
1451 | defaults to a 2 column list. If you set this to 1, it will instead | |
1452 | display the Custom Fields in a single column. | |
1453 | ||
1454 | =cut | |
1455 | ||
1456 | Set($EditCustomFieldsSingleColumn, 0); | |
1457 | ||
1458 | =item C<$ShowUnreadMessageNotifications> | |
1459 | ||
1460 | If set to 1, RT will prompt users when there are new, | |
1461 | unread messages on tickets they are viewing. | |
1462 | ||
1463 | =cut | |
1464 | ||
1465 | Set($ShowUnreadMessageNotifications, 0); | |
1466 | ||
1467 | =item C<$AutocompleteOwners> | |
1468 | ||
1469 | If set to 1, the owner drop-downs for ticket update/modify and the query | |
1470 | builder are replaced by text fields that autocomplete. This can | |
1471 | alleviate the sometimes huge owner list for installations where many | |
1472 | users have the OwnTicket right. | |
1473 | ||
af59614d MKG |
1474 | Autocompleter is automatically turned on if list contains more than |
1475 | 50 users, but penalty of executing potentially slow query is still paid. | |
1476 | ||
1477 | Drop down doesn't show unprivileged users. If your setup allows unprivileged | |
1478 | to own ticket then you have to enable autocompleting. | |
1479 | ||
84fb5b46 MKG |
1480 | =cut |
1481 | ||
1482 | Set($AutocompleteOwners, 0); | |
1483 | ||
1484 | =item C<$AutocompleteOwnersForSearch> | |
1485 | ||
1486 | If set to 1, the owner drop-downs for the query builder are always | |
1487 | replaced by text field that autocomplete and C<$AutocompleteOwners> | |
1488 | is ignored. Helpful when owners list is huge in the query builder. | |
1489 | ||
1490 | =cut | |
1491 | ||
1492 | Set($AutocompleteOwnersForSearch, 0); | |
1493 | ||
af59614d | 1494 | =item C<$UserSearchFields> |
84fb5b46 | 1495 | |
af59614d MKG |
1496 | Used by the User Autocompleter as well as the User Search. |
1497 | ||
1498 | Specifies which fields of L<RT::User> to match against and how to match | |
1499 | each field when autocompleting users. Valid match methods are LIKE, | |
1500 | STARTSWITH, ENDSWITH, =, and !=. Valid search fields are the core User | |
1501 | fields, as well as custom fields, which are specified as "CF.1234" or | |
1502 | "CF.Name" | |
84fb5b46 MKG |
1503 | |
1504 | =cut | |
1505 | ||
af59614d | 1506 | Set($UserSearchFields, { |
84fb5b46 MKG |
1507 | EmailAddress => 'STARTSWITH', |
1508 | Name => 'STARTSWITH', | |
1509 | RealName => 'LIKE', | |
1510 | }); | |
1511 | ||
1512 | =item C<$AllowUserAutocompleteForUnprivileged> | |
1513 | ||
1514 | Should unprivileged users be allowed to autocomplete users. Setting | |
1515 | this option to 1 means unprivileged users will be able to search all | |
1516 | your users. | |
1517 | ||
1518 | =cut | |
1519 | ||
1520 | Set($AllowUserAutocompleteForUnprivileged, 0); | |
1521 | ||
af59614d MKG |
1522 | =item C<$TicketAutocompleteFields> |
1523 | ||
1524 | Specifies which fields of L<RT::Ticket> to match against and how to match each | |
1525 | field when autocompleting users. Valid match methods are LIKE, STARTSWITH, | |
1526 | ENDSWITH, C<=>, and C<!=>. | |
1527 | ||
1528 | Not all Ticket fields are publically accessible and hence won't work for | |
1529 | autocomplete unless you override their accessibility using a local overlay or a | |
1530 | plugin. Out of the box the following fields are public: id, Subject. | |
1531 | ||
1532 | =cut | |
1533 | ||
1534 | Set( $TicketAutocompleteFields, { | |
1535 | id => 'STARTSWITH', | |
1536 | Subject => 'LIKE', | |
1537 | }); | |
1538 | ||
84fb5b46 MKG |
1539 | =item C<$DisplayTicketAfterQuickCreate> |
1540 | ||
1541 | Enable this to redirect to the created ticket display page | |
1542 | automatically when using QuickCreate. | |
1543 | ||
1544 | =cut | |
1545 | ||
1546 | Set($DisplayTicketAfterQuickCreate, 0); | |
1547 | ||
1548 | =item C<$WikiImplicitLinks> | |
1549 | ||
1550 | Support implicit links in WikiText custom fields? Setting this to 1 | |
1551 | causes InterCapped or ALLCAPS words in WikiText fields to automatically | |
1552 | become links to searches for those words. If used on Articles, it links | |
1553 | to the Article with that name. | |
1554 | ||
1555 | =cut | |
1556 | ||
1557 | Set($WikiImplicitLinks, 0); | |
1558 | ||
1559 | =item C<$PreviewScripMessages> | |
1560 | ||
1561 | Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket | |
1562 | reply page should include the content of the messages to be sent. | |
1563 | ||
1564 | =cut | |
1565 | ||
1566 | Set($PreviewScripMessages, 0); | |
1567 | ||
1568 | =item C<$SimplifiedRecipients> | |
1569 | ||
1570 | If C<$SimplifiedRecipients> is set, a simple list of who will receive | |
1571 | B<any> kind of mail will be shown on the ticket reply page, instead of a | |
1572 | detailed breakdown by scrip. | |
1573 | ||
1574 | =cut | |
1575 | ||
1576 | Set($SimplifiedRecipients, 0); | |
1577 | ||
1578 | =item C<$HideResolveActionsWithDependencies> | |
1579 | ||
1580 | If set to 1, this option will skip ticket menu actions which can't be | |
1581 | completed successfully because of outstanding active Depends On tickets. | |
1582 | ||
1583 | By default, all ticket actions are displayed in the menu even if some of | |
1584 | them can't be successful until all Depends On links are resolved or | |
1585 | transitioned to another inactive status. | |
1586 | ||
1587 | =cut | |
1588 | ||
1589 | Set($HideResolveActionsWithDependencies, 0); | |
1590 | ||
1591 | =back | |
1592 | ||
1593 | ||
1594 | ||
1595 | =head2 Articles | |
1596 | ||
1597 | =over 4 | |
1598 | ||
1599 | =item C<$ArticleOnTicketCreate> | |
1600 | ||
1601 | Set this to 1 to display the Articles interface on the Ticket Create | |
1602 | page in addition to the Reply/Comment page. | |
1603 | ||
1604 | =cut | |
1605 | ||
1606 | Set($ArticleOnTicketCreate, 0); | |
1607 | ||
1608 | =item C<$HideArticleSearchOnReplyCreate> | |
1609 | ||
1610 | Set this to 1 to hide the search and include boxes from the Article | |
1611 | UI. This assumes you have enabled Article Hotlist feature, otherwise | |
1612 | you will have no access to Articles. | |
1613 | ||
1614 | =cut | |
1615 | ||
1616 | Set($HideArticleSearchOnReplyCreate, 0); | |
1617 | ||
1618 | =back | |
1619 | ||
1620 | ||
1621 | ||
1622 | =head2 Message box properties | |
1623 | ||
1624 | =over 4 | |
1625 | ||
1626 | =item C<$MessageBoxWidth>, C<$MessageBoxHeight> | |
1627 | ||
1628 | For message boxes, set the entry box width, height and what type of | |
1629 | wrapping to use. These options can be overridden by users in their | |
1630 | preferences. | |
1631 | ||
1632 | When the width is set to undef, no column count is specified and the | |
1633 | message box will take up 100% of the available width. Combining this | |
1634 | with HARD messagebox wrapping (below) is not recommended, as it will | |
1635 | lead to inconsistent width in transactions between browsers. | |
1636 | ||
1637 | These settings only apply to the non-RichText message box. See below | |
1638 | for Rich Text settings. | |
1639 | ||
1640 | =cut | |
1641 | ||
1642 | Set($MessageBoxWidth, undef); | |
1643 | Set($MessageBoxHeight, 15); | |
1644 | ||
84fb5b46 MKG |
1645 | =item C<$MessageBoxRichText> |
1646 | ||
1647 | Should "rich text" editing be enabled? This option lets your users | |
1648 | send HTML email messages from the web interface. | |
1649 | ||
1650 | =cut | |
1651 | ||
1652 | Set($MessageBoxRichText, 1); | |
1653 | ||
1654 | =item C<$MessageBoxRichTextHeight> | |
1655 | ||
1656 | Height of rich text JavaScript enabled editing boxes (in pixels) | |
1657 | ||
1658 | =cut | |
1659 | ||
1660 | Set($MessageBoxRichTextHeight, 200); | |
1661 | ||
1662 | =item C<$MessageBoxIncludeSignature> | |
1663 | ||
1664 | Should your users' signatures (from their Preferences page) be | |
1665 | included in Comments and Replies. | |
1666 | ||
1667 | =cut | |
1668 | ||
1669 | Set($MessageBoxIncludeSignature, 1); | |
1670 | ||
1671 | =item C<$MessageBoxIncludeSignatureOnComment> | |
1672 | ||
1673 | Should your users' signatures (from their Preferences page) be | |
1674 | included in Comments. Setting this to false overrides | |
1675 | C<$MessageBoxIncludeSignature>. | |
1676 | ||
1677 | =cut | |
1678 | ||
1679 | Set($MessageBoxIncludeSignatureOnComment, 1); | |
1680 | ||
1681 | =back | |
1682 | ||
1683 | ||
1684 | =head2 Transaction display | |
1685 | ||
1686 | =over 4 | |
1687 | ||
1688 | =item C<$OldestTransactionsFirst> | |
1689 | ||
1690 | By default, RT shows newest transactions at the bottom of the ticket | |
1691 | history page, if you want see them at the top set this to 0. This | |
1692 | option can be overridden by users in their preferences. | |
1693 | ||
1694 | =cut | |
1695 | ||
1696 | Set($OldestTransactionsFirst, 1); | |
1697 | ||
af59614d MKG |
1698 | =item C<$ShowHistory> |
1699 | ||
1700 | This option controls how history is shown on the ticket display page. It | |
1701 | accepts one of three possible modes and is overrideable on a per-user | |
1702 | preference level. If you regularly deal with long tickets and don't care much | |
1703 | about the history, you may wish to change this option to C<click>. | |
1704 | ||
1705 | =over | |
1706 | ||
1707 | =item C<delay> (the default) | |
1708 | ||
1709 | When set to C<delay>, history is loaded via javascript after the rest of the | |
1710 | page has been loaded. This speeds up apparent page load times and generally | |
1711 | provides a smoother experience. You may notice slight delays before the ticket | |
1712 | history appears on very long tickets. | |
1713 | ||
1714 | =item C<click> | |
1715 | ||
1716 | When set to C<click>, history is loaded on demand when a placeholder link is | |
1717 | clicked. This speeds up ticket display page loads and history is never loaded | |
1718 | if not requested. | |
84fb5b46 | 1719 | |
af59614d MKG |
1720 | =item C<always> |
1721 | ||
1722 | When set to C<always>, history is loaded before showing the page. This ensures | |
1723 | history is always available immediately, but at the expense of longer page load | |
1724 | times. This behaviour was the default in RT 4.0. | |
1725 | ||
1726 | =back | |
84fb5b46 MKG |
1727 | |
1728 | =cut | |
1729 | ||
af59614d | 1730 | Set($ShowHistory, 'delay'); |
84fb5b46 MKG |
1731 | |
1732 | =item C<$ShowBccHeader> | |
1733 | ||
1734 | By default, RT hides from the web UI information about blind copies | |
1735 | user sent on reply or comment. | |
1736 | ||
1737 | =cut | |
1738 | ||
1739 | Set($ShowBccHeader, 0); | |
1740 | ||
1741 | =item C<$TrustHTMLAttachments> | |
1742 | ||
1743 | If C<TrustHTMLAttachments> is not defined, we will display them as | |
1744 | text. This prevents malicious HTML and JavaScript from being sent in a | |
1745 | request (although there is probably more to it than that) | |
1746 | ||
1747 | =cut | |
1748 | ||
1749 | Set($TrustHTMLAttachments, undef); | |
1750 | ||
1751 | =item C<$AlwaysDownloadAttachments> | |
1752 | ||
1753 | Always download attachments, regardless of content type. If set, this | |
1754 | overrides C<TrustHTMLAttachments>. | |
1755 | ||
1756 | =cut | |
1757 | ||
1758 | Set($AlwaysDownloadAttachments, undef); | |
1759 | ||
84fb5b46 MKG |
1760 | =item C<$PreferRichText> |
1761 | ||
af59614d MKG |
1762 | By default, RT shows rich text (HTML) messages if possible. |
1763 | ||
1764 | If C<$PreferRichText> is set to 0, RT will show plain text messages | |
1765 | in preference to any rich text alternatives. | |
84fb5b46 MKG |
1766 | |
1767 | =cut | |
1768 | ||
af59614d | 1769 | Set($PreferRichText, 1); |
84fb5b46 MKG |
1770 | |
1771 | =item C<$MaxInlineBody> | |
1772 | ||
1773 | C<$MaxInlineBody> is the maximum attachment size that we want to see | |
1774 | inline when viewing a transaction. RT will inline any text if the | |
1775 | value is undefined or 0. This option can be overridden by users in | |
1776 | their preferences. | |
1777 | ||
1778 | =cut | |
1779 | ||
1780 | Set($MaxInlineBody, 12000); | |
1781 | ||
1782 | =item C<$ShowTransactionImages> | |
1783 | ||
1784 | By default, RT shows images attached to incoming (and outgoing) ticket | |
1785 | updates inline. Set this variable to 0 if you'd like to disable that | |
1786 | behavior. | |
1787 | ||
1788 | =cut | |
1789 | ||
1790 | Set($ShowTransactionImages, 1); | |
1791 | ||
af59614d | 1792 | =item C<$ShowRemoteImages> |
84fb5b46 | 1793 | |
af59614d MKG |
1794 | By default, RT doesn't show remote images attached to incoming (and outgoing) |
1795 | ticket updates inline. Set this variable to 1 if you'd like to enable remote | |
1796 | image display. Showing remote images may allow spammers and other senders to | |
1797 | track when messages are viewed and see referer information. | |
84fb5b46 | 1798 | |
af59614d | 1799 | Note that this setting is independent of L</$ShowTransactionImages> above. |
84fb5b46 | 1800 | |
af59614d | 1801 | =cut |
84fb5b46 | 1802 | |
af59614d | 1803 | Set($ShowRemoteImages, 0); |
84fb5b46 MKG |
1804 | |
1805 | =item C<$PlainTextMono> | |
1806 | ||
af59614d MKG |
1807 | Normally plaintext attachments are displayed as HTML with line breaks |
1808 | preserved. This causes space- and tab-based formatting not to be | |
1809 | displayed correctly. Set C<$PlainTextMono> to 1 to use a monospaced | |
1810 | font and preserve formatting. | |
84fb5b46 MKG |
1811 | |
1812 | =cut | |
1813 | ||
1814 | Set($PlainTextMono, 0); | |
1815 | ||
1816 | =item C<$SuppressInlineTextFiles> | |
1817 | ||
1818 | If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files | |
1819 | (text-type attachments with file names) are prevented from being | |
1820 | displayed in-line when viewing a ticket's history. | |
1821 | ||
1822 | =cut | |
1823 | ||
1824 | Set($SuppressInlineTextFiles, undef); | |
1825 | ||
1826 | ||
1827 | =item C<@Active_MakeClicky> | |
1828 | ||
1829 | MakeClicky detects various formats of data in headers and email | |
1830 | messages, and extends them with supporting links. By default, RT | |
1831 | provides two formats: | |
1832 | ||
1833 | * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]' | |
1834 | link after the URL. | |
1835 | ||
1836 | * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but | |
af59614d | 1837 | replaces the URL with a link. Enabled by default. |
84fb5b46 MKG |
1838 | |
1839 | See F<share/html/Elements/MakeClicky> for documentation on how to add | |
1840 | your own styles of link detection. | |
1841 | ||
1842 | =cut | |
1843 | ||
af59614d MKG |
1844 | Set(@Active_MakeClicky, qw(httpurl_overwrite)); |
1845 | ||
1846 | =item C<$QuoteFolding> | |
1847 | ||
1848 | Quote folding is the hiding of old replies in transaction history. | |
1849 | It defaults to on. Set this to 0 to disable it. | |
1850 | ||
1851 | =cut | |
1852 | ||
1853 | Set($QuoteFolding, 1); | |
84fb5b46 MKG |
1854 | |
1855 | =back | |
1856 | ||
1857 | ||
1858 | ||
1859 | =head1 Application logic | |
1860 | ||
1861 | =over 4 | |
1862 | ||
1863 | =item C<$ParseNewMessageForTicketCcs> | |
1864 | ||
1865 | If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to | |
1866 | divine Ticket 'Cc' watchers from the To and Cc lines of incoming | |
af59614d MKG |
1867 | messages that create new Tickets. This option does not apply to replies |
1868 | or comments on existing Tickets. Be forewarned that if you have I<any> | |
1869 | addresses which forward mail to RT automatically and you enable this | |
1870 | option without modifying C<$RTAddressRegexp> below, you will get | |
1871 | yourself into a heap of trouble. | |
84fb5b46 MKG |
1872 | |
1873 | =cut | |
1874 | ||
1875 | Set($ParseNewMessageForTicketCcs, undef); | |
1876 | ||
1877 | =item C<$UseTransactionBatch> | |
1878 | ||
1879 | Set C<$UseTransactionBatch> to 1 to execute transactions in batches, | |
1880 | such that a resolve and comment (for example) would happen | |
1881 | simultaneously, instead of as two transactions, unaware of each | |
1882 | others' existence. | |
1883 | ||
1884 | =cut | |
1885 | ||
1886 | Set($UseTransactionBatch, 1); | |
1887 | ||
1888 | =item C<$StrictLinkACL> | |
1889 | ||
1890 | When this feature is enabled a user needs I<ModifyTicket> rights on | |
1891 | both tickets to link them together; otherwise, I<ModifyTicket> rights | |
1892 | on either of them is sufficient. | |
1893 | ||
1894 | =cut | |
1895 | ||
1896 | Set($StrictLinkACL, 1); | |
1897 | ||
1898 | =item C<$RedistributeAutoGeneratedMessages> | |
1899 | ||
1900 | Should RT redistribute correspondence that it identifies as machine | |
1901 | generated? A 1 will do so; setting this to 0 will cause no | |
1902 | such messages to be redistributed. You can also use 'privileged' (the | |
1903 | default), which will redistribute only to privileged users. This helps | |
1904 | to protect against malformed bounces and loops caused by auto-created | |
1905 | requestors with bogus addresses. | |
1906 | ||
1907 | =cut | |
1908 | ||
1909 | Set($RedistributeAutoGeneratedMessages, "privileged"); | |
1910 | ||
1911 | =item C<$ApprovalRejectionNotes> | |
1912 | ||
1913 | Should rejection notes from approvals be sent to the requestors? | |
1914 | ||
1915 | =cut | |
1916 | ||
1917 | Set($ApprovalRejectionNotes, 1); | |
1918 | ||
1919 | =item C<$ForceApprovalsView> | |
1920 | ||
1921 | Should approval tickets only be viewed and modified through the standard | |
af59614d MKG |
1922 | approval interface? With this setting enabled (by default), any attempt to use |
1923 | the normal ticket display and modify page for approval tickets will be | |
1924 | redirected. | |
84fb5b46 MKG |
1925 | |
1926 | For example, with this option set to 1 and an approval ticket #123: | |
1927 | ||
1928 | /Ticket/Display.html?id=123 | |
1929 | ||
1930 | is redirected to | |
1931 | ||
1932 | /Approval/Display.html?id=123 | |
1933 | ||
af59614d MKG |
1934 | With this option set to 0, the redirect won't happen. |
1935 | ||
84fb5b46 MKG |
1936 | =back |
1937 | ||
1938 | =cut | |
1939 | ||
af59614d | 1940 | Set($ForceApprovalsView, 1); |
84fb5b46 MKG |
1941 | |
1942 | =head1 Extra security | |
1943 | ||
84fb5b46 MKG |
1944 | This is a list of extra security measures to enable that help keep your RT |
1945 | safe. If you don't know what these mean, you should almost certainly leave the | |
1946 | defaults alone. | |
1947 | ||
dab09ea8 MKG |
1948 | =over 4 |
1949 | ||
84fb5b46 MKG |
1950 | =item C<$DisallowExecuteCode> |
1951 | ||
1952 | If set to a true value, the C<ExecuteCode> right will be removed from | |
1953 | all users, B<including> the superuser. This is intended for when RT is | |
1954 | installed into a shared environment where even the superuser should not | |
1955 | be allowed to run arbitrary Perl code on the server via scrips. | |
1956 | ||
1957 | =cut | |
1958 | ||
1959 | Set($DisallowExecuteCode, 0); | |
1960 | ||
1961 | =item C<$Framebusting> | |
1962 | ||
1963 | If set to a false value, framekiller javascript will be disabled and the | |
1964 | X-Frame-Options: DENY header will be suppressed from all responses. | |
1965 | This disables RT's clickjacking protection. | |
1966 | ||
1967 | =cut | |
1968 | ||
1969 | Set($Framebusting, 1); | |
1970 | ||
1971 | =item C<$RestrictReferrer> | |
1972 | ||
1973 | If set to a false value, the HTTP C<Referer> (sic) header will not be | |
1974 | checked to ensure that requests come from RT's own domain. As RT allows | |
1975 | for GET requests to alter state, disabling this opens RT up to | |
1976 | cross-site request forgery (CSRF) attacks. | |
1977 | ||
1978 | =cut | |
1979 | ||
1980 | Set($RestrictReferrer, 1); | |
1981 | ||
1982 | =item C<$RestrictLoginReferrer> | |
1983 | ||
1984 | If set to a false value, RT will allow the user to log in from any link | |
1985 | or request, merely by passing in C<user> and C<pass> parameters; setting | |
1986 | it to a true value forces all logins to come from the login box, so the | |
b5747ff2 | 1987 | user is aware that they are being logged in. The default is off, for |
84fb5b46 MKG |
1988 | backwards compatability. |
1989 | ||
1990 | =cut | |
1991 | ||
1992 | Set($RestrictLoginReferrer, 0); | |
1993 | ||
dab09ea8 | 1994 | =item C<@ReferrerWhitelist> |
b5747ff2 MKG |
1995 | |
1996 | This is a list of hostname:port combinations that RT will treat as being | |
1997 | part of RT's domain. This is particularly useful if you access RT as | |
1998 | multiple hostnames or have an external auth system that needs to | |
1999 | redirect back to RT once authentication is complete. | |
2000 | ||
2001 | Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80)); | |
2002 | ||
2003 | If the "RT has detected a possible cross-site request forgery" error is triggered | |
2004 | by a host:port sent by your browser that you believe should be valid, you can copy | |
2005 | the host:port from the error message into this list. | |
2006 | ||
dab09ea8 MKG |
2007 | Simple wildcards, similar to SSL certificates, are allowed. For example: |
2008 | ||
2009 | *.example.com:80 # matches foo.example.com | |
2010 | # but not example.com | |
2011 | # or foo.bar.example.com | |
2012 | ||
2013 | www*.example.com:80 # matches www3.example.com | |
2014 | # and www-test.example.com | |
2015 | # and www.example.com | |
2016 | ||
b5747ff2 MKG |
2017 | =cut |
2018 | ||
2019 | Set(@ReferrerWhitelist, qw()); | |
2020 | ||
af59614d MKG |
2021 | |
2022 | =item C<$BcryptCost> | |
2023 | ||
2024 | This sets the default cost parameter used for the C<bcrypt> key | |
2025 | derivation function. Valid values range from 4 to 31, inclusive, with | |
2026 | higher numbers denoting greater effort. | |
2027 | ||
2028 | =cut | |
2029 | ||
2030 | Set($BcryptCost, 10); | |
2031 | ||
84fb5b46 MKG |
2032 | =back |
2033 | ||
2034 | ||
2035 | ||
2036 | =head1 Authorization and user configuration | |
2037 | ||
2038 | =over 4 | |
2039 | ||
af59614d | 2040 | =item C<$WebRemoteUserAuth> |
84fb5b46 | 2041 | |
af59614d MKG |
2042 | If C<$WebRemoteUserAuth> is defined, RT will defer to the environment's |
2043 | REMOTE_USER variable, which should be set by the webserver's | |
2044 | authentication layer. | |
84fb5b46 MKG |
2045 | |
2046 | =cut | |
2047 | ||
af59614d | 2048 | Set($WebRemoteUserAuth, undef); |
84fb5b46 | 2049 | |
af59614d | 2050 | =item C<$WebRemoteUserContinuous> |
84fb5b46 | 2051 | |
af59614d | 2052 | If C<$WebRemoteUserContinuous> is defined, RT will check for the |
84fb5b46 MKG |
2053 | REMOTE_USER on each access. If you would prefer this to only happen |
2054 | once (at initial login) set this to a false value. The default | |
af59614d | 2055 | setting will help ensure that if your webserver's authentication layer |
84fb5b46 MKG |
2056 | deauthenticates a user, RT notices as soon as possible. |
2057 | ||
2058 | =cut | |
2059 | ||
af59614d | 2060 | Set($WebRemoteUserContinuous, 1); |
84fb5b46 | 2061 | |
af59614d | 2062 | =item C<$WebFallbackToRTLogin> |
84fb5b46 | 2063 | |
af59614d | 2064 | If C<$WebFallbackToRTLogin> is defined, the user is allowed a |
84fb5b46 MKG |
2065 | chance of fallback to the login screen, even if REMOTE_USER failed. |
2066 | ||
2067 | =cut | |
2068 | ||
af59614d | 2069 | Set($WebFallbackToRTLogin, undef); |
84fb5b46 | 2070 | |
af59614d | 2071 | =item C<$WebRemoteUserGecos> |
84fb5b46 | 2072 | |
af59614d MKG |
2073 | C<$WebRemoteUserGecos> means to match 'gecos' field as the user |
2074 | identity; useful with C<mod_auth_pwcheck> and IIS Integrated Windows | |
84fb5b46 MKG |
2075 | logon. |
2076 | ||
2077 | =cut | |
2078 | ||
af59614d | 2079 | Set($WebRemoteUserGecos, undef); |
84fb5b46 | 2080 | |
af59614d | 2081 | =item C<$WebRemoteUserAutocreate> |
84fb5b46 | 2082 | |
af59614d MKG |
2083 | C<$WebRemoteUserAutocreate> will create users under the same name as |
2084 | REMOTE_USER upon login, if they are missing from the Users table. | |
84fb5b46 MKG |
2085 | |
2086 | =cut | |
2087 | ||
af59614d | 2088 | Set($WebRemoteUserAutocreate, undef); |
84fb5b46 | 2089 | |
af59614d | 2090 | =item C<$UserAutocreateDefaultsOnLogin> |
84fb5b46 | 2091 | |
af59614d MKG |
2092 | If C<$WebRemoteUserAutocreate> is set to 1, C<$UserAutocreateDefaultsOnLogin> |
2093 | will be passed to L<RT::User/Create>. Use it to set defaults, such as | |
2094 | creating unprivileged users with C<<{ Privileged => 0 }>>. This must be | |
2095 | a hashref. | |
84fb5b46 MKG |
2096 | |
2097 | =cut | |
2098 | ||
af59614d | 2099 | Set($UserAutocreateDefaultsOnLogin, undef); |
84fb5b46 MKG |
2100 | |
2101 | =item C<$WebSessionClass> | |
2102 | ||
af59614d MKG |
2103 | C<$WebSessionClass> is the class you wish to use for storing sessions. On |
2104 | MySQL, Pg, and Oracle it defaults to using your database, in other cases | |
2105 | sessions are stored in files using L<Apache::Session::File>. Other installed | |
2106 | Apache:Session::* modules can be used to store sessions. | |
2107 | ||
2108 | Set($WebSessionClass, "Apache::Session::File"); | |
84fb5b46 MKG |
2109 | |
2110 | =cut | |
2111 | ||
af59614d MKG |
2112 | Set($WebSessionClass, undef); |
2113 | ||
2114 | =item C<%WebSessionProperties> | |
2115 | ||
2116 | C<%WebSessionProperties> is the hash to configure class L</$WebSessionClass> | |
2117 | in case custom class is used. By default it's empty and values are picked | |
2118 | depending on the class. Make sure that it's empty if you're using DB as session | |
2119 | backend. | |
2120 | ||
2121 | =cut | |
2122 | ||
2123 | Set( %WebSessionProperties ); | |
84fb5b46 MKG |
2124 | |
2125 | =item C<$AutoLogoff> | |
2126 | ||
2127 | By default, RT's user sessions persist until a user closes his or her | |
2128 | browser. With the C<$AutoLogoff> option you can setup session lifetime | |
2129 | in minutes. A user will be logged out if he or she doesn't send any | |
2130 | requests to RT for the defined time. | |
2131 | ||
2132 | =cut | |
2133 | ||
2134 | Set($AutoLogoff, 0); | |
2135 | ||
2136 | =item C<$LogoutRefresh> | |
2137 | ||
2138 | The number of seconds to wait after logout before sending the user to | |
2139 | the login page. By default, 1 second, though you may want to increase | |
2140 | this if you display additional information on the logout page. | |
2141 | ||
2142 | =cut | |
2143 | ||
2144 | Set($LogoutRefresh, 1); | |
2145 | ||
2146 | =item C<$WebSecureCookies> | |
2147 | ||
2148 | By default, RT's session cookie isn't marked as "secure". Some web | |
2149 | browsers will treat secure cookies more carefully than non-secure | |
2150 | ones, being careful not to write them to disk, only sending them over | |
2151 | an SSL secured connection, and so on. To enable this behavior, set | |
2152 | C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this | |
2153 | on I<unless> users are only connecting via SSL encrypted HTTPS | |
2154 | connections. | |
2155 | ||
2156 | =cut | |
2157 | ||
2158 | Set($WebSecureCookies, 0); | |
2159 | ||
2160 | =item C<$WebHttpOnlyCookies> | |
2161 | ||
2162 | Default RT's session cookie to not being directly accessible to | |
2163 | javascript. The content is still sent during regular and AJAX requests, | |
2164 | and other cookies are unaffected, but the session-id is less | |
2165 | programmatically accessible to javascript. Turning this off should only | |
2166 | be necessary in situations with odd client-side authentication | |
2167 | requirements. | |
2168 | ||
2169 | =cut | |
2170 | ||
2171 | Set($WebHttpOnlyCookies, 1); | |
2172 | ||
2173 | =item C<$MinimumPasswordLength> | |
2174 | ||
2175 | C<$MinimumPasswordLength> defines the minimum length for user | |
2176 | passwords. Setting it to 0 disables this check. | |
2177 | ||
2178 | =cut | |
2179 | ||
2180 | Set($MinimumPasswordLength, 5); | |
2181 | ||
2182 | =back | |
2183 | ||
2184 | ||
2185 | =head1 Internationalization | |
2186 | ||
2187 | =over 4 | |
2188 | ||
2189 | =item C<@LexiconLanguages> | |
2190 | ||
2191 | An array that contains languages supported by RT's | |
2192 | internationalization interface. Defaults to all *.po lexicons; | |
2193 | setting it to C<qw(en ja)> will make RT bilingual instead of | |
2194 | multilingual, but will save some memory. | |
2195 | ||
2196 | =cut | |
2197 | ||
2198 | Set(@LexiconLanguages, qw(*)); | |
2199 | ||
2200 | =item C<@EmailInputEncodings> | |
2201 | ||
2202 | An array that contains default encodings used to guess which charset | |
2203 | an attachment uses, if it does not specify one explicitly. All | |
2204 | options must be recognized by L<Encode::Guess>. The first element may | |
2205 | also be '*', which enables encoding detection using | |
2206 | L<Encode::Detect::Detector>, if installed. | |
2207 | ||
2208 | =cut | |
2209 | ||
2210 | Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii)); | |
2211 | ||
2212 | =item C<$EmailOutputEncoding> | |
2213 | ||
2214 | The charset for localized email. Must be recognized by Encode. | |
2215 | ||
2216 | =cut | |
2217 | ||
2218 | Set($EmailOutputEncoding, "utf-8"); | |
2219 | ||
2220 | =back | |
2221 | ||
2222 | ||
2223 | ||
2224 | ||
2225 | ||
2226 | ||
2227 | ||
2228 | =head1 Date and time handling | |
2229 | ||
2230 | =over 4 | |
2231 | ||
2232 | =item C<$DateTimeFormat> | |
2233 | ||
2234 | You can choose date and time format. See the "Output formatters" | |
2235 | section in perldoc F<lib/RT/Date.pm> for more options. This option | |
2236 | can be overridden by users in their preferences. | |
2237 | ||
2238 | Some examples: | |
2239 | ||
2240 | C<Set($DateTimeFormat, "LocalizedDateTime");> | |
2241 | C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });> | |
2242 | C<Set($DateTimeFormat, "RFC2822");> | |
2243 | C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });> | |
2244 | ||
2245 | =cut | |
2246 | ||
2247 | Set($DateTimeFormat, "DefaultFormat"); | |
2248 | ||
2249 | # Next two options are for Time::ParseDate | |
2250 | ||
2251 | =item C<$DateDayBeforeMonth> | |
2252 | ||
2253 | Set this to 1 if your local date convention looks like "dd/mm/yy" | |
2254 | instead of "mm/dd/yy". Used only for parsing, not for displaying | |
2255 | dates. | |
2256 | ||
2257 | =cut | |
2258 | ||
2259 | Set($DateDayBeforeMonth, 1); | |
2260 | ||
2261 | =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture> | |
2262 | ||
2263 | Should an unspecified day or year in a date refer to a future or a | |
2264 | past value? For example, should a date of "Tuesday" default to mean | |
2265 | the date for next Tuesday or last Tuesday? Should the date "March 1" | |
2266 | default to the date for next March or last March? | |
2267 | ||
2268 | Set C<$AmbiguousDayInPast> for the last date, or | |
2269 | C<$AmbiguousDayInFuture> for the next date; the default is usually | |
2270 | correct. If both are set, C<$AmbiguousDayInPast> takes precedence. | |
2271 | ||
2272 | =cut | |
2273 | ||
2274 | Set($AmbiguousDayInPast, 0); | |
2275 | Set($AmbiguousDayInFuture, 0); | |
2276 | ||
2277 | =item C<$DefaultTimeUnitsToHours> | |
2278 | ||
2279 | Use this to set the default units for time entry to hours instead of | |
2280 | minutes. Note that this only effects entry, not display. | |
2281 | ||
2282 | =cut | |
2283 | ||
2284 | Set($DefaultTimeUnitsToHours, 0); | |
2285 | ||
af59614d MKG |
2286 | =item C<$TimeInICal> |
2287 | ||
2288 | By default, events in the iCal feed on the ticket search page | |
2289 | contain only dates, making them all day calendar events. Set | |
2290 | C<$TimeInICal> if you have start or due dates on tickets that | |
2291 | have significant time values and you want those times to be | |
2292 | included in the events in the iCal feed. | |
2293 | ||
2294 | This option can also be set as an individual user preference. | |
2295 | ||
2296 | =cut | |
2297 | ||
2298 | Set($TimeInICal, 0); | |
2299 | ||
2300 | =back | |
2301 | ||
2302 | ||
2303 | ||
2304 | =head1 Cryptography | |
2305 | ||
2306 | A complete description of RT's cryptography capabilities can be found in | |
2307 | L<RT::Crypt>. At this moment, GnuPG (PGP) and SMIME security protocols are | |
2308 | supported. | |
2309 | ||
2310 | =over 4 | |
2311 | ||
2312 | =item C<%Crypt> | |
2313 | ||
2314 | The following options apply to all cryptography protocols. | |
2315 | ||
2316 | By default, all enabled security protocols will analyze each incoming | |
2317 | email. You may set C<Incoming> to a subset of this list, if some enabled | |
2318 | protocols do not apply to incoming mail; however, this is usually | |
2319 | unnecessary. Note that for any verification or decryption to occur for | |
2320 | incoming mail, the C<Auth::Crypt> mail plugin must be added to | |
2321 | L</@MailPlugins> as specified in L<RT::Crypt/Handling incoming messages>. | |
2322 | ||
2323 | For outgoing emails, the first security protocol from the above list is | |
2324 | used. Use the C<Outgoing> option to set a security protocol that should | |
2325 | be used in outgoing emails. At this moment, only one protocol can be | |
2326 | used to protect outgoing emails. | |
2327 | ||
2328 | Set C<RejectOnUnencrypted> to true if all incoming email must be | |
2329 | properly encrypted. All unencrypted emails will be rejected by RT. | |
2330 | ||
2331 | Set C<RejectOnMissingPrivateKey> to false if you don't want to reject | |
2332 | emails encrypted for key RT doesn't have and can not decrypt. | |
2333 | ||
2334 | Set C<RejectOnBadData> to false if you don't want to reject letters | |
2335 | with incorrect data. | |
2336 | ||
2337 | If you want to allow people to encrypt attachments inside the DB then | |
2338 | set C<AllowEncryptDataInDB> to 1. | |
2339 | ||
2340 | Set C<Dashboards> to a hash with Encrypt and Sign keys to control | |
2341 | whether dashboards should be encrypted and/or signed correspondingly. | |
2342 | By default they are not encrypted or signed. | |
2343 | ||
84fb5b46 MKG |
2344 | =back |
2345 | ||
af59614d MKG |
2346 | =cut |
2347 | ||
2348 | Set( %Crypt, | |
2349 | Incoming => undef, # ['GnuPG', 'SMIME'] | |
2350 | Outgoing => undef, # 'SMIME' | |
2351 | ||
2352 | RejectOnUnencrypted => 0, | |
2353 | RejectOnMissingPrivateKey => 1, | |
2354 | RejectOnBadData => 1, | |
2355 | ||
2356 | AllowEncryptDataInDB => 0, | |
2357 | ||
2358 | Dashboards => { | |
2359 | Encrypt => 0, | |
2360 | Sign => 0, | |
2361 | }, | |
2362 | ); | |
2363 | ||
2364 | =head2 SMIME configuration | |
2365 | ||
2366 | A full description of the SMIME integration can be found in | |
2367 | L<RT::Crypt::SMIME>. | |
2368 | ||
2369 | =over 4 | |
2370 | ||
2371 | =item C<%SMIME> | |
2372 | ||
2373 | Set C<Enable> to false or true value to disable or enable SMIME for | |
2374 | encrypting and signing messages. | |
2375 | ||
2376 | Set C<OpenSSL> to path to F<openssl> executable. | |
2377 | ||
2378 | Set C<Keyring> to directory with key files. Key and certificates should | |
2379 | be stored in a PEM file in this directory named named, e.g., | |
2380 | F<email.address@example.com.pem>. | |
84fb5b46 | 2381 | |
af59614d MKG |
2382 | Set C<CAPath> to either a PEM-formatted certificate of a single signing |
2383 | certificate authority, or a directory of such (including hash symlinks | |
2384 | as created by the openssl tool C<c_rehash>). Only SMIME certificates | |
2385 | signed by these certificate authorities will be treated as valid | |
2386 | signatures. If left unset (and C<AcceptUntrustedCAs> is unset, as it is | |
2387 | by default), no signatures will be marked as valid! | |
84fb5b46 | 2388 | |
af59614d MKG |
2389 | Set C<AcceptUntrustedCAs> to allow arbitrary SMIME certificates, no |
2390 | matter their signing entities. Such mails will be marked as untrusted, | |
2391 | but signed; C<CAPath> will be used to mark which mails are signed by | |
2392 | trusted certificate authorities. This configuration is generally | |
2393 | insecure, as it allows the possibility of accepting forged mail signed | |
2394 | by an untrusted certificate authority. | |
84fb5b46 | 2395 | |
af59614d MKG |
2396 | Setting C<AcceptUntrustedCAs> also allows encryption to users with |
2397 | certificates created by untrusted CAs. | |
2398 | ||
2399 | Set C<Passphrase> to a scalar (to use for all keys), an anonymous | |
2400 | function, or a hash (to look up by address). If the hash is used, the | |
2401 | '' key is used as a default. | |
2402 | ||
2403 | See L<RT::Crypt::SMIME> for details. | |
2404 | ||
2405 | =back | |
2406 | ||
2407 | =cut | |
2408 | ||
2409 | Set( %SMIME, | |
2410 | Enable => 0, | |
2411 | OpenSSL => 'openssl', | |
2412 | Keyring => q{var/data/smime}, | |
2413 | CAPath => undef, | |
2414 | AcceptUntrustedCAs => undef, | |
2415 | Passphrase => undef, | |
2416 | ); | |
2417 | ||
2418 | =head2 GnuPG configuration | |
84fb5b46 MKG |
2419 | |
2420 | A full description of the (somewhat extensive) GnuPG integration can | |
2421 | be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or | |
2422 | `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory). | |
2423 | ||
2424 | =over 4 | |
2425 | ||
2426 | =item C<%GnuPG> | |
2427 | ||
af59614d MKG |
2428 | Set C<Enable> to false or true value to disable or enable GnuPG interfaces |
2429 | for encrypting and signing outgoing messages. | |
84fb5b46 | 2430 | |
af59614d | 2431 | Set C<GnuPG> to the name or path of the gpg binary to use. |
84fb5b46 | 2432 | |
af59614d MKG |
2433 | Set C<Passphrase> to a scalar (to use for all keys), an anonymous |
2434 | function, or a hash (to look up by address). If the hash is used, the | |
2435 | '' key is used as a default. | |
84fb5b46 | 2436 | |
af59614d MKG |
2437 | Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and |
2438 | signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format. | |
84fb5b46 MKG |
2439 | |
2440 | =cut | |
2441 | ||
2442 | Set(%GnuPG, | |
af59614d MKG |
2443 | Enable => 0, |
2444 | GnuPG => 'gpg', | |
2445 | Passphrase => undef, | |
84fb5b46 | 2446 | OutgoingMessagesFormat => "RFC", # Inline |
84fb5b46 MKG |
2447 | ); |
2448 | ||
2449 | =item C<%GnuPGOptions> | |
2450 | ||
2451 | Options to pass to the GnuPG program. | |
2452 | ||
2453 | If you override this in your RT_SiteConfig, you should be sure to | |
2454 | include a homedir setting. | |
2455 | ||
2456 | Note that options with '-' character MUST be quoted. | |
2457 | ||
2458 | =cut | |
2459 | ||
2460 | Set(%GnuPGOptions, | |
2461 | homedir => q{var/data/gpg}, | |
2462 | ||
2463 | # URL of a keyserver | |
2464 | # keyserver => 'hkp://subkeys.pgp.net', | |
2465 | ||
2466 | # enables the automatic retrieving of keys when encrypting | |
2467 | # 'auto-key-locate' => 'keyserver', | |
2468 | ||
2469 | # enables the automatic retrieving of keys when verifying signatures | |
2470 | # 'auto-key-retrieve' => undef, | |
2471 | ); | |
2472 | ||
2473 | =back | |
2474 | ||
2475 | ||
2476 | ||
2477 | =head1 Lifecycles | |
2478 | ||
2479 | =head2 Lifecycle definitions | |
2480 | ||
2481 | Each lifecycle is a list of possible statuses split into three logic | |
2482 | sets: B<initial>, B<active> and B<inactive>. Each status in a | |
2483 | lifecycle must be unique. (Statuses may not be repeated across sets.) | |
2484 | Each set may have any number of statuses. | |
2485 | ||
2486 | For example: | |
2487 | ||
2488 | default => { | |
2489 | initial => ['new'], | |
2490 | active => ['open', 'stalled'], | |
2491 | inactive => ['resolved', 'rejected', 'deleted'], | |
2492 | ... | |
2493 | }, | |
2494 | ||
2495 | Status names can be from 1 to 64 ASCII characters. Statuses are | |
2496 | localized using RT's standard internationalization and localization | |
2497 | system. | |
2498 | ||
2499 | =over 4 | |
2500 | ||
2501 | =item initial | |
2502 | ||
2503 | You can define multiple B<initial> statuses for tickets in a given | |
2504 | lifecycle. | |
2505 | ||
2506 | RT will automatically set its B<Started> date when you change a | |
2507 | ticket's status from an B<initial> state to an B<active> or | |
2508 | B<inactive> status. | |
2509 | ||
2510 | =item active | |
2511 | ||
2512 | B<Active> tickets are "currently in play" - they're things that are | |
2513 | being worked on and not yet complete. | |
2514 | ||
2515 | =item inactive | |
2516 | ||
2517 | B<Inactive> tickets are typically in their "final resting state". | |
2518 | ||
2519 | While you're free to implement a workflow that ignores that | |
2520 | description, typically once a ticket enters an inactive state, it will | |
2521 | never again enter an active state. | |
2522 | ||
2523 | RT will automatically set the B<Resolved> date when a ticket's status | |
2524 | is changed from an B<Initial> or B<Active> status to an B<Inactive> | |
2525 | status. | |
2526 | ||
2527 | B<deleted> is still a special status and protected by the | |
2528 | B<DeleteTicket> right, unless you re-defined rights (read below). If | |
2529 | you don't want to allow ticket deletion at any time simply don't | |
2530 | include it in your lifecycle. | |
2531 | ||
2532 | =back | |
2533 | ||
2534 | Statuses in each set are ordered and listed in the UI in the defined | |
2535 | order. | |
2536 | ||
2537 | Changes between statuses are constrained by transition rules, as | |
2538 | described below. | |
2539 | ||
2540 | =head2 Default values | |
2541 | ||
2542 | In some cases a default value is used to display in UI or in API when | |
2543 | value is not provided. You can configure defaults using the following | |
2544 | syntax: | |
2545 | ||
2546 | default => { | |
2547 | ... | |
2548 | defaults => { | |
2549 | on_create => 'new', | |
2550 | on_resolve => 'resolved', | |
2551 | ... | |
2552 | }, | |
2553 | }, | |
2554 | ||
2555 | The following defaults are used. | |
2556 | ||
2557 | =over 4 | |
2558 | ||
2559 | =item on_create | |
2560 | ||
2561 | If you (or your code) doesn't specify a status when creating a ticket, | |
2562 | RT will use the this status. See also L</Statuses available during | |
2563 | ticket creation>. | |
2564 | ||
2565 | =item on_merge | |
2566 | ||
2567 | When tickets are merged, the status of the ticket that was merged | |
2568 | away is forced to this value. It should be one of inactive statuses; | |
2569 | 'resolved' or its equivalent is most probably the best candidate. | |
2570 | ||
2571 | =item approved | |
2572 | ||
2573 | When an approval is accepted, the status of depending tickets will | |
2574 | be changed to this value. | |
2575 | ||
2576 | =item denied | |
2577 | ||
2578 | When an approval is denied, the status of depending tickets will | |
2579 | be changed to this value. | |
2580 | ||
b5747ff2 MKG |
2581 | =item reminder_on_open |
2582 | ||
2583 | When a reminder is opened, the status will be changed to this value. | |
2584 | ||
2585 | =item reminder_on_resolve | |
2586 | ||
2587 | When a reminder is resolved, the status will be changed to this value. | |
2588 | ||
84fb5b46 MKG |
2589 | =back |
2590 | ||
2591 | =head2 Transitions between statuses and UI actions | |
2592 | ||
2593 | A B<Transition> is a change of status from A to B. You should define | |
2594 | all possible transitions in each lifecycle using the following format: | |
2595 | ||
2596 | default => { | |
2597 | ... | |
2598 | transitions => { | |
2599 | '' => [qw(new open resolved)], | |
2600 | new => [qw(open resolved rejected deleted)], | |
2601 | open => [qw(stalled resolved rejected deleted)], | |
2602 | stalled => [qw(open)], | |
2603 | resolved => [qw(open)], | |
2604 | rejected => [qw(open)], | |
2605 | deleted => [qw(open)], | |
2606 | }, | |
2607 | ... | |
2608 | }, | |
2609 | ||
2610 | =head3 Statuses available during ticket creation | |
2611 | ||
dab09ea8 MKG |
2612 | By default users can create tickets with a status of new, |
2613 | open, or resolved, but cannot create tickets with a status of | |
2614 | rejected, stalled, or deleted. If you want to change the statuses | |
2615 | available during creation, update the transition from '' (empty | |
2616 | string), like in the example above. | |
84fb5b46 MKG |
2617 | |
2618 | =head3 Protecting status changes with rights | |
2619 | ||
2620 | A transition or group of transitions can be protected by a specific | |
2621 | right. Additionally, you can name new right names, which will be added | |
2622 | to the system to control that transition. For example, if you wished to | |
2623 | create a lesser right than ModifyTicket for rejecting tickets, you could | |
2624 | write: | |
2625 | ||
2626 | default => { | |
2627 | ... | |
2628 | rights => { | |
2629 | '* -> deleted' => 'DeleteTicket', | |
2630 | '* -> rejected' => 'RejectTicket', | |
2631 | '* -> *' => 'ModifyTicket', | |
2632 | }, | |
2633 | ... | |
2634 | }, | |
2635 | ||
2636 | This would create a new C<RejectTicket> right in the system which you | |
2637 | could assign to whatever groups you choose. | |
2638 | ||
2639 | On the left hand side you can have the following variants: | |
2640 | ||
2641 | '<from> -> <to>' | |
2642 | '* -> <to>' | |
2643 | '<from> -> *' | |
2644 | '* -> *' | |
2645 | ||
2646 | Valid transitions are listed in order of priority. If a user attempts | |
2647 | to change a ticket's status from B<new> to B<open> then the lifecycle | |
2648 | is checked for presence of an exact match, then for 'any to B<open>', | |
2649 | 'B<new> to any' and finally 'any to any'. | |
2650 | ||
2651 | If you don't define any rights, or there is no match for a transition, | |
2652 | RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate. | |
2653 | ||
2654 | =head3 Labeling and defining actions | |
2655 | ||
2656 | For each transition you can define an action that will be shown in the | |
2657 | UI; each action annotated with a label and an update type. | |
2658 | ||
2659 | Each action may provide a default update type, which can be | |
2660 | B<Comment>, B<Respond>, or absent. For example, you may want your | |
2661 | staff to write a reply to the end user when they change status from | |
2662 | B<new> to B<open>, and thus set the update to B<Respond>. Neither | |
2663 | B<Comment> nor B<Respond> are mandatory, and user may leave the | |
2664 | message empty, regardless of the update type. | |
2665 | ||
2666 | This configuration can be used to accomplish what | |
2667 | $ResolveDefaultUpdateType was used for in RT 3.8. | |
2668 | ||
2669 | Use the following format to define labels and actions of transitions: | |
2670 | ||
2671 | default => { | |
2672 | ... | |
2673 | actions => [ | |
2674 | 'new -> open' => { label => 'Open it', update => 'Respond' }, | |
2675 | 'new -> resolved' => { label => 'Resolve', update => 'Comment' }, | |
2676 | 'new -> rejected' => { label => 'Reject', update => 'Respond' }, | |
2677 | 'new -> deleted' => { label => 'Delete' }, | |
2678 | ||
2679 | 'open -> stalled' => { label => 'Stall', update => 'Comment' }, | |
2680 | 'open -> resolved' => { label => 'Resolve', update => 'Comment' }, | |
2681 | 'open -> rejected' => { label => 'Reject', update => 'Respond' }, | |
2682 | ||
2683 | 'stalled -> open' => { label => 'Open it' }, | |
2684 | 'resolved -> open' => { label => 'Re-open', update => 'Comment' }, | |
2685 | 'rejected -> open' => { label => 'Re-open', update => 'Comment' }, | |
2686 | 'deleted -> open' => { label => 'Undelete' }, | |
2687 | ], | |
2688 | ... | |
2689 | }, | |
2690 | ||
2691 | In addition, you may define multiple actions for the same transition. | |
2692 | Alternately, you may use '* -> x' to match more than one transition. | |
2693 | For example: | |
2694 | ||
2695 | default => { | |
2696 | ... | |
2697 | actions => [ | |
2698 | ... | |
2699 | 'new -> rejected' => { label => 'Reject', update => 'Respond' }, | |
2700 | 'new -> rejected' => { label => 'Quick Reject' }, | |
2701 | ... | |
2702 | '* -> deleted' => { label => 'Delete' }, | |
2703 | ... | |
2704 | ], | |
2705 | ... | |
2706 | }, | |
2707 | ||
2708 | =head2 Moving tickets between queues with different lifecycles | |
2709 | ||
2710 | Unless there is an explicit mapping between statuses in two different | |
2711 | lifecycles, you can not move tickets between queues with these | |
2712 | lifecycles. This is true even if the different lifecycles use the exact | |
2713 | same set of statuses. Such a mapping is defined as follows: | |
2714 | ||
2715 | __maps__ => { | |
2716 | 'from lifecycle -> to lifecycle' => { | |
2717 | 'status in left lifecycle' => 'status in right lifecycle', | |
2718 | ... | |
2719 | }, | |
2720 | ... | |
2721 | }, | |
2722 | ||
2723 | =cut | |
2724 | ||
2725 | Set(%Lifecycles, | |
2726 | default => { | |
2727 | initial => [ 'new' ], | |
2728 | active => [ 'open', 'stalled' ], | |
2729 | inactive => [ 'resolved', 'rejected', 'deleted' ], | |
2730 | ||
2731 | defaults => { | |
2732 | on_create => 'new', | |
2733 | on_merge => 'resolved', | |
2734 | approved => 'open', | |
2735 | denied => 'rejected', | |
b5747ff2 MKG |
2736 | reminder_on_open => 'open', |
2737 | reminder_on_resolve => 'resolved', | |
84fb5b46 MKG |
2738 | }, |
2739 | ||
2740 | transitions => { | |
2741 | '' => [qw(new open resolved)], | |
2742 | ||
2743 | # from => [ to list ], | |
2744 | new => [qw(open stalled resolved rejected deleted)], | |
2745 | open => [qw(new stalled resolved rejected deleted)], | |
2746 | stalled => [qw(new open rejected resolved deleted)], | |
2747 | resolved => [qw(new open stalled rejected deleted)], | |
2748 | rejected => [qw(new open stalled resolved deleted)], | |
2749 | deleted => [qw(new open stalled rejected resolved)], | |
2750 | }, | |
2751 | rights => { | |
2752 | '* -> deleted' => 'DeleteTicket', | |
2753 | '* -> *' => 'ModifyTicket', | |
2754 | }, | |
2755 | actions => [ | |
2756 | 'new -> open' => { | |
2757 | label => 'Open It', # loc | |
2758 | update => 'Respond', | |
2759 | }, | |
2760 | 'new -> resolved' => { | |
2761 | label => 'Resolve', # loc | |
2762 | update => 'Comment', | |
2763 | }, | |
2764 | 'new -> rejected' => { | |
2765 | label => 'Reject', # loc | |
2766 | update => 'Respond', | |
2767 | }, | |
2768 | 'new -> deleted' => { | |
2769 | label => 'Delete', # loc | |
2770 | }, | |
2771 | ||
2772 | 'open -> stalled' => { | |
2773 | label => 'Stall', # loc | |
2774 | update => 'Comment', | |
2775 | }, | |
2776 | 'open -> resolved' => { | |
2777 | label => 'Resolve', # loc | |
2778 | update => 'Comment', | |
2779 | }, | |
2780 | 'open -> rejected' => { | |
2781 | label => 'Reject', # loc | |
2782 | update => 'Respond', | |
2783 | }, | |
2784 | ||
2785 | 'stalled -> open' => { | |
2786 | label => 'Open It', # loc | |
2787 | }, | |
2788 | 'resolved -> open' => { | |
2789 | label => 'Re-open', # loc | |
2790 | update => 'Comment', | |
2791 | }, | |
2792 | 'rejected -> open' => { | |
2793 | label => 'Re-open', # loc | |
2794 | update => 'Comment', | |
2795 | }, | |
2796 | 'deleted -> open' => { | |
2797 | label => 'Undelete', # loc | |
2798 | }, | |
2799 | ], | |
2800 | }, | |
2801 | # don't change lifecyle of the approvals, they are not capable to deal with | |
2802 | # custom statuses | |
2803 | approvals => { | |
2804 | initial => [ 'new' ], | |
2805 | active => [ 'open', 'stalled' ], | |
2806 | inactive => [ 'resolved', 'rejected', 'deleted' ], | |
2807 | ||
2808 | defaults => { | |
2809 | on_create => 'new', | |
2810 | on_merge => 'resolved', | |
b5747ff2 MKG |
2811 | reminder_on_open => 'open', |
2812 | reminder_on_resolve => 'resolved', | |
84fb5b46 MKG |
2813 | }, |
2814 | ||
2815 | transitions => { | |
2816 | '' => [qw(new open resolved)], | |
2817 | ||
2818 | # from => [ to list ], | |
2819 | new => [qw(open stalled resolved rejected deleted)], | |
2820 | open => [qw(new stalled resolved rejected deleted)], | |
2821 | stalled => [qw(new open rejected resolved deleted)], | |
2822 | resolved => [qw(new open stalled rejected deleted)], | |
2823 | rejected => [qw(new open stalled resolved deleted)], | |
2824 | deleted => [qw(new open stalled rejected resolved)], | |
2825 | }, | |
2826 | rights => { | |
2827 | '* -> deleted' => 'DeleteTicket', | |
2828 | '* -> rejected' => 'ModifyTicket', | |
2829 | '* -> *' => 'ModifyTicket', | |
2830 | }, | |
2831 | actions => [ | |
2832 | 'new -> open' => { | |
2833 | label => 'Open It', # loc | |
2834 | update => 'Respond', | |
2835 | }, | |
2836 | 'new -> resolved' => { | |
2837 | label => 'Resolve', # loc | |
2838 | update => 'Comment', | |
2839 | }, | |
2840 | 'new -> rejected' => { | |
2841 | label => 'Reject', # loc | |
2842 | update => 'Respond', | |
2843 | }, | |
2844 | 'new -> deleted' => { | |
2845 | label => 'Delete', # loc | |
2846 | }, | |
2847 | ||
2848 | 'open -> stalled' => { | |
2849 | label => 'Stall', # loc | |
2850 | update => 'Comment', | |
2851 | }, | |
2852 | 'open -> resolved' => { | |
2853 | label => 'Resolve', # loc | |
2854 | update => 'Comment', | |
2855 | }, | |
2856 | 'open -> rejected' => { | |
2857 | label => 'Reject', # loc | |
2858 | update => 'Respond', | |
2859 | }, | |
2860 | ||
2861 | 'stalled -> open' => { | |
2862 | label => 'Open It', # loc | |
2863 | }, | |
2864 | 'resolved -> open' => { | |
2865 | label => 'Re-open', # loc | |
2866 | update => 'Comment', | |
2867 | }, | |
2868 | 'rejected -> open' => { | |
2869 | label => 'Re-open', # loc | |
2870 | update => 'Comment', | |
2871 | }, | |
2872 | 'deleted -> open' => { | |
2873 | label => 'Undelete', # loc | |
2874 | }, | |
2875 | ], | |
2876 | }, | |
2877 | ); | |
2878 | ||
2879 | ||
2880 | ||
2881 | ||
2882 | ||
2883 | =head1 Administrative interface | |
2884 | ||
2885 | =over 4 | |
2886 | ||
2887 | =item C<$ShowRTPortal> | |
2888 | ||
2889 | RT can show administrators a feed of recent RT releases and other | |
2890 | related announcements and information from Best Practical on the top | |
af59614d | 2891 | level Admin page. This feature helps you stay up to date on |
84fb5b46 MKG |
2892 | RT security announcements and version updates. |
2893 | ||
2894 | RT provides this feature using an "iframe" on C</Admin/index.html> | |
2895 | which asks the administrator's browser to show an inline page from | |
2896 | Best Practical's website. | |
2897 | ||
2898 | If you'd rather not make this feature available to your | |
2899 | administrators, set C<$ShowRTPortal> to a false value. | |
2900 | ||
2901 | =cut | |
2902 | ||
2903 | Set($ShowRTPortal, 1); | |
2904 | ||
2905 | =item C<%AdminSearchResultFormat> | |
2906 | ||
2907 | In the admin interface, format strings similar to tickets result | |
2908 | formats are used. Use C<%AdminSearchResultFormat> to define the format | |
2909 | strings used in the admin interface on a per-RT-class basis. | |
2910 | ||
2911 | =cut | |
2912 | ||
2913 | Set(%AdminSearchResultFormat, | |
2914 | Queues => | |
2915 | q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'} | |
2916 | .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'} | |
dab09ea8 | 2917 | .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__,__Lifecycle__}, |
84fb5b46 MKG |
2918 | |
2919 | Groups => | |
2920 | q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'} | |
2921 | .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'} | |
2922 | .q{,'__Description__'}, | |
2923 | ||
2924 | Users => | |
2925 | q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'} | |
2926 | .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'} | |
2927 | .q{,__RealName__, __EmailAddress__}, | |
2928 | ||
2929 | CustomFields => | |
2930 | q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'} | |
2931 | .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'} | |
af59614d | 2932 | .q{,__AddedTo__, __FriendlyType__, __FriendlyPattern__}, |
84fb5b46 MKG |
2933 | |
2934 | Scrips => | |
af59614d MKG |
2935 | q{'<a href="__WebPath__/Admin/Scrips/Modify.html?id=__id__">__id__</a>/TITLE:#'} |
2936 | .q{,'<a href="__WebPath__/Admin/Scrips/Modify.html?id=__id__">__Description__</a>/TITLE:Description'} | |
2937 | .q{,__Condition__, __Action__, __Template__, __Disabled__}, | |
84fb5b46 MKG |
2938 | |
2939 | Templates => | |
2940 | q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'} | |
2941 | .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'} | |
af59614d | 2942 | .q{,'__Description__','__UsedBy__','__IsEmpty__'}, |
84fb5b46 MKG |
2943 | Classes => |
2944 | q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'} | |
2945 | .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'} | |
2946 | .q{,__Description__}, | |
2947 | ); | |
2948 | ||
2949 | =back | |
2950 | ||
2951 | ||
2952 | ||
2953 | ||
2954 | =head1 Development options | |
2955 | ||
2956 | =over 4 | |
2957 | ||
2958 | =item C<$DevelMode> | |
2959 | ||
2960 | RT comes with a "Development mode" setting. This setting, as a | |
2961 | convenience for developers, turns on several of development options | |
2962 | that you most likely don't want in production: | |
2963 | ||
2964 | =over 4 | |
2965 | ||
2966 | =item * | |
2967 | ||
2968 | Disables CSS and JS minification and concatenation. Both CSS and JS | |
2969 | will be instead be served as a number of individual smaller files, | |
2970 | unchanged from how they are stored on disk. | |
2971 | ||
2972 | =item * | |
2973 | ||
2974 | Uses L<Module::Refresh> to reload changed Perl modules on each | |
2975 | request. | |
2976 | ||
2977 | =item * | |
2978 | ||
2979 | Turns off Mason's C<static_source> directive; this causes Mason to | |
2980 | reload template files which have been modified on disk. | |
2981 | ||
2982 | =item * | |
2983 | ||
2984 | Turns on Mason's HTML C<error_format>; this renders compilation errors | |
2985 | to the browser, along with a full stack trace. It is possible for | |
2986 | stack traces to reveal sensitive information such as passwords or | |
2987 | ticket content. | |
2988 | ||
2989 | =item * | |
2990 | ||
2991 | Turns off caching of callbacks; this enables additional callbacks to | |
2992 | be added while the server is running. | |
2993 | ||
2994 | =back | |
2995 | ||
2996 | =cut | |
2997 | ||
af59614d | 2998 | Set($DevelMode, 0); |
84fb5b46 MKG |
2999 | |
3000 | ||
3001 | =item C<$RecordBaseClass> | |
3002 | ||
3003 | What abstract base class should RT use for its records. You should | |
3004 | probably never change this. | |
3005 | ||
3006 | Valid values are C<DBIx::SearchBuilder::Record> or | |
3007 | C<DBIx::SearchBuilder::Record::Cachable> | |
3008 | ||
3009 | =cut | |
3010 | ||
3011 | Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable"); | |
3012 | ||
3013 | ||
3014 | =item C<@MasonParameters> | |
3015 | ||
3016 | C<@MasonParameters> is the list of parameters for the constructor of | |
3017 | HTML::Mason's Apache or CGI Handler. This is normally only useful for | |
3018 | debugging, e.g. profiling individual components with: | |
3019 | ||
3020 | use MasonX::Profiler; # available on CPAN | |
3021 | Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);')); | |
3022 | ||
3023 | =cut | |
3024 | ||
3025 | Set(@MasonParameters, ()); | |
3026 | ||
3027 | =item C<$StatementLog> | |
3028 | ||
3029 | RT has rudimentary SQL statement logging support; simply set | |
3030 | C<$StatementLog> to be the level that you wish SQL statements to be | |
3031 | logged at. | |
3032 | ||
3033 | Enabling this option will also expose the SQL Queries page in the | |
af59614d | 3034 | Admin -> Tools menu for SuperUsers. |
84fb5b46 MKG |
3035 | |
3036 | =cut | |
3037 | ||
3038 | Set($StatementLog, undef); | |
3039 | ||
3040 | =back | |
3041 | ||
84fb5b46 MKG |
3042 | =cut |
3043 | ||
3044 | 1; |