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