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