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