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