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