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