2 # RT was configured with:
9 ############################# WARNING #############################
11 # NEVER EDIT RT_Config.pm ! #
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. #
17 ############################# WARNING #############################
23 =head1 Base configuration
29 C<$rtname> is the string that RT will look for in mail messages to
30 figure out what ticket a new piece of mail belongs to.
32 Your domain name is recommended, so as not to pollute the namespace.
33 Once you start using a given tag, you should probably never change it;
34 otherwise, mail for existing tickets won't get put in the right place.
38 Set($rtname, "example.com");
40 =item C<$Organization>
42 You should set this to your organization's DNS domain. For example,
43 I<fsck.com> or I<asylum.arkham.ma.us>. It is used by the linking
44 interface to guarantee that ticket URIs are unique and easy to
45 construct. Changing it after you have created tickets in the system
46 will B<break> all existing ticket links!
50 Set($Organization, "example.com");
52 =item C<$CorrespondAddress>, C<$CommentAddress>
54 RT is designed such that any mail which already has a ticket-id
55 associated with it will get to the right place automatically.
57 C<$CorrespondAddress> and C<$CommentAddress> are the default addresses
58 that will be listed in From: and Reply-To: headers of correspondence
59 and comment mail tracked by RT, unless overridden by a queue-specific
60 address. They should be set to email addresses which have been
61 configured as aliases for F<rt-mailgate>.
65 Set($CorrespondAddress, '');
67 Set($CommentAddress, '');
71 Domain name of the RT server, e.g. 'www.example.com'. It should not
72 contain anything except the server name.
76 Set($WebDomain, "localhost");
80 If we're running as a superuser, run on port 80. Otherwise, pick a
81 high port for this user.
83 443 is default port for https protocol.
91 If you're putting the web UI somewhere other than at the root of your
92 server, you should set C<$WebPath> to the path you'll be serving RT
95 C<$WebPath> requires a leading / but no trailing /, or it can be
98 In most cases, you should leave C<$WebPath> set to "" (an empty
107 C<$Timezone> is the default timezone, used to convert times entered by
108 users into GMT, as they are stored in the database, and back again;
109 users can override this. It should be set to a timezone recognized by
114 Set($Timezone, "US/Eastern");
118 Set C<@Plugins> to a list of external RT plugins that should be
119 enabled (those plugins have to be previously downloaded and
124 C<Set(@Plugins, (qw(Extension::QuickDelete RT::Extension::CommandByMail)));>
128 Set(@Plugins, (qw(RTx::Calendar
129 RT::Extension::MobileUI))); #RTx::Checklist ));
136 =head1 Database connection
140 =item C<$DatabaseType>
142 Database driver being used; case matters. Valid types are "mysql",
147 Set($DatabaseType, "@DB_TYPE@");
149 =item C<$DatabaseHost>, C<$DatabaseRTHost>
151 The domain name of your database server. If you're running MySQL and
152 on localhost, leave it blank for enhanced performance.
154 C<DatabaseRTHost> is the fully-qualified hostname of your RT server,
155 for use in granting ACL rights on MySQL.
159 Set($DatabaseHost, "@DB_HOST@");
160 Set($DatabaseRTHost, "@DB_RT_HOST@");
162 =item C<$DatabasePort>
164 The port that your database server is running on. Ignored unless it's
165 a positive integer. It's usually safe to leave this blank; RT will
166 choose the correct default.
170 Set($DatabasePort, "@DB_PORT@");
172 =item C<$DatabaseUser>
174 The name of the user to connect to the database as.
178 Set($DatabaseUser, "@DB_RT_USER@");
180 =item C<$DatabasePassword>
182 The password the C<$DatabaseUser> should use to access the database.
186 Set($DatabasePassword, q{@DB_RT_PASS@});
188 =item C<$DatabaseName>
190 The name of the RT database on your database server. For Oracle, the
191 SID and database objects are created in C<$DatabaseUser>'s schema.
195 Set($DatabaseName, q{@DB_DATABASE@});
197 =item C<$DatabaseRequireSSL>
199 If you're using PostgreSQL and have compiled in SSL support, set
200 C<$DatabaseRequireSSL> to 1 to turn on SSL communication with the
205 Set($DatabaseRequireSSL, undef);
214 The default is to log anything except debugging information to syslog.
215 Check the L<Log::Dispatch> POD for information about how to get things
216 by syslog, mail or anything else, get debugging info in the log, etc.
218 It might generally make sense to send error and higher by email to
219 some administrator. If you do this, be careful that this email isn't
220 sent to this RT instance. Mail loops will generate a critical log
225 =item C<$LogToSyslog>, C<$LogToScreen>
227 The minimum level error that will be logged to the specific device.
228 From lowest to highest priority, the levels are:
230 debug info notice warning error critical alert emergency
232 Many syslogds are configured to discard or file debug messages away, so
233 if you're attempting to debug RT you may need to reconfigure your
234 syslogd or use one of the other logging options.
236 Logging to your screen affects scripts run from the command line as well
237 as the STDERR sent to your webserver (so these logs will usually show up
238 in your web server's error logs).
242 Set($LogToSyslog, "info");
243 Set($LogToScreen, "info");
245 =item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
247 Logging to a standalone file is also possible. The file needs to both
248 exist and be writable by all direct users of the RT API. This generally
249 includes the web server and whoever rt-crontool runs as. Note that
250 rt-mailgate and the RT CLI go through the webserver, so their users do
251 not need to have write permissions to this file. If you expect to have
252 multiple users of the direct API, Best Practical recommends using syslog
253 instead of direct file logging.
255 You should set C<$LogToFile> to one of the levels documented above.
259 Set($LogToFile, undef);
260 Set($LogDir, q{@RT_LOG_PATH@});
261 Set($LogToFileNamed, "rt.log"); #log to rt.log
263 =item C<$LogStackTraces>
265 If set to a log level then logging will include stack traces for
266 messages with level equal to or greater than specified.
268 NOTICE: Stack traces include parameters supplied to functions or
269 methods. It is possible for stack trace logging to reveal sensitive
270 information such as passwords or ticket content in your logs.
274 Set($LogStackTraces, "");
276 =item C<@LogToSyslogConf>
278 On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
279 override any other options RT passes to L<Log::Dispatch::Syslog>.
280 Other interesting flags include facility and logopt. (See the
281 L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
282 ident too, if you have multiple RT installations.)
286 Set(@LogToSyslogConf, ());
292 =head1 Incoming mail gateway
296 =item C<$EmailSubjectTagRegex>
298 This regexp controls what subject tags RT recognizes as its own. If
299 you're not dealing with historical C<$rtname> values, you'll likely
300 never have to change this configuration.
302 Be B<very careful> with it. Note that it overrides C<$rtname> for
303 subject token matching and that you should use only "non-capturing"
304 parenthesis grouping. For example:
306 C<Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );>
310 C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
312 The setting below would make RT behave exactly as it does without the
317 # Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
321 C<$OwnerEmail> is the address of a human who manages RT. RT will send
322 errors generated by the mail gateway to this address. This address
323 should I<not> be an address that's managed by your RT instance.
327 Set($OwnerEmail, 'root');
329 =item C<$LoopsToRTOwner>
331 If C<$LoopsToRTOwner> is defined, RT will send mail that it believes
332 might be a loop to C<$OwnerEmail>.
336 Set($LoopsToRTOwner, 1);
340 If C<$StoreLoops> is defined, RT will record messages that it believes
341 to be part of mail loops. As it does this, it will try to be careful
342 not to send mail to the sender of these messages.
346 Set($StoreLoops, undef);
348 =item C<$MaxAttachmentSize>
350 C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments
351 stored in the database.
355 Set($MaxAttachmentSize, 10_000_000);
357 =item C<$TruncateLongAttachments>
359 If this is set to a non-undef value, RT will truncate attachments
360 longer than C<$MaxAttachmentSize>.
364 Set($TruncateLongAttachments, undef);
366 =item C<$DropLongAttachments>
368 If this is set to a non-undef value, RT will silently drop attachments
369 longer than C<MaxAttachmentSize>. C<$TruncateLongAttachments>, above,
370 takes priority over this.
374 Set($DropLongAttachments, undef);
376 =item C<$RTAddressRegexp>
378 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a
379 ticket CC if C<$ParseNewMessageForTicketCcs>, above, is enabled. It
380 is important that you set this to a regular expression that matches
381 all addresses used by your RT. This lets RT avoid sending mail to
382 itself. It will also hide RT addresses from the list of "One-time Cc"
383 and Bcc lists on ticket reply.
385 If you have a number of addresses configured in your RT database
386 already, you can generate a naive first pass regexp by using:
388 perl etc/upgrade/generate-rtaddressregexp
390 If left blank, RT will generate a regexp for you, based on your
391 comment and correspond address settings on your queues; this comes at
392 a small cost in start-up speed.
396 Set($RTAddressRegexp, undef);
398 =item C<$IgnoreCcRegexp>
400 C<$IgnoreCcRegexp> is a regexp to exclude addresses from automatic addition
401 to the Cc list. Use this for addresses that are I<not> received by RT but
402 are sometimes added to Cc lists by mistake. Unlike C<$RTAddressRegexp>,
403 these addresses can still receive email from RT otherwise.
407 Set($IgnoreCcRegexp, undef);
409 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
411 RT provides functionality which allows the system to rewrite incoming
412 email addresses. In its simplest form, you can substitute the value
413 in C<CanonicalizeEmailAddressReplace> for the value in
414 C<CanonicalizeEmailAddressMatch> (These values are passed to the
415 C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>)
417 By default, that routine performs a C<s/$Match/$Replace/gi> on any
418 address passed to it.
422 # Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$');
423 # Set($CanonicalizeEmailAddressReplace, '@example.com');
425 =item C<$CanonicalizeOnCreate>
427 Set this to 1 and the create new user page will use the values that
428 you enter in the form but use the function CanonicalizeUserInfo in
433 Set($CanonicalizeOnCreate, 0);
435 =item C<$ValidateUserEmailAddresses>
437 If C<$ValidateUserEmailAddresses> is 1, RT will refuse to create
438 users with an invalid email address (as specified in RFC 2822) or with
439 an email address made of multiple email addresses.
443 Set($ValidateUserEmailAddresses, undef);
445 =item C<$NonCustomerEmailRegexp>
447 Normally, when a ticket is linked to a customer, any requestors on that
448 ticket that didn't previously have customer memberships are linked to
449 the customer also. C<$NonCustomerEmailRegexp> is a regexp for email
450 addresses that should I<not> automatically be linked to a customer in
455 Set($NonCustomerEmailRegexp, undef);
457 =item C<@MailPlugins>
459 C<@MailPlugins> is a list of authentication plugins for
460 L<RT::Interface::Email> to use; see L<rt-mailgate>
464 =item C<$UnsafeEmailCommands>
466 C<$UnsafeEmailCommands>, if set to 1, enables 'take' and 'resolve'
467 as possible actions via the mail gateway. As its name implies, this
468 is very unsafe, as it allows email with a forged sender to possibly
469 resolve arbitrary tickets!
473 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
475 The default "extract remote tracking tags" scrip settings; these
476 detect when your RT is talking to another RT, and adjust the subject
481 Set($ExtractSubjectTagMatch, qr/\[.+? #\d+\]/);
482 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
483 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
484 : qr/\[\Q$RT::rtname\E #\d+\]/));
494 =item C<$MailCommand>
496 C<$MailCommand> defines which method RT will use to try to send mail.
497 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
498 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
501 Note that you should remove the '-t' from C<$SendmailArguments> if you
502 use 'sendmail' rather than 'sendmailpipe'
504 For testing purposes, or to simply disable sending mail out into the
505 world, you can set C<$MailCommand> to 'testfile' which writes all mail
506 to a temporary file. RT will log the location of the temporary file
507 so you can extract mail from it afterward.
511 #Set($MailCommand, "sendmailpipe");
512 Set($MailCommand, "sendmail");
514 =item C<$SetOutgoingMailFrom>
516 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
517 Correspond mail address of the ticket's queue.
519 Warning: If you use this setting, bounced mails will appear to be
520 incoming mail to the system, thus creating new tickets.
524 Set($SetOutgoingMailFrom, 0);
526 =item C<$OverrideOutgoingMailFrom>
528 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
529 address of the queue as it is handed to sendmail -f. This helps force
530 the From_ header away from www-data or other email addresses that show
531 up in the "Sent by" line in Outlook.
533 The option is a hash reference of queue name to email address. If
534 there is no ticket involved, then the value of the C<Default> key will
537 This option is irrelevant unless C<$SetOutgoingMailFrom> is set.
541 Set($OverrideOutgoingMailFrom, {
542 # 'Default' => 'admin@rt.example.com',
543 # 'General' => 'general@rt.example.com',
546 =item C<$DefaultMailPrecedence>
548 C<$DefaultMailPrecedence> is used to control the default Precedence
549 level of outgoing mail where none is specified. By default it is
550 C<bulk>, but if you only send mail to your staff, you may wish to
553 Note that you can set the precedence of individual templates by
554 including an explicit Precedence header.
556 If you set this value to C<undef> then we do not set a default
557 Precedence header to outgoing mail. However, if there already is a
558 Precedence header, it will be preserved.
562 Set($DefaultMailPrecedence, "bulk");
564 =item C<$DefaultErrorMailPrecedence>
566 C<$DefaultErrorMailPrecedence> is used to control the default
567 Precedence level of outgoing mail that indicates some kind of error
568 condition. By default it is C<bulk>, but if you only send mail to your
569 staff, you may wish to change it.
571 If you set this value to C<undef> then we do not add a Precedence
572 header to error mail.
576 Set($DefaultErrorMailPrecedence, "bulk");
578 =item C<$UseOriginatorHeader>
580 C<$UseOriginatorHeader> is used to control the insertion of an
581 RT-Originator Header in every outgoing mail, containing the mail
582 address of the transaction creator.
586 Set($UseOriginatorHeader, 1);
588 =item C<$UseFriendlyFromLine>
590 By default, RT sets the outgoing mail's "From:" header to "SenderName
591 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
595 Set($UseFriendlyFromLine, 1);
597 =item C<$FriendlyFromLineFormat>
599 C<sprintf()> format of the friendly 'From:' header; its arguments are
600 SenderName and SenderEmailAddress.
604 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
606 =item C<$UseFriendlyToLine>
608 RT can optionally set a "Friendly" 'To:' header when sending messages
609 to Ccs or AdminCcs (rather than having a blank 'To:' header.
611 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
612 are using sendmail, rather than postfix, qmail, exim or some other
613 MTA, you _must_ disable this option.
617 Set($UseFriendlyToLine, 0);
619 =item C<$FriendlyToLineFormat>
621 C<sprintf()> format of the friendly 'To:' header; its arguments are
622 WatcherType and TicketId.
626 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
628 =item C<$NotifyActor>
630 By default, RT doesn't notify the person who performs an update, as
631 they already know what they've done. If you'd like to change this
632 behavior, Set C<$NotifyActor> to 1
636 Set($NotifyActor, 0);
638 =item C<$RecordOutgoingEmail>
640 By default, RT records each message it sends out to its own internal
641 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
645 Set($RecordOutgoingEmail, 1);
647 =item C<$VERPPrefix>, C<$VERPDomain>
649 Setting these options enables VERP support
650 L<http://cr.yp.to/proto/verp.txt>.
652 Uncomment the following two directives to generate envelope senders
653 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
654 (i.e. rt-jesse=fsck.com@rt.example.com ).
656 This currently only works with sendmail and sendmailpipe.
660 # Set($VERPPrefix, "rt-");
661 # Set($VERPDomain, $RT::Organization);
664 =item C<$ForwardFromUser>
666 By default, RT forwards a message using queue's address and adds RT's
667 tag into subject of the outgoing message, so recipients' replies go
668 into RT as correspondents.
670 To change this behavior, set C<$ForwardFromUser> to 1 and RT
671 will use the address of the current user and remove RT's subject tag.
675 Set($ForwardFromUser, 0);
679 =head2 Email dashboards
683 =item C<$DashboardAddress>
685 The email address from which RT will send dashboards. If none is set,
686 then C<$OwnerEmail> will be used.
690 Set($DashboardAddress, '');
692 =item C<$DashboardSubject>
694 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
695 Weekly, Monthly) of the dashboard and the dashboard's name.
699 Set($DashboardSubject, "%s Dashboard: %s");
701 =item C<@EmailDashboardRemove>
703 A list of regular expressions that will be used to remove content from
708 Set(@EmailDashboardRemove, ());
714 =head2 Sendmail configuration
716 These options only take effect if C<$MailCommand> is 'sendmail' or
721 =item C<$SendmailArguments>
723 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
724 If you picked 'sendmailpipe', you MUST add a -t flag to
725 C<$SendmailArguments> These options are good for most sendmail
726 wrappers and work-a-likes.
728 These arguments are good for sendmail brand sendmail 8 and newer:
729 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
733 #Set($SendmailArguments, "-oi -t");
734 Set($SendmailArguments, "-oi");
737 =item C<$SendmailBounceArguments>
739 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
740 assuming RT needs to send an error (i.e. bounce).
744 Set($SendmailBounceArguments, '-f "<>"');
746 =item C<$SendmailPath>
748 If you selected 'sendmailpipe' above, you MUST specify the path to
749 your sendmail binary in C<$SendmailPath>.
753 Set($SendmailPath, "/usr/sbin/sendmail");
758 =head2 SMTP configuration
760 These options only take effect if C<$MailCommand> is 'smtp'
766 C<$SMTPServer> should be set to the hostname of the SMTP server to use
770 Set($SMTPServer, undef);
774 C<$SMTPFrom> should be set to the 'From' address to use, if not the
779 Set($SMTPFrom, undef);
783 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
797 C<@MailParams> defines a list of options passed to $MailCommand if it
798 is not 'sendmailpipe', 'sendmail', or 'smtp'
802 Set(@MailParams, ());
811 =item C<$WebDefaultStylesheet>
813 This determines the default stylesheet the RT web interface will use.
814 RT ships with several themes by default:
816 web2 The default layout for RT 3.8
817 aileron The default layout for RT 4.0
818 ballard Theme which doesn't rely on JavaScript for menuing
820 This bundled distibution of RT also includes:
821 freeside3 Integration with Freeside (enabled by default)
822 freeside2.1 Previous Freeside theme
824 This value actually specifies a directory in F<share/html/NoAuth/css/>
825 from which RT will try to load the file main.css (which should @import
826 any other files the stylesheet needs). This allows you to easily and
827 cleanly create your own stylesheets to apply to RT. This option can
828 be overridden by users in their preferences.
832 Set($WebDefaultStylesheet, "freeside3");
834 =item C<$DefaultQueue>
836 Use this to select the default queue name that will be used for
837 creating new tickets. You may use either the queue's name or its
838 ID. This only affects the queue selection boxes on the web interface.
842 # Set($DefaultQueue, "General");
844 =item C<$RememberDefaultQueue>
846 When a queue is selected in the new ticket dropdown, make it the new
847 default for the new ticket dropdown.
851 # Set($RememberDefaultQueue, 1);
853 =item C<$EnableReminders>
855 Hide all links and portlets related to Reminders by setting this to 0
859 Set($EnableReminders, 1);
861 =item C<@CustomFieldValuesSources>
863 Set C<@CustomFieldValuesSources> to a list of class names which extend
864 L<RT::CustomFieldValues::External>. This can be used to pull lists of
865 custom field values from external sources at runtime.
869 Set(@CustomFieldValuesSources, ('RT::CustomFieldValues::Queues'));
871 =item C<$CanonicalizeRedirectURLs>
873 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
874 redirecting rather than the one we get from C<%ENV>.
876 Apache's UseCanonicalName directive changes the hostname that RT
877 finds in C<%ENV>. You can read more about what turning it On or Off
878 means in the documentation for your version of Apache.
880 If you use RT behind a reverse proxy, you almost certainly want to
885 Set($CanonicalizeRedirectURLs, 0);
889 A list of JavaScript files to be included in head. Removing any of
890 the default entries is not suggested.
892 If you're a plugin author, refer to RT->AddJavaScript.
899 jquery-ui-1.8.4.custom.min.js
900 jquery-ui-patch-datepicker.js
905 jquery.event.hover-1.0.js
908 jquery.supposition.js
915 Path to the jsmin binary; if specified, it will be used to minify
916 C<JSFiles>. The default, and the fallback if the binary cannot be
917 found, is to simply concatenate the files.
919 jsmin can be installed by running 'make jsmin' from the RT install
920 directory, or from http://www.crockford.com/javascript/jsmin.html
924 # Set($JSMinPath, "/path/to/jsmin");
928 A list of additional CSS files to be included in head.
930 If you're a plugin author, refer to RT->AddStyleSheets.
934 Set(@CSSFiles, qw//);
936 =item C<$UsernameFormat>
938 This determines how user info is displayed. 'concise' will show one of
939 either NickName, RealName, Name or EmailAddress, depending on what
940 exists and whether the user is privileged or not. 'verbose' will show
941 RealName and EmailAddress.
945 Set($UsernameFormat, "verbose");
947 =item C<$WebBaseURL>, C<$WebURL>
949 Usually you don't want to set these options. The only obvious reason
950 is if RT is accessible via https protocol on a non standard port, e.g.
951 'https://rt.example.com:9999'. In all other cases these options are
952 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
954 C<$WebBaseURL> is the scheme, server and port
955 (e.g. 'http://rt.example.com') for constructing URLs to the web
956 UI. C<$WebBaseURL> doesn't need a trailing /.
958 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
959 example: 'http://www.example.com/rt/'.
963 my $port = RT->Config->Get('WebPort');
965 ($port == 443? 'https': 'http') .'://'
966 . RT->Config->Get('WebDomain')
967 . ($port != 80 && $port != 443? ":$port" : '')
970 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
972 =item C<$WebImagesURL>
974 C<$WebImagesURL> points to the base URL where RT can find its images.
975 Define the directory name to be used for images in RT web documents.
979 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
983 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
984 This can also be configured via the web UI.
988 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
990 =item C<$LogoLinkURL>
992 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
996 Set($LogoLinkURL, "http://bestpractical.com");
998 =item C<$LogoAltText>
1000 C<$LogoAltText> is a string of text for the alt-text of the logo. It
1001 will be passed through C<loc> for localization.
1005 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1007 =item C<$LogoImageHeight>
1009 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1014 Set($LogoImageHeight, 38);
1016 =item C<$LogoImageWidth>
1018 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1023 Set($LogoImageWidth, 181);
1025 =item C<$WebNoAuthRegex>
1027 What portion of RT's URL space should not require authentication. The
1028 default is almost certainly correct, and should only be changed if you
1033 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1035 =item C<$SelfServiceRegex>
1037 What portion of RT's URLspace should be accessible to Unprivileged
1038 users This does not override the redirect from F</Ticket/Display.html>
1039 to F</SelfService/Display.html> when Unprivileged users attempt to
1040 access ticked displays.
1044 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1046 =item C<$WebFlushDbCacheEveryRequest>
1048 By default, RT clears its database cache after every page view. This
1049 ensures that you've always got the most current information when
1050 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1051 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1052 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1056 Set($WebFlushDbCacheEveryRequest, 1);
1060 The L<GD> module (which RT uses for graphs) ships with a built-in font
1061 that doesn't have full Unicode support. You can use a given TrueType
1062 font for a specific language by setting %ChartFont to (language =E<gt>
1063 the absolute path of a font) pairs. Your GD library must have support
1064 for TrueType fonts to use this option. If there is no entry for a
1065 language in the hash then font with 'others' key is used.
1067 RT comes with two TrueType fonts covering most available languages.
1073 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1074 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1075 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1076 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1079 =item C<$ChartsTimezonesInDB>
1081 RT stores dates using the UTC timezone in the DB, so charts grouped by
1082 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1083 to enable timezone conversions using your DB's capabilities. You may
1084 need to do some work on the DB side to use this feature, read more in
1085 F<docs/customizing/timezones_in_charts.pod>.
1087 At this time, this feature only applies to MySQL and PostgreSQL.
1091 Set($ChartsTimezonesInDB, 0);
1101 =item C<$DefaultSummaryRows>
1103 C<$DefaultSummaryRows> is default number of rows displayed in for
1104 search results on the front page.
1108 Set($DefaultSummaryRows, 10);
1110 =item C<$HomePageRefreshInterval>
1112 C<$HomePageRefreshInterval> is default number of seconds to refresh
1113 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1117 Set($HomePageRefreshInterval, 0);
1119 =item C<$HomepageComponents>
1121 C<$HomepageComponents> is an arrayref of allowed components on a
1122 user's customized homepage ("RT at a glance").
1126 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
1133 =head2 Ticket search
1137 =item C<$UseSQLForACLChecks>
1139 Historically, ACLs were checked on display, which could lead to empty
1140 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1141 to limit search results in SQL instead, which eliminates these
1144 This option is still relatively new; it may result in performance
1145 problems in some cases, or significant speedups in others.
1149 Set($UseSQLForACLChecks, undef);
1151 =item C<$TicketsItemMapSize>
1153 On the display page of a ticket from search results, RT provides links
1154 to the first, next, previous and last ticket from the results. In
1155 order to build these links, RT needs to fetch the full result set from
1156 the database, which can be resource-intensive.
1158 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1159 to build these links. If the full result set is larger than this
1160 number, RT will omit the "last" link in the menu. Set this to zero to
1161 always examine all results.
1165 Set($TicketsItemMapSize, 1000);
1167 =item C<$SearchResultsRefreshInterval>
1169 C<$SearchResultsRefreshInterval> is default number of seconds to
1170 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1175 Set($SearchResultsRefreshInterval, 0);
1177 =item C<$DefaultSearchResultFormat>
1179 C<$DefaultSearchResultFormat> is the default format for RT search
1184 Set ($DefaultSearchResultFormat, qq{
1185 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1186 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1194 '<small>__Requestors__</small>',
1195 '<small>__CustomerTags__</small>',
1196 '<small>__CreatedRelative__</small>',
1197 '<small>__ToldRelative__</small>',
1198 '<small>__LastUpdatedRelative__</small>',
1199 '<small>__TimeLeft__</small>'});
1201 =item C<$DefaultSelfServiceSearchResultFormat>
1203 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1204 searches displayed in the SelfService interface.
1208 Set($DefaultSelfServiceSearchResultFormat, qq{
1209 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1210 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1215 =item C<%FullTextSearch>
1217 Full text search (FTS) without database indexing is a very slow
1218 operation, and is thus disabled by default.
1220 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1221 the full details of FTS on your particular database.
1223 It is possible to enable FTS without database indexing support, simply
1224 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1225 This is not generally suggested, as unindexed full-text searching can
1226 cause severe performance problems.
1230 Set(%FullTextSearch,
1236 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1238 When query in simple search doesn't have status info, use this to only
1243 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1245 =item C<$SearchResultsAutoRedirect>
1247 When only one ticket is found in search, use this to redirect to the
1248 ticket display page automatically.
1252 Set($SearchResultsAutoRedirect, 0);
1258 =head2 Ticket display
1262 =item C<$ShowMoreAboutPrivilegedUsers>
1264 This determines if the 'More about requestor' box on
1265 Ticket/Display.html is shown for Privileged Users.
1269 Set($ShowMoreAboutPrivilegedUsers, 0);
1271 =item C<$MoreAboutRequestorTicketList>
1273 This can be set to Active, Inactive, All or None. It controls what
1274 ticket list will be displayed in the 'More about requestor' box on
1275 Ticket/Display.html. This option can be controlled by users also.
1279 Set($MoreAboutRequestorTicketList, "Active");
1281 =item C<$MoreAboutRequestorExtraInfo>
1283 By default, the 'More about requestor' box on Ticket/Display.html
1284 shows the Requestor's name and ticket list. If you would like to see
1285 extra information about the user, this expects a Format string of user
1286 attributes. Please note that not all the attributes are supported in
1287 this display because we're not building a table.
1290 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1294 Set($MoreAboutRequestorExtraInfo, "");
1296 =item C<$MoreAboutRequestorGroupsLimit>
1298 By default, the 'More about requestor' box on Ticket/Display.html
1299 shows all the groups of the Requestor. Use this to limit the number
1300 of groups; a value of undef removes the group display entirely.
1304 Set($MoreAboutRequestorGroupsLimit, 0);
1306 =item C<$UseSideBySideLayout>
1308 Should the ticket create and update forms use a more space efficient
1309 two column layout. This layout may not work in narrow browsers if you
1310 set a MessageBoxWidth (below).
1314 Set($UseSideBySideLayout, 1);
1316 =item C<$EditCustomFieldsSingleColumn>
1318 When displaying a list of Ticket Custom Fields for editing, RT
1319 defaults to a 2 column list. If you set this to 1, it will instead
1320 display the Custom Fields in a single column.
1324 Set($EditCustomFieldsSingleColumn, 0);
1326 =item C<$ShowUnreadMessageNotifications>
1328 If set to 1, RT will prompt users when there are new,
1329 unread messages on tickets they are viewing.
1333 Set($ShowUnreadMessageNotifications, 0);
1335 =item C<$AutocompleteOwners>
1337 If set to 1, the owner drop-downs for ticket update/modify and the query
1338 builder are replaced by text fields that autocomplete. This can
1339 alleviate the sometimes huge owner list for installations where many
1340 users have the OwnTicket right.
1344 Set($AutocompleteOwners, 0);
1346 =item C<$AutocompleteOwnersForSearch>
1348 If set to 1, the owner drop-downs for the query builder are always
1349 replaced by text field that autocomplete and C<$AutocompleteOwners>
1350 is ignored. Helpful when owners list is huge in the query builder.
1354 Set($AutocompleteOwnersForSearch, 0);
1356 =item C<$UserAutocompleteFields>
1358 Specifies which fields of L<RT::User> to match against and how to
1359 match each field when autocompleting users. Valid match methods are
1360 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1364 Set($UserAutocompleteFields, {
1365 EmailAddress => 'STARTSWITH',
1366 Name => 'STARTSWITH',
1370 =item C<$AllowUserAutocompleteForUnprivileged>
1372 Should unprivileged users be allowed to autocomplete users. Setting
1373 this option to 1 means unprivileged users will be able to search all
1378 Set($AllowUserAutocompleteForUnprivileged, 0);
1380 =item C<$DisplayTicketAfterQuickCreate>
1382 Enable this to redirect to the created ticket display page
1383 automatically when using QuickCreate.
1387 Set($DisplayTicketAfterQuickCreate, 0);
1389 =item C<$WikiImplicitLinks>
1391 Support implicit links in WikiText custom fields? Setting this to 1
1392 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1393 become links to searches for those words. If used on Articles, it links
1394 to the Article with that name.
1398 Set($WikiImplicitLinks, 0);
1400 =item C<$PreviewScripMessages>
1402 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1403 reply page should include the content of the messages to be sent.
1407 Set($PreviewScripMessages, 0);
1409 =item C<$SimplifiedRecipients>
1411 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1412 B<any> kind of mail will be shown on the ticket reply page, instead of a
1413 detailed breakdown by scrip.
1417 Set($SimplifiedRecipients, 0);
1419 =item C<$HideResolveActionsWithDependencies>
1421 If set to 1, this option will skip ticket menu actions which can't be
1422 completed successfully because of outstanding active Depends On tickets.
1424 By default, all ticket actions are displayed in the menu even if some of
1425 them can't be successful until all Depends On links are resolved or
1426 transitioned to another inactive status.
1430 Set($HideResolveActionsWithDependencies, 0);
1440 =item C<$ArticleOnTicketCreate>
1442 Set this to 1 to display the Articles interface on the Ticket Create
1443 page in addition to the Reply/Comment page.
1447 Set($ArticleOnTicketCreate, 0);
1449 =item C<$HideArticleSearchOnReplyCreate>
1451 Set this to 1 to hide the search and include boxes from the Article
1452 UI. This assumes you have enabled Article Hotlist feature, otherwise
1453 you will have no access to Articles.
1457 Set($HideArticleSearchOnReplyCreate, 0);
1463 =head2 Message box properties
1467 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1469 For message boxes, set the entry box width, height and what type of
1470 wrapping to use. These options can be overridden by users in their
1473 When the width is set to undef, no column count is specified and the
1474 message box will take up 100% of the available width. Combining this
1475 with HARD messagebox wrapping (below) is not recommended, as it will
1476 lead to inconsistent width in transactions between browsers.
1478 These settings only apply to the non-RichText message box. See below
1479 for Rich Text settings.
1483 Set($MessageBoxWidth, undef);
1484 Set($MessageBoxHeight, 15);
1486 =item C<$MessageBoxWrap>
1488 Wrapping is disabled when using MessageBoxRichText because of a bad
1489 interaction between IE and wrapping with the Rich Text Editor.
1493 Set($MessageBoxWrap, "SOFT");
1495 =item C<$MessageBoxRichText>
1497 Should "rich text" editing be enabled? This option lets your users
1498 send HTML email messages from the web interface.
1502 Set($MessageBoxRichText, 1);
1504 =item C<$MessageBoxRichTextHeight>
1506 Height of rich text JavaScript enabled editing boxes (in pixels)
1510 Set($MessageBoxRichTextHeight, 200);
1512 =item C<$MessageBoxIncludeSignature>
1514 Should your users' signatures (from their Preferences page) be
1515 included in Comments and Replies.
1519 Set($MessageBoxIncludeSignature, 1);
1521 =item C<$MessageBoxIncludeSignatureOnComment>
1523 Should your users' signatures (from their Preferences page) be
1524 included in Comments. Setting this to false overrides
1525 C<$MessageBoxIncludeSignature>.
1529 Set($MessageBoxIncludeSignatureOnComment, 1);
1534 =head2 Transaction display
1538 =item C<$OldestTransactionsFirst>
1540 By default, RT shows newest transactions at the bottom of the ticket
1541 history page, if you want see them at the top set this to 0. This
1542 option can be overridden by users in their preferences.
1546 Set($OldestTransactionsFirst, 1);
1548 =item C<$DeferTransactionLoading>
1550 When set, defers loading ticket history until the user clicks a link.
1551 This should end up serving pages to users quicker, since generating
1552 all the HTML for transaction history can be slow for long tickets.
1556 # Set($DeferTransactionLoading, 1);
1558 =item C<$ShowBccHeader>
1560 By default, RT hides from the web UI information about blind copies
1561 user sent on reply or comment.
1565 Set($ShowBccHeader, 0);
1567 =item C<$TrustHTMLAttachments>
1569 If C<TrustHTMLAttachments> is not defined, we will display them as
1570 text. This prevents malicious HTML and JavaScript from being sent in a
1571 request (although there is probably more to it than that)
1575 Set($TrustHTMLAttachments, undef);
1577 =item C<$AlwaysDownloadAttachments>
1579 Always download attachments, regardless of content type. If set, this
1580 overrides C<TrustHTMLAttachments>.
1584 Set($AlwaysDownloadAttachments, undef);
1586 =item C<$AttachmentUnits>
1588 Controls the units (kilobytes or bytes) that attachment sizes use for
1589 display. The default is to display kilobytes if the attachment is
1590 larger than 1024 bytes, bytes otherwise. If you set
1591 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1592 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1596 Set($AttachmentUnits, undef);
1598 =item C<$PreferRichText>
1600 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1601 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1602 show only a minimal subset of HTML to avoid possible contamination by
1603 cross-site-scripting attacks.
1607 Set($PreferRichText, undef);
1609 =item C<$MaxInlineBody>
1611 C<$MaxInlineBody> is the maximum attachment size that we want to see
1612 inline when viewing a transaction. RT will inline any text if the
1613 value is undefined or 0. This option can be overridden by users in
1618 Set($MaxInlineBody, 12000);
1620 =item C<$ShowTransactionImages>
1622 By default, RT shows images attached to incoming (and outgoing) ticket
1623 updates inline. Set this variable to 0 if you'd like to disable that
1628 Set($ShowTransactionImages, 1);
1630 =item C<$PlainTextPre>
1632 Normally plaintext attachments are displayed as HTML with line breaks
1633 preserved. This causes space- and tab-based formatting not to be
1634 displayed correctly. By setting $PlainTextPre messages will be
1635 displayed using <pre>.
1639 Set($PlainTextPre, 0);
1642 =item C<$PlainTextMono>
1644 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1645 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1646 of the browser window; this option overrides C<$PlainTextPre>.
1650 Set($PlainTextMono, 0);
1652 =item C<$SuppressInlineTextFiles>
1654 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1655 (text-type attachments with file names) are prevented from being
1656 displayed in-line when viewing a ticket's history.
1660 Set($SuppressInlineTextFiles, undef);
1663 =item C<@Active_MakeClicky>
1665 MakeClicky detects various formats of data in headers and email
1666 messages, and extends them with supporting links. By default, RT
1667 provides two formats:
1669 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1672 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1673 replaces the URL with a link.
1675 See F<share/html/Elements/MakeClicky> for documentation on how to add
1676 your own styles of link detection.
1680 Set(@Active_MakeClicky, qw());
1686 =head1 Application logic
1690 =item C<$ParseNewMessageForTicketCcs>
1692 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1693 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1694 messages. Be forewarned that if you have I<any> addresses which forward
1695 mail to RT automatically and you enable this option without modifying
1696 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1700 Set($ParseNewMessageForTicketCcs, undef);
1702 =item C<$UseTransactionBatch>
1704 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1705 such that a resolve and comment (for example) would happen
1706 simultaneously, instead of as two transactions, unaware of each
1711 Set($UseTransactionBatch, 1);
1713 =item C<$StrictLinkACL>
1715 When this feature is enabled a user needs I<ModifyTicket> rights on
1716 both tickets to link them together; otherwise, I<ModifyTicket> rights
1717 on either of them is sufficient.
1721 Set($StrictLinkACL, 1);
1723 =item C<$RedistributeAutoGeneratedMessages>
1725 Should RT redistribute correspondence that it identifies as machine
1726 generated? A 1 will do so; setting this to 0 will cause no
1727 such messages to be redistributed. You can also use 'privileged' (the
1728 default), which will redistribute only to privileged users. This helps
1729 to protect against malformed bounces and loops caused by auto-created
1730 requestors with bogus addresses.
1734 Set($RedistributeAutoGeneratedMessages, "privileged");
1736 =item C<$ApprovalRejectionNotes>
1738 Should rejection notes from approvals be sent to the requestors?
1742 Set($ApprovalRejectionNotes, 1);
1744 =item C<$ForceApprovalsView>
1746 Should approval tickets only be viewed and modified through the standard
1747 approval interface? Changing this setting to 1 will redirect any attempt to
1748 use the normal ticket display and modify page for approval tickets.
1750 For example, with this option set to 1 and an approval ticket #123:
1752 /Ticket/Display.html?id=123
1756 /Approval/Display.html?id=123
1762 Set($ForceApprovalsView, 0);
1764 =head1 Extra security
1768 This is a list of extra security measures to enable that help keep your RT
1769 safe. If you don't know what these mean, you should almost certainly leave the
1772 =item C<$DisallowExecuteCode>
1774 If set to a true value, the C<ExecuteCode> right will be removed from
1775 all users, B<including> the superuser. This is intended for when RT is
1776 installed into a shared environment where even the superuser should not
1777 be allowed to run arbitrary Perl code on the server via scrips.
1781 Set($DisallowExecuteCode, 0);
1783 =item C<$Framebusting>
1785 If set to a false value, framekiller javascript will be disabled and the
1786 X-Frame-Options: DENY header will be suppressed from all responses.
1787 This disables RT's clickjacking protection.
1791 Set($Framebusting, 1);
1793 =item C<$RestrictReferrer>
1795 If set to a false value, the HTTP C<Referer> (sic) header will not be
1796 checked to ensure that requests come from RT's own domain. As RT allows
1797 for GET requests to alter state, disabling this opens RT up to
1798 cross-site request forgery (CSRF) attacks.
1802 Set($RestrictReferrer, 1);
1804 =item C<$RestrictLoginReferrer>
1806 If set to a false value, RT will allow the user to log in from any link
1807 or request, merely by passing in C<user> and C<pass> parameters; setting
1808 it to a true value forces all logins to come from the login box, so the
1809 user is aware that they are being logged in. The default is off, for
1810 backwards compatability.
1814 Set($RestrictLoginReferrer, 0);
1816 =item C<$ReferrerWhitelist>
1818 This is a list of hostname:port combinations that RT will treat as being
1819 part of RT's domain. This is particularly useful if you access RT as
1820 multiple hostnames or have an external auth system that needs to
1821 redirect back to RT once authentication is complete.
1823 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1825 If the "RT has detected a possible cross-site request forgery" error is triggered
1826 by a host:port sent by your browser that you believe should be valid, you can copy
1827 the host:port from the error message into this list.
1831 Set(@ReferrerWhitelist, qw());
1837 =head1 Authorization and user configuration
1841 =item C<$WebExternalAuth>
1843 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1844 REMOTE_USER variable.
1848 Set($WebExternalAuth, undef);
1850 =item C<$WebExternalAuthContinuous>
1852 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1853 REMOTE_USER on each access. If you would prefer this to only happen
1854 once (at initial login) set this to a false value. The default
1855 setting will help ensure that if your external authentication system
1856 deauthenticates a user, RT notices as soon as possible.
1860 Set($WebExternalAuthContinuous, 1);
1862 =item C<$WebFallbackToInternalAuth>
1864 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1865 chance of fallback to the login screen, even if REMOTE_USER failed.
1869 Set($WebFallbackToInternalAuth, undef);
1871 =item C<$WebExternalGecos>
1873 C<$WebExternalGecos> means to match 'gecos' field as the user
1874 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1879 Set($WebExternalGecos, undef);
1881 =item C<$WebExternalAuto>
1883 C<$WebExternalAuto> will create users under the same name as
1884 REMOTE_USER upon login, if it's missing in the Users table.
1888 Set($WebExternalAuto, undef);
1890 =item C<$AutoCreate>
1892 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1893 User's Create method. Use it to set defaults, such as creating
1894 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1898 Set($AutoCreate, undef);
1900 =item C<$WebSessionClass>
1902 C<$WebSessionClass> is the class you wish to use for managing sessions.
1903 It defaults to use your SQL database, except on Oracle, where it
1904 defaults to files on disk.
1908 # Set($WebSessionClass, "Apache::Session::File");
1910 =item C<$AutoLogoff>
1912 By default, RT's user sessions persist until a user closes his or her
1913 browser. With the C<$AutoLogoff> option you can setup session lifetime
1914 in minutes. A user will be logged out if he or she doesn't send any
1915 requests to RT for the defined time.
1919 Set($AutoLogoff, 0);
1921 =item C<$LogoutRefresh>
1923 The number of seconds to wait after logout before sending the user to
1924 the login page. By default, 1 second, though you may want to increase
1925 this if you display additional information on the logout page.
1929 Set($LogoutRefresh, 1);
1931 =item C<$WebSecureCookies>
1933 By default, RT's session cookie isn't marked as "secure". Some web
1934 browsers will treat secure cookies more carefully than non-secure
1935 ones, being careful not to write them to disk, only sending them over
1936 an SSL secured connection, and so on. To enable this behavior, set
1937 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1938 on I<unless> users are only connecting via SSL encrypted HTTPS
1943 Set($WebSecureCookies, 0);
1945 =item C<$WebHttpOnlyCookies>
1947 Default RT's session cookie to not being directly accessible to
1948 javascript. The content is still sent during regular and AJAX requests,
1949 and other cookies are unaffected, but the session-id is less
1950 programmatically accessible to javascript. Turning this off should only
1951 be necessary in situations with odd client-side authentication
1956 Set($WebHttpOnlyCookies, 1);
1958 =item C<$MinimumPasswordLength>
1960 C<$MinimumPasswordLength> defines the minimum length for user
1961 passwords. Setting it to 0 disables this check.
1965 Set($MinimumPasswordLength, 5);
1970 =head1 Internationalization
1974 =item C<@LexiconLanguages>
1976 An array that contains languages supported by RT's
1977 internationalization interface. Defaults to all *.po lexicons;
1978 setting it to C<qw(en ja)> will make RT bilingual instead of
1979 multilingual, but will save some memory.
1983 Set(@LexiconLanguages, qw(*));
1985 =item C<@EmailInputEncodings>
1987 An array that contains default encodings used to guess which charset
1988 an attachment uses, if it does not specify one explicitly. All
1989 options must be recognized by L<Encode::Guess>. The first element may
1990 also be '*', which enables encoding detection using
1991 L<Encode::Detect::Detector>, if installed.
1995 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1997 =item C<$EmailOutputEncoding>
1999 The charset for localized email. Must be recognized by Encode.
2003 Set($EmailOutputEncoding, "utf-8");
2013 =head1 Date and time handling
2017 =item C<$DateTimeFormat>
2019 You can choose date and time format. See the "Output formatters"
2020 section in perldoc F<lib/RT/Date.pm> for more options. This option
2021 can be overridden by users in their preferences.
2025 C<Set($DateTimeFormat, "LocalizedDateTime");>
2026 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2027 C<Set($DateTimeFormat, "RFC2822");>
2028 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2032 Set($DateTimeFormat, "DefaultFormat");
2034 # Next two options are for Time::ParseDate
2036 =item C<$DateDayBeforeMonth>
2038 Set this to 1 if your local date convention looks like "dd/mm/yy"
2039 instead of "mm/dd/yy". Used only for parsing, not for displaying
2044 Set($DateDayBeforeMonth, 1);
2046 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2048 Should an unspecified day or year in a date refer to a future or a
2049 past value? For example, should a date of "Tuesday" default to mean
2050 the date for next Tuesday or last Tuesday? Should the date "March 1"
2051 default to the date for next March or last March?
2053 Set C<$AmbiguousDayInPast> for the last date, or
2054 C<$AmbiguousDayInFuture> for the next date; the default is usually
2055 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2059 Set($AmbiguousDayInPast, 0);
2060 Set($AmbiguousDayInFuture, 0);
2062 =item C<$DefaultTimeUnitsToHours>
2064 Use this to set the default units for time entry to hours instead of
2065 minutes. Note that this only effects entry, not display.
2069 Set($DefaultTimeUnitsToHours, 0);
2071 =item C<$SimpleSearchIncludeResolved>
2073 By default, the simple ticket search in the top bar excludes "resolved" tickets
2074 unless a status argument is specified. Set this to a true value to include
2079 Set($SimpleSearchIncludeResolved, 0);
2086 =head1 GnuPG integration
2088 A full description of the (somewhat extensive) GnuPG integration can
2089 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2090 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2096 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2097 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2099 If you want to allow people to encrypt attachments inside the DB then
2100 set C<AllowEncryptDataInDB> to 1.
2102 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2103 emails encrypted for key RT doesn't have and can not decrypt.
2105 Set C<RejectOnBadData> to false if you don't want to reject letters
2106 with incorrect GnuPG data.
2112 OutgoingMessagesFormat => "RFC", # Inline
2113 AllowEncryptDataInDB => 0,
2115 RejectOnMissingPrivateKey => 1,
2116 RejectOnBadData => 1,
2119 =item C<%GnuPGOptions>
2121 Options to pass to the GnuPG program.
2123 If you override this in your RT_SiteConfig, you should be sure to
2124 include a homedir setting.
2126 Note that options with '-' character MUST be quoted.
2131 homedir => q{@RT_VAR_PATH@/data/gpg},
2133 # URL of a keyserver
2134 # keyserver => 'hkp://subkeys.pgp.net',
2136 # enables the automatic retrieving of keys when encrypting
2137 # 'auto-key-locate' => 'keyserver',
2139 # enables the automatic retrieving of keys when verifying signatures
2140 # 'auto-key-retrieve' => undef,
2149 =head2 Lifecycle definitions
2151 Each lifecycle is a list of possible statuses split into three logic
2152 sets: B<initial>, B<active> and B<inactive>. Each status in a
2153 lifecycle must be unique. (Statuses may not be repeated across sets.)
2154 Each set may have any number of statuses.
2160 active => ['open', 'stalled'],
2161 inactive => ['resolved', 'rejected', 'deleted'],
2165 Status names can be from 1 to 64 ASCII characters. Statuses are
2166 localized using RT's standard internationalization and localization
2173 You can define multiple B<initial> statuses for tickets in a given
2176 RT will automatically set its B<Started> date when you change a
2177 ticket's status from an B<initial> state to an B<active> or
2182 B<Active> tickets are "currently in play" - they're things that are
2183 being worked on and not yet complete.
2187 B<Inactive> tickets are typically in their "final resting state".
2189 While you're free to implement a workflow that ignores that
2190 description, typically once a ticket enters an inactive state, it will
2191 never again enter an active state.
2193 RT will automatically set the B<Resolved> date when a ticket's status
2194 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2197 B<deleted> is still a special status and protected by the
2198 B<DeleteTicket> right, unless you re-defined rights (read below). If
2199 you don't want to allow ticket deletion at any time simply don't
2200 include it in your lifecycle.
2204 Statuses in each set are ordered and listed in the UI in the defined
2207 Changes between statuses are constrained by transition rules, as
2210 =head2 Default values
2212 In some cases a default value is used to display in UI or in API when
2213 value is not provided. You can configure defaults using the following
2220 on_resolve => 'resolved',
2225 The following defaults are used.
2231 If you (or your code) doesn't specify a status when creating a ticket,
2232 RT will use the this status. See also L</Statuses available during
2237 When tickets are merged, the status of the ticket that was merged
2238 away is forced to this value. It should be one of inactive statuses;
2239 'resolved' or its equivalent is most probably the best candidate.
2243 When an approval is accepted, the status of depending tickets will
2244 be changed to this value.
2248 When an approval is denied, the status of depending tickets will
2249 be changed to this value.
2251 =item reminder_on_open
2253 When a reminder is opened, the status will be changed to this value.
2255 =item reminder_on_resolve
2257 When a reminder is resolved, the status will be changed to this value.
2261 =head2 Transitions between statuses and UI actions
2263 A B<Transition> is a change of status from A to B. You should define
2264 all possible transitions in each lifecycle using the following format:
2269 '' => [qw(new open resolved)],
2270 new => [qw(open resolved rejected deleted)],
2271 open => [qw(stalled resolved rejected deleted)],
2272 stalled => [qw(open)],
2273 resolved => [qw(open)],
2274 rejected => [qw(open)],
2275 deleted => [qw(open)],
2280 =head3 Statuses available during ticket creation
2282 By default users can create tickets with any status, except
2283 deleted. If you want to restrict statuses available during creation
2284 then describe transition from '' (empty string), like in the example
2287 =head3 Protecting status changes with rights
2289 A transition or group of transitions can be protected by a specific
2290 right. Additionally, you can name new right names, which will be added
2291 to the system to control that transition. For example, if you wished to
2292 create a lesser right than ModifyTicket for rejecting tickets, you could
2298 '* -> deleted' => 'DeleteTicket',
2299 '* -> rejected' => 'RejectTicket',
2300 '* -> *' => 'ModifyTicket',
2305 This would create a new C<RejectTicket> right in the system which you
2306 could assign to whatever groups you choose.
2308 On the left hand side you can have the following variants:
2315 Valid transitions are listed in order of priority. If a user attempts
2316 to change a ticket's status from B<new> to B<open> then the lifecycle
2317 is checked for presence of an exact match, then for 'any to B<open>',
2318 'B<new> to any' and finally 'any to any'.
2320 If you don't define any rights, or there is no match for a transition,
2321 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2323 =head3 Labeling and defining actions
2325 For each transition you can define an action that will be shown in the
2326 UI; each action annotated with a label and an update type.
2328 Each action may provide a default update type, which can be
2329 B<Comment>, B<Respond>, or absent. For example, you may want your
2330 staff to write a reply to the end user when they change status from
2331 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2332 B<Comment> nor B<Respond> are mandatory, and user may leave the
2333 message empty, regardless of the update type.
2335 This configuration can be used to accomplish what
2336 $ResolveDefaultUpdateType was used for in RT 3.8.
2338 Use the following format to define labels and actions of transitions:
2343 'new -> open' => { label => 'Open it', update => 'Respond' },
2344 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2345 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2346 'new -> deleted' => { label => 'Delete' },
2348 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2349 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2350 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2352 'stalled -> open' => { label => 'Open it' },
2353 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2354 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2355 'deleted -> open' => { label => 'Undelete' },
2360 In addition, you may define multiple actions for the same transition.
2361 Alternately, you may use '* -> x' to match more than one transition.
2368 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2369 'new -> rejected' => { label => 'Quick Reject' },
2371 '* -> deleted' => { label => 'Delete' },
2377 =head2 Moving tickets between queues with different lifecycles
2379 Unless there is an explicit mapping between statuses in two different
2380 lifecycles, you can not move tickets between queues with these
2381 lifecycles. This is true even if the different lifecycles use the exact
2382 same set of statuses. Such a mapping is defined as follows:
2385 'from lifecycle -> to lifecycle' => {
2386 'status in left lifecycle' => 'status in right lifecycle',
2396 initial => [ 'new' ],
2397 active => [ 'open', 'stalled' ],
2398 inactive => [ 'resolved', 'rejected', 'deleted' ],
2402 on_merge => 'resolved',
2404 denied => 'rejected',
2405 reminder_on_open => 'open',
2406 reminder_on_resolve => 'resolved',
2410 '' => [qw(new open resolved)],
2412 # from => [ to list ],
2413 new => [qw(open stalled resolved rejected deleted)],
2414 open => [qw(new stalled resolved rejected deleted)],
2415 stalled => [qw(new open rejected resolved deleted)],
2416 resolved => [qw(new open stalled rejected deleted)],
2417 rejected => [qw(new open stalled resolved deleted)],
2418 deleted => [qw(new open stalled rejected resolved)],
2421 '* -> deleted' => 'DeleteTicket',
2422 '* -> *' => 'ModifyTicket',
2426 label => 'Open It', # loc
2427 update => 'Respond',
2429 'new -> resolved' => {
2430 label => 'Resolve', # loc
2431 update => 'Comment',
2433 'new -> rejected' => {
2434 label => 'Reject', # loc
2435 update => 'Respond',
2437 'new -> deleted' => {
2438 label => 'Delete', # loc
2441 'open -> stalled' => {
2442 label => 'Stall', # loc
2443 update => 'Comment',
2445 'open -> resolved' => {
2446 label => 'Resolve', # loc
2447 update => 'Comment',
2449 'open -> rejected' => {
2450 label => 'Reject', # loc
2451 update => 'Respond',
2454 'stalled -> open' => {
2455 label => 'Open It', # loc
2457 'resolved -> open' => {
2458 label => 'Re-open', # loc
2459 update => 'Comment',
2461 'rejected -> open' => {
2462 label => 'Re-open', # loc
2463 update => 'Comment',
2465 'deleted -> open' => {
2466 label => 'Undelete', # loc
2470 # don't change lifecyle of the approvals, they are not capable to deal with
2473 initial => [ 'new' ],
2474 active => [ 'open', 'stalled' ],
2475 inactive => [ 'resolved', 'rejected', 'deleted' ],
2479 on_merge => 'resolved',
2480 reminder_on_open => 'open',
2481 reminder_on_resolve => 'resolved',
2485 '' => [qw(new open resolved)],
2487 # from => [ to list ],
2488 new => [qw(open stalled resolved rejected deleted)],
2489 open => [qw(new stalled resolved rejected deleted)],
2490 stalled => [qw(new open rejected resolved deleted)],
2491 resolved => [qw(new open stalled rejected deleted)],
2492 rejected => [qw(new open stalled resolved deleted)],
2493 deleted => [qw(new open stalled rejected resolved)],
2496 '* -> deleted' => 'DeleteTicket',
2497 '* -> rejected' => 'ModifyTicket',
2498 '* -> *' => 'ModifyTicket',
2502 label => 'Open It', # loc
2503 update => 'Respond',
2505 'new -> resolved' => {
2506 label => 'Resolve', # loc
2507 update => 'Comment',
2509 'new -> rejected' => {
2510 label => 'Reject', # loc
2511 update => 'Respond',
2513 'new -> deleted' => {
2514 label => 'Delete', # loc
2517 'open -> stalled' => {
2518 label => 'Stall', # loc
2519 update => 'Comment',
2521 'open -> resolved' => {
2522 label => 'Resolve', # loc
2523 update => 'Comment',
2525 'open -> rejected' => {
2526 label => 'Reject', # loc
2527 update => 'Respond',
2530 'stalled -> open' => {
2531 label => 'Open It', # loc
2533 'resolved -> open' => {
2534 label => 'Re-open', # loc
2535 update => 'Comment',
2537 'rejected -> open' => {
2538 label => 'Re-open', # loc
2539 update => 'Comment',
2541 'deleted -> open' => {
2542 label => 'Undelete', # loc
2552 =head1 Administrative interface
2556 =item C<$ShowRTPortal>
2558 RT can show administrators a feed of recent RT releases and other
2559 related announcements and information from Best Practical on the top
2560 level Configuration page. This feature helps you stay up to date on
2561 RT security announcements and version updates.
2563 RT provides this feature using an "iframe" on C</Admin/index.html>
2564 which asks the administrator's browser to show an inline page from
2565 Best Practical's website.
2567 If you'd rather not make this feature available to your
2568 administrators, set C<$ShowRTPortal> to a false value.
2572 Set($ShowRTPortal, 1);
2574 =item C<%AdminSearchResultFormat>
2576 In the admin interface, format strings similar to tickets result
2577 formats are used. Use C<%AdminSearchResultFormat> to define the format
2578 strings used in the admin interface on a per-RT-class basis.
2582 Set(%AdminSearchResultFormat,
2584 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2585 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2586 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,'__Disabled__,__Lifecycle__},
2589 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2590 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2591 .q{,'__Description__'},
2594 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2595 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2596 .q{,__RealName__, __EmailAddress__},
2599 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2600 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2601 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2604 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2605 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2606 .q{,__Stage__, __Condition__, __Action__, __Template__},
2609 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2610 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2611 .q{,__Stage__, __Condition__, __Action__, __Template__},
2614 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2615 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2616 .q{,'__Description__'},
2618 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2619 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2620 .q{,__Description__},
2628 =head1 Development options
2634 RT comes with a "Development mode" setting. This setting, as a
2635 convenience for developers, turns on several of development options
2636 that you most likely don't want in production:
2642 Disables CSS and JS minification and concatenation. Both CSS and JS
2643 will be instead be served as a number of individual smaller files,
2644 unchanged from how they are stored on disk.
2648 Uses L<Module::Refresh> to reload changed Perl modules on each
2653 Turns off Mason's C<static_source> directive; this causes Mason to
2654 reload template files which have been modified on disk.
2658 Turns on Mason's HTML C<error_format>; this renders compilation errors
2659 to the browser, along with a full stack trace. It is possible for
2660 stack traces to reveal sensitive information such as passwords or
2665 Turns off caching of callbacks; this enables additional callbacks to
2666 be added while the server is running.
2672 Set($DevelMode, "@RT_DEVEL_MODE@");
2675 =item C<$RecordBaseClass>
2677 What abstract base class should RT use for its records. You should
2678 probably never change this.
2680 Valid values are C<DBIx::SearchBuilder::Record> or
2681 C<DBIx::SearchBuilder::Record::Cachable>
2685 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2688 =item C<@MasonParameters>
2690 C<@MasonParameters> is the list of parameters for the constructor of
2691 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2692 debugging, e.g. profiling individual components with:
2694 use MasonX::Profiler; # available on CPAN
2695 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2699 Set(@MasonParameters, ());
2701 =item C<$StatementLog>
2703 RT has rudimentary SQL statement logging support; simply set
2704 C<$StatementLog> to be the level that you wish SQL statements to be
2707 Enabling this option will also expose the SQL Queries page in the
2708 Configuration -> Tools menu for SuperUsers.
2712 Set($StatementLog, undef);
2719 =head1 Deprecated options
2723 =item C<$LinkTransactionsRun1Scrip>
2725 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2726 one transaction and run one scrip. Set this value to 1 if you want
2727 only one of the link transactions to have scrips run.
2731 Set($LinkTransactionsRun1Scrip, 0);
2733 =item C<$ResolveDefaultUpdateType>
2735 This option has been deprecated. You can configure this site-wide
2736 with L</Lifecycles> (see L</Labeling and defining actions>).