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