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