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
643 If this is disabled, users' digest mail delivery preferences
644 (i.e. EmailFrequency) will also be ignored.
648 Set($RecordOutgoingEmail, 1);
650 =item C<$VERPPrefix>, C<$VERPDomain>
652 Setting these options enables VERP support
653 L<http://cr.yp.to/proto/verp.txt>.
655 Uncomment the following two directives to generate envelope senders
656 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
657 (i.e. rt-jesse=fsck.com@rt.example.com ).
659 This currently only works with sendmail and sendmailpipe.
663 # Set($VERPPrefix, "rt-");
664 # Set($VERPDomain, $RT::Organization);
667 =item C<$ForwardFromUser>
669 By default, RT forwards a message using queue's address and adds RT's
670 tag into subject of the outgoing message, so recipients' replies go
671 into RT as correspondents.
673 To change this behavior, set C<$ForwardFromUser> to 1 and RT
674 will use the address of the current user and remove RT's subject tag.
678 Set($ForwardFromUser, 0);
682 =head2 Email dashboards
686 =item C<$DashboardAddress>
688 The email address from which RT will send dashboards. If none is set,
689 then C<$OwnerEmail> will be used.
693 Set($DashboardAddress, '');
695 =item C<$DashboardSubject>
697 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
698 Weekly, Monthly) of the dashboard and the dashboard's name.
702 Set($DashboardSubject, "%s Dashboard: %s");
704 =item C<@EmailDashboardRemove>
706 A list of regular expressions that will be used to remove content from
711 Set(@EmailDashboardRemove, ());
717 =head2 Sendmail configuration
719 These options only take effect if C<$MailCommand> is 'sendmail' or
724 =item C<$SendmailArguments>
726 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
727 If you picked 'sendmailpipe', you MUST add a -t flag to
728 C<$SendmailArguments> These options are good for most sendmail
729 wrappers and work-a-likes.
731 These arguments are good for sendmail brand sendmail 8 and newer:
732 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
736 #Set($SendmailArguments, "-oi -t");
737 Set($SendmailArguments, "-oi");
740 =item C<$SendmailBounceArguments>
742 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
743 assuming RT needs to send an error (i.e. bounce).
747 Set($SendmailBounceArguments, '-f "<>"');
749 =item C<$SendmailPath>
751 If you selected 'sendmailpipe' above, you MUST specify the path to
752 your sendmail binary in C<$SendmailPath>.
756 Set($SendmailPath, "/usr/sbin/sendmail");
761 =head2 SMTP configuration
763 These options only take effect if C<$MailCommand> is 'smtp'
769 C<$SMTPServer> should be set to the hostname of the SMTP server to use
773 Set($SMTPServer, undef);
777 C<$SMTPFrom> should be set to the 'From' address to use, if not the
782 Set($SMTPFrom, undef);
786 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
800 C<@MailParams> defines a list of options passed to $MailCommand if it
801 is not 'sendmailpipe', 'sendmail', or 'smtp'
805 Set(@MailParams, ());
814 =item C<$WebDefaultStylesheet>
816 This determines the default stylesheet the RT web interface will use.
817 RT ships with several themes by default:
819 web2 The default layout for RT 3.8
820 aileron The default layout for RT 4.0
821 ballard Theme which doesn't rely on JavaScript for menuing
823 This bundled distibution of RT also includes:
824 freeside3 Integration with Freeside (enabled by default)
825 freeside2.1 Previous Freeside theme
827 This value actually specifies a directory in F<share/html/NoAuth/css/>
828 from which RT will try to load the file main.css (which should @import
829 any other files the stylesheet needs). This allows you to easily and
830 cleanly create your own stylesheets to apply to RT. This option can
831 be overridden by users in their preferences.
835 Set($WebDefaultStylesheet, "freeside3");
837 =item C<$DefaultQueue>
839 Use this to select the default queue name that will be used for
840 creating new tickets. You may use either the queue's name or its
841 ID. This only affects the queue selection boxes on the web interface.
845 # Set($DefaultQueue, "General");
847 =item C<$RememberDefaultQueue>
849 When a queue is selected in the new ticket dropdown, make it the new
850 default for the new ticket dropdown.
854 # Set($RememberDefaultQueue, 1);
856 =item C<$EnableReminders>
858 Hide all links and portlets related to Reminders by setting this to 0
862 Set($EnableReminders, 1);
864 =item C<@CustomFieldValuesSources>
866 Set C<@CustomFieldValuesSources> to a list of class names which extend
867 L<RT::CustomFieldValues::External>. This can be used to pull lists of
868 custom field values from external sources at runtime.
872 Set(@CustomFieldValuesSources, ('RT::CustomFieldValues::Queues'));
874 =item C<$CanonicalizeRedirectURLs>
876 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
877 redirecting rather than the one we get from C<%ENV>.
879 Apache's UseCanonicalName directive changes the hostname that RT
880 finds in C<%ENV>. You can read more about what turning it On or Off
881 means in the documentation for your version of Apache.
883 If you use RT behind a reverse proxy, you almost certainly want to
888 Set($CanonicalizeRedirectURLs, 0);
892 A list of JavaScript files to be included in head. Removing any of
893 the default entries is not suggested.
895 If you're a plugin author, refer to RT->AddJavaScript.
902 jquery-ui-1.8.4.custom.min.js
903 jquery-ui-timepicker-addon.js
904 jquery-ui-patch-datepicker.js
908 jquery.event.hover-1.0.js
911 jquery.supposition.js
918 Path to the jsmin binary; if specified, it will be used to minify
919 C<JSFiles>. The default, and the fallback if the binary cannot be
920 found, is to simply concatenate the files.
922 jsmin can be installed by running 'make jsmin' from the RT install
923 directory, or from http://www.crockford.com/javascript/jsmin.html
927 # Set($JSMinPath, "/path/to/jsmin");
931 A list of additional CSS files to be included in head.
933 If you're a plugin author, refer to RT->AddStyleSheets.
937 Set(@CSSFiles, qw//);
939 =item C<$UsernameFormat>
941 This determines how user info is displayed. 'concise' will show one of
942 either NickName, RealName, Name or EmailAddress, depending on what
943 exists and whether the user is privileged or not. 'verbose' will show
944 RealName and EmailAddress.
948 Set($UsernameFormat, "verbose");
950 =item C<$WebBaseURL>, C<$WebURL>
952 Usually you don't want to set these options. The only obvious reason
953 is if RT is accessible via https protocol on a non standard port, e.g.
954 'https://rt.example.com:9999'. In all other cases these options are
955 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
957 C<$WebBaseURL> is the scheme, server and port
958 (e.g. 'http://rt.example.com') for constructing URLs to the web
959 UI. C<$WebBaseURL> doesn't need a trailing /.
961 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
962 example: 'http://www.example.com/rt/'.
966 my $port = RT->Config->Get('WebPort');
968 ($port == 443? 'https': 'http') .'://'
969 . RT->Config->Get('WebDomain')
970 . ($port != 80 && $port != 443? ":$port" : '')
973 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
975 =item C<$WebImagesURL>
977 C<$WebImagesURL> points to the base URL where RT can find its images.
978 Define the directory name to be used for images in RT web documents.
982 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
986 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
987 This can also be configured via the web UI.
991 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
993 =item C<$LogoLinkURL>
995 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
999 Set($LogoLinkURL, "http://bestpractical.com");
1001 =item C<$LogoAltText>
1003 C<$LogoAltText> is a string of text for the alt-text of the logo. It
1004 will be passed through C<loc> for localization.
1008 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1010 =item C<$LogoImageHeight>
1012 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1017 Set($LogoImageHeight, 38);
1019 =item C<$LogoImageWidth>
1021 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1026 Set($LogoImageWidth, 181);
1028 =item C<$WebNoAuthRegex>
1030 What portion of RT's URL space should not require authentication. The
1031 default is almost certainly correct, and should only be changed if you
1036 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1038 =item C<$SelfServiceRegex>
1040 What portion of RT's URLspace should be accessible to Unprivileged
1041 users This does not override the redirect from F</Ticket/Display.html>
1042 to F</SelfService/Display.html> when Unprivileged users attempt to
1043 access ticked displays.
1047 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1049 =item C<$WebFlushDbCacheEveryRequest>
1051 By default, RT clears its database cache after every page view. This
1052 ensures that you've always got the most current information when
1053 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1054 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1055 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1059 Set($WebFlushDbCacheEveryRequest, 1);
1063 The L<GD> module (which RT uses for graphs) ships with a built-in font
1064 that doesn't have full Unicode support. You can use a given TrueType
1065 font for a specific language by setting %ChartFont to (language =E<gt>
1066 the absolute path of a font) pairs. Your GD library must have support
1067 for TrueType fonts to use this option. If there is no entry for a
1068 language in the hash then font with 'others' key is used.
1070 RT comes with two TrueType fonts covering most available languages.
1076 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1077 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1078 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1079 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1082 =item C<$ChartsTimezonesInDB>
1084 RT stores dates using the UTC timezone in the DB, so charts grouped by
1085 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1086 to enable timezone conversions using your DB's capabilities. You may
1087 need to do some work on the DB side to use this feature, read more in
1088 F<docs/customizing/timezones_in_charts.pod>.
1090 At this time, this feature only applies to MySQL and PostgreSQL.
1094 Set($ChartsTimezonesInDB, 0);
1104 =item C<$DefaultSummaryRows>
1106 C<$DefaultSummaryRows> is default number of rows displayed in for
1107 search results on the front page.
1111 Set($DefaultSummaryRows, 10);
1113 =item C<$HomePageRefreshInterval>
1115 C<$HomePageRefreshInterval> is default number of seconds to refresh
1116 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1120 Set($HomePageRefreshInterval, 0);
1122 =item C<$HomepageComponents>
1124 C<$HomepageComponents> is an arrayref of allowed components on a
1125 user's customized homepage ("RT at a glance").
1129 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
1136 =head2 Ticket search
1140 =item C<$UseSQLForACLChecks>
1142 Historically, ACLs were checked on display, which could lead to empty
1143 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1144 to limit search results in SQL instead, which eliminates these
1147 This option is still relatively new; it may result in performance
1148 problems in some cases, or significant speedups in others.
1152 Set($UseSQLForACLChecks, undef);
1154 =item C<$TicketsItemMapSize>
1156 On the display page of a ticket from search results, RT provides links
1157 to the first, next, previous and last ticket from the results. In
1158 order to build these links, RT needs to fetch the full result set from
1159 the database, which can be resource-intensive.
1161 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1162 to build these links. If the full result set is larger than this
1163 number, RT will omit the "last" link in the menu. Set this to zero to
1164 always examine all results.
1168 Set($TicketsItemMapSize, 1000);
1170 =item C<$SearchResultsRefreshInterval>
1172 C<$SearchResultsRefreshInterval> is default number of seconds to
1173 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1178 Set($SearchResultsRefreshInterval, 0);
1180 =item C<$DefaultSearchResultFormat>
1182 C<$DefaultSearchResultFormat> is the default format for RT search
1187 Set ($DefaultSearchResultFormat, qq{
1188 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1189 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1197 '<small>__Requestors__</small>',
1198 '<small>__CustomerTags__</small>',
1199 '<small>__CreatedRelative__</small>',
1200 '<small>__ToldRelative__</small>',
1201 '<small>__LastUpdatedRelative__</small>',
1202 '<small>__TimeLeft__</small>'});
1204 =item C<$DefaultSelfServiceSearchResultFormat>
1206 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1207 searches displayed in the SelfService interface.
1211 Set($DefaultSelfServiceSearchResultFormat, qq{
1212 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1213 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1218 =item C<%FullTextSearch>
1220 Full text search (FTS) without database indexing is a very slow
1221 operation, and is thus disabled by default.
1223 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1224 the full details of FTS on your particular database.
1226 It is possible to enable FTS without database indexing support, simply
1227 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1228 This is not generally suggested, as unindexed full-text searching can
1229 cause severe performance problems.
1233 Set(%FullTextSearch,
1239 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1241 When query in simple search doesn't have status info, use this to only
1246 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1248 =item C<$SearchResultsAutoRedirect>
1250 When only one ticket is found in search, use this to redirect to the
1251 ticket display page automatically.
1255 Set($SearchResultsAutoRedirect, 0);
1261 =head2 Ticket display
1265 =item C<$ShowMoreAboutPrivilegedUsers>
1267 This determines if the 'More about requestor' box on
1268 Ticket/Display.html is shown for Privileged Users.
1272 Set($ShowMoreAboutPrivilegedUsers, 0);
1274 =item C<$MoreAboutRequestorTicketList>
1276 This can be set to Active, Inactive, All or None. It controls what
1277 ticket list will be displayed in the 'More about requestor' box on
1278 Ticket/Display.html. This option can be controlled by users also.
1282 Set($MoreAboutRequestorTicketList, "Active");
1284 =item C<$MoreAboutRequestorExtraInfo>
1286 By default, the 'More about requestor' box on Ticket/Display.html
1287 shows the Requestor's name and ticket list. If you would like to see
1288 extra information about the user, this expects a Format string of user
1289 attributes. Please note that not all the attributes are supported in
1290 this display because we're not building a table.
1293 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1297 Set($MoreAboutRequestorExtraInfo, "");
1299 =item C<$MoreAboutRequestorGroupsLimit>
1301 By default, the 'More about requestor' box on Ticket/Display.html
1302 shows all the groups of the Requestor. Use this to limit the number
1303 of groups; a value of undef removes the group display entirely.
1307 Set($MoreAboutRequestorGroupsLimit, 0);
1309 =item C<$UseSideBySideLayout>
1311 Should the ticket create and update forms use a more space efficient
1312 two column layout. This layout may not work in narrow browsers if you
1313 set a MessageBoxWidth (below).
1317 Set($UseSideBySideLayout, 1);
1319 =item C<$EditCustomFieldsSingleColumn>
1321 When displaying a list of Ticket Custom Fields for editing, RT
1322 defaults to a 2 column list. If you set this to 1, it will instead
1323 display the Custom Fields in a single column.
1327 Set($EditCustomFieldsSingleColumn, 0);
1329 =item C<$ShowUnreadMessageNotifications>
1331 If set to 1, RT will prompt users when there are new,
1332 unread messages on tickets they are viewing.
1336 Set($ShowUnreadMessageNotifications, 0);
1338 =item C<$AutocompleteOwners>
1340 If set to 1, the owner drop-downs for ticket update/modify and the query
1341 builder are replaced by text fields that autocomplete. This can
1342 alleviate the sometimes huge owner list for installations where many
1343 users have the OwnTicket right.
1347 Set($AutocompleteOwners, 0);
1349 =item C<$AutocompleteOwnersForSearch>
1351 If set to 1, the owner drop-downs for the query builder are always
1352 replaced by text field that autocomplete and C<$AutocompleteOwners>
1353 is ignored. Helpful when owners list is huge in the query builder.
1357 Set($AutocompleteOwnersForSearch, 0);
1359 =item C<$UserAutocompleteFields>
1361 Specifies which fields of L<RT::User> to match against and how to
1362 match each field when autocompleting users. Valid match methods are
1363 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1367 Set($UserAutocompleteFields, {
1368 EmailAddress => 'STARTSWITH',
1369 Name => 'STARTSWITH',
1373 =item C<$AllowUserAutocompleteForUnprivileged>
1375 Should unprivileged users be allowed to autocomplete users. Setting
1376 this option to 1 means unprivileged users will be able to search all
1381 Set($AllowUserAutocompleteForUnprivileged, 0);
1383 =item C<$DisplayTicketAfterQuickCreate>
1385 Enable this to redirect to the created ticket display page
1386 automatically when using QuickCreate.
1390 Set($DisplayTicketAfterQuickCreate, 0);
1392 =item C<$WikiImplicitLinks>
1394 Support implicit links in WikiText custom fields? Setting this to 1
1395 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1396 become links to searches for those words. If used on Articles, it links
1397 to the Article with that name.
1401 Set($WikiImplicitLinks, 0);
1403 =item C<$PreviewScripMessages>
1405 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1406 reply page should include the content of the messages to be sent.
1410 Set($PreviewScripMessages, 0);
1412 =item C<$SimplifiedRecipients>
1414 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1415 B<any> kind of mail will be shown on the ticket reply page, instead of a
1416 detailed breakdown by scrip.
1420 Set($SimplifiedRecipients, 0);
1422 =item C<$HideResolveActionsWithDependencies>
1424 If set to 1, this option will skip ticket menu actions which can't be
1425 completed successfully because of outstanding active Depends On tickets.
1427 By default, all ticket actions are displayed in the menu even if some of
1428 them can't be successful until all Depends On links are resolved or
1429 transitioned to another inactive status.
1433 Set($HideResolveActionsWithDependencies, 0);
1443 =item C<$ArticleOnTicketCreate>
1445 Set this to 1 to display the Articles interface on the Ticket Create
1446 page in addition to the Reply/Comment page.
1450 Set($ArticleOnTicketCreate, 0);
1452 =item C<$HideArticleSearchOnReplyCreate>
1454 Set this to 1 to hide the search and include boxes from the Article
1455 UI. This assumes you have enabled Article Hotlist feature, otherwise
1456 you will have no access to Articles.
1460 Set($HideArticleSearchOnReplyCreate, 0);
1466 =head2 Message box properties
1470 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1472 For message boxes, set the entry box width, height and what type of
1473 wrapping to use. These options can be overridden by users in their
1476 When the width is set to undef, no column count is specified and the
1477 message box will take up 100% of the available width. Combining this
1478 with HARD messagebox wrapping (below) is not recommended, as it will
1479 lead to inconsistent width in transactions between browsers.
1481 These settings only apply to the non-RichText message box. See below
1482 for Rich Text settings.
1486 Set($MessageBoxWidth, undef);
1487 Set($MessageBoxHeight, 15);
1489 =item C<$MessageBoxWrap>
1491 Wrapping is disabled when using MessageBoxRichText because of a bad
1492 interaction between IE and wrapping with the Rich Text Editor.
1496 Set($MessageBoxWrap, "SOFT");
1498 =item C<$MessageBoxRichText>
1500 Should "rich text" editing be enabled? This option lets your users
1501 send HTML email messages from the web interface.
1505 Set($MessageBoxRichText, 1);
1507 =item C<$MessageBoxRichTextHeight>
1509 Height of rich text JavaScript enabled editing boxes (in pixels)
1513 Set($MessageBoxRichTextHeight, 200);
1515 =item C<$MessageBoxIncludeSignature>
1517 Should your users' signatures (from their Preferences page) be
1518 included in Comments and Replies.
1522 Set($MessageBoxIncludeSignature, 1);
1524 =item C<$MessageBoxIncludeSignatureOnComment>
1526 Should your users' signatures (from their Preferences page) be
1527 included in Comments. Setting this to false overrides
1528 C<$MessageBoxIncludeSignature>.
1532 Set($MessageBoxIncludeSignatureOnComment, 1);
1537 =head2 Transaction display
1541 =item C<$OldestTransactionsFirst>
1543 By default, RT shows newest transactions at the bottom of the ticket
1544 history page, if you want see them at the top set this to 0. This
1545 option can be overridden by users in their preferences.
1549 Set($OldestTransactionsFirst, 1);
1551 =item C<$DeferTransactionLoading>
1553 When set, defers loading ticket history until the user clicks a link.
1554 This should end up serving pages to users quicker, since generating
1555 all the HTML for transaction history can be slow for long tickets.
1559 # Set($DeferTransactionLoading, 1);
1561 =item C<$ShowBccHeader>
1563 By default, RT hides from the web UI information about blind copies
1564 user sent on reply or comment.
1568 Set($ShowBccHeader, 0);
1570 =item C<$TrustHTMLAttachments>
1572 If C<TrustHTMLAttachments> is not defined, we will display them as
1573 text. This prevents malicious HTML and JavaScript from being sent in a
1574 request (although there is probably more to it than that)
1578 Set($TrustHTMLAttachments, undef);
1580 =item C<$AlwaysDownloadAttachments>
1582 Always download attachments, regardless of content type. If set, this
1583 overrides C<TrustHTMLAttachments>.
1587 Set($AlwaysDownloadAttachments, undef);
1589 =item C<$AttachmentUnits>
1591 Controls the units (kilobytes or bytes) that attachment sizes use for
1592 display. The default is to display kilobytes if the attachment is
1593 larger than 1024 bytes, bytes otherwise. If you set
1594 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1595 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1599 Set($AttachmentUnits, undef);
1601 =item C<$PreferRichText>
1603 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1604 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1605 show only a minimal subset of HTML to avoid possible contamination by
1606 cross-site-scripting attacks.
1610 Set($PreferRichText, undef);
1612 =item C<$MaxInlineBody>
1614 C<$MaxInlineBody> is the maximum attachment size that we want to see
1615 inline when viewing a transaction. RT will inline any text if the
1616 value is undefined or 0. This option can be overridden by users in
1621 Set($MaxInlineBody, 12000);
1623 =item C<$ShowTransactionImages>
1625 By default, RT shows images attached to incoming (and outgoing) ticket
1626 updates inline. Set this variable to 0 if you'd like to disable that
1631 Set($ShowTransactionImages, 1);
1633 =item C<$PlainTextPre>
1635 Normally plaintext attachments are displayed as HTML with line breaks
1636 preserved. This causes space- and tab-based formatting not to be
1637 displayed correctly. By setting $PlainTextPre messages will be
1638 displayed using <pre>.
1642 Set($PlainTextPre, 0);
1645 =item C<$PlainTextMono>
1647 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1648 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1649 of the browser window; this option overrides C<$PlainTextPre>.
1653 Set($PlainTextMono, 0);
1655 =item C<$SuppressInlineTextFiles>
1657 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1658 (text-type attachments with file names) are prevented from being
1659 displayed in-line when viewing a ticket's history.
1663 Set($SuppressInlineTextFiles, undef);
1666 =item C<@Active_MakeClicky>
1668 MakeClicky detects various formats of data in headers and email
1669 messages, and extends them with supporting links. By default, RT
1670 provides two formats:
1672 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1675 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1676 replaces the URL with a link.
1678 See F<share/html/Elements/MakeClicky> for documentation on how to add
1679 your own styles of link detection.
1683 Set(@Active_MakeClicky, qw());
1689 =head1 Application logic
1693 =item C<$ParseNewMessageForTicketCcs>
1695 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1696 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1697 messages. Be forewarned that if you have I<any> addresses which forward
1698 mail to RT automatically and you enable this option without modifying
1699 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1703 Set($ParseNewMessageForTicketCcs, undef);
1705 =item C<$UseTransactionBatch>
1707 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1708 such that a resolve and comment (for example) would happen
1709 simultaneously, instead of as two transactions, unaware of each
1714 Set($UseTransactionBatch, 1);
1716 =item C<$StrictLinkACL>
1718 When this feature is enabled a user needs I<ModifyTicket> rights on
1719 both tickets to link them together; otherwise, I<ModifyTicket> rights
1720 on either of them is sufficient.
1724 Set($StrictLinkACL, 1);
1726 =item C<$RedistributeAutoGeneratedMessages>
1728 Should RT redistribute correspondence that it identifies as machine
1729 generated? A 1 will do so; setting this to 0 will cause no
1730 such messages to be redistributed. You can also use 'privileged' (the
1731 default), which will redistribute only to privileged users. This helps
1732 to protect against malformed bounces and loops caused by auto-created
1733 requestors with bogus addresses.
1737 Set($RedistributeAutoGeneratedMessages, "privileged");
1739 =item C<$ApprovalRejectionNotes>
1741 Should rejection notes from approvals be sent to the requestors?
1745 Set($ApprovalRejectionNotes, 1);
1747 =item C<$ForceApprovalsView>
1749 Should approval tickets only be viewed and modified through the standard
1750 approval interface? Changing this setting to 1 will redirect any attempt to
1751 use the normal ticket display and modify page for approval tickets.
1753 For example, with this option set to 1 and an approval ticket #123:
1755 /Ticket/Display.html?id=123
1759 /Approval/Display.html?id=123
1765 Set($ForceApprovalsView, 0);
1767 =head1 Extra security
1771 This is a list of extra security measures to enable that help keep your RT
1772 safe. If you don't know what these mean, you should almost certainly leave the
1775 =item C<$DisallowExecuteCode>
1777 If set to a true value, the C<ExecuteCode> right will be removed from
1778 all users, B<including> the superuser. This is intended for when RT is
1779 installed into a shared environment where even the superuser should not
1780 be allowed to run arbitrary Perl code on the server via scrips.
1784 Set($DisallowExecuteCode, 0);
1786 =item C<$Framebusting>
1788 If set to a false value, framekiller javascript will be disabled and the
1789 X-Frame-Options: DENY header will be suppressed from all responses.
1790 This disables RT's clickjacking protection.
1794 Set($Framebusting, 1);
1796 =item C<$RestrictReferrer>
1798 If set to a false value, the HTTP C<Referer> (sic) header will not be
1799 checked to ensure that requests come from RT's own domain. As RT allows
1800 for GET requests to alter state, disabling this opens RT up to
1801 cross-site request forgery (CSRF) attacks.
1805 Set($RestrictReferrer, 1);
1807 =item C<$RestrictLoginReferrer>
1809 If set to a false value, RT will allow the user to log in from any link
1810 or request, merely by passing in C<user> and C<pass> parameters; setting
1811 it to a true value forces all logins to come from the login box, so the
1812 user is aware that they are being logged in. The default is off, for
1813 backwards compatability.
1817 Set($RestrictLoginReferrer, 0);
1819 =item C<$ReferrerWhitelist>
1821 This is a list of hostname:port combinations that RT will treat as being
1822 part of RT's domain. This is particularly useful if you access RT as
1823 multiple hostnames or have an external auth system that needs to
1824 redirect back to RT once authentication is complete.
1826 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1828 If the "RT has detected a possible cross-site request forgery" error is triggered
1829 by a host:port sent by your browser that you believe should be valid, you can copy
1830 the host:port from the error message into this list.
1832 Simple wildcards, similar to SSL certificates, are allowed. For example:
1834 *.example.com:80 # matches foo.example.com
1835 # but not example.com
1836 # or foo.bar.example.com
1838 www*.example.com:80 # matches www3.example.com
1839 # and www-test.example.com
1840 # and www.example.com
1844 Set(@ReferrerWhitelist, qw());
1850 =head1 Authorization and user configuration
1854 =item C<$WebExternalAuth>
1856 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1857 REMOTE_USER variable.
1861 Set($WebExternalAuth, undef);
1863 =item C<$WebExternalAuthContinuous>
1865 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1866 REMOTE_USER on each access. If you would prefer this to only happen
1867 once (at initial login) set this to a false value. The default
1868 setting will help ensure that if your external authentication system
1869 deauthenticates a user, RT notices as soon as possible.
1873 Set($WebExternalAuthContinuous, 1);
1875 =item C<$WebFallbackToInternalAuth>
1877 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1878 chance of fallback to the login screen, even if REMOTE_USER failed.
1882 Set($WebFallbackToInternalAuth, undef);
1884 =item C<$WebExternalGecos>
1886 C<$WebExternalGecos> means to match 'gecos' field as the user
1887 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1892 Set($WebExternalGecos, undef);
1894 =item C<$WebExternalAuto>
1896 C<$WebExternalAuto> will create users under the same name as
1897 REMOTE_USER upon login, if it's missing in the Users table.
1901 Set($WebExternalAuto, undef);
1903 =item C<$AutoCreate>
1905 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1906 User's Create method. Use it to set defaults, such as creating
1907 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1911 Set($AutoCreate, undef);
1913 =item C<$WebSessionClass>
1915 C<$WebSessionClass> is the class you wish to use for managing sessions.
1916 It defaults to use your SQL database, except on Oracle, where it
1917 defaults to files on disk.
1921 # Set($WebSessionClass, "Apache::Session::File");
1923 =item C<$AutoLogoff>
1925 By default, RT's user sessions persist until a user closes his or her
1926 browser. With the C<$AutoLogoff> option you can setup session lifetime
1927 in minutes. A user will be logged out if he or she doesn't send any
1928 requests to RT for the defined time.
1932 Set($AutoLogoff, 0);
1934 =item C<$LogoutRefresh>
1936 The number of seconds to wait after logout before sending the user to
1937 the login page. By default, 1 second, though you may want to increase
1938 this if you display additional information on the logout page.
1942 Set($LogoutRefresh, 1);
1944 =item C<$WebSecureCookies>
1946 By default, RT's session cookie isn't marked as "secure". Some web
1947 browsers will treat secure cookies more carefully than non-secure
1948 ones, being careful not to write them to disk, only sending them over
1949 an SSL secured connection, and so on. To enable this behavior, set
1950 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1951 on I<unless> users are only connecting via SSL encrypted HTTPS
1956 Set($WebSecureCookies, 0);
1958 =item C<$WebHttpOnlyCookies>
1960 Default RT's session cookie to not being directly accessible to
1961 javascript. The content is still sent during regular and AJAX requests,
1962 and other cookies are unaffected, but the session-id is less
1963 programmatically accessible to javascript. Turning this off should only
1964 be necessary in situations with odd client-side authentication
1969 Set($WebHttpOnlyCookies, 1);
1971 =item C<$MinimumPasswordLength>
1973 C<$MinimumPasswordLength> defines the minimum length for user
1974 passwords. Setting it to 0 disables this check.
1978 Set($MinimumPasswordLength, 5);
1983 =head1 Internationalization
1987 =item C<@LexiconLanguages>
1989 An array that contains languages supported by RT's
1990 internationalization interface. Defaults to all *.po lexicons;
1991 setting it to C<qw(en ja)> will make RT bilingual instead of
1992 multilingual, but will save some memory.
1996 Set(@LexiconLanguages, qw(*));
1998 =item C<@EmailInputEncodings>
2000 An array that contains default encodings used to guess which charset
2001 an attachment uses, if it does not specify one explicitly. All
2002 options must be recognized by L<Encode::Guess>. The first element may
2003 also be '*', which enables encoding detection using
2004 L<Encode::Detect::Detector>, if installed.
2008 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
2010 =item C<$EmailOutputEncoding>
2012 The charset for localized email. Must be recognized by Encode.
2016 Set($EmailOutputEncoding, "utf-8");
2026 =head1 Date and time handling
2030 =item C<$DateTimeFormat>
2032 You can choose date and time format. See the "Output formatters"
2033 section in perldoc F<lib/RT/Date.pm> for more options. This option
2034 can be overridden by users in their preferences.
2038 C<Set($DateTimeFormat, "LocalizedDateTime");>
2039 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2040 C<Set($DateTimeFormat, "RFC2822");>
2041 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2045 Set($DateTimeFormat, "DefaultFormat");
2047 # Next two options are for Time::ParseDate
2049 =item C<$DateDayBeforeMonth>
2051 Set this to 1 if your local date convention looks like "dd/mm/yy"
2052 instead of "mm/dd/yy". Used only for parsing, not for displaying
2057 Set($DateDayBeforeMonth, 1);
2059 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2061 Should an unspecified day or year in a date refer to a future or a
2062 past value? For example, should a date of "Tuesday" default to mean
2063 the date for next Tuesday or last Tuesday? Should the date "March 1"
2064 default to the date for next March or last March?
2066 Set C<$AmbiguousDayInPast> for the last date, or
2067 C<$AmbiguousDayInFuture> for the next date; the default is usually
2068 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2072 Set($AmbiguousDayInPast, 0);
2073 Set($AmbiguousDayInFuture, 0);
2075 =item C<$DefaultTimeUnitsToHours>
2077 Use this to set the default units for time entry to hours instead of
2078 minutes. Note that this only effects entry, not display.
2082 Set($DefaultTimeUnitsToHours, 0);
2084 =item C<$SimpleSearchIncludeResolved>
2086 By default, the simple ticket search in the top bar excludes "resolved" tickets
2087 unless a status argument is specified. Set this to a true value to include
2092 Set($SimpleSearchIncludeResolved, 0);
2099 =head1 GnuPG integration
2101 A full description of the (somewhat extensive) GnuPG integration can
2102 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2103 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2109 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2110 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2112 If you want to allow people to encrypt attachments inside the DB then
2113 set C<AllowEncryptDataInDB> to 1.
2115 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2116 emails encrypted for key RT doesn't have and can not decrypt.
2118 Set C<RejectOnBadData> to false if you don't want to reject letters
2119 with incorrect GnuPG data.
2125 OutgoingMessagesFormat => "RFC", # Inline
2126 AllowEncryptDataInDB => 0,
2128 RejectOnMissingPrivateKey => 1,
2129 RejectOnBadData => 1,
2132 =item C<%GnuPGOptions>
2134 Options to pass to the GnuPG program.
2136 If you override this in your RT_SiteConfig, you should be sure to
2137 include a homedir setting.
2139 Note that options with '-' character MUST be quoted.
2144 homedir => q{@RT_VAR_PATH@/data/gpg},
2146 # URL of a keyserver
2147 # keyserver => 'hkp://subkeys.pgp.net',
2149 # enables the automatic retrieving of keys when encrypting
2150 # 'auto-key-locate' => 'keyserver',
2152 # enables the automatic retrieving of keys when verifying signatures
2153 # 'auto-key-retrieve' => undef,
2162 =head2 Lifecycle definitions
2164 Each lifecycle is a list of possible statuses split into three logic
2165 sets: B<initial>, B<active> and B<inactive>. Each status in a
2166 lifecycle must be unique. (Statuses may not be repeated across sets.)
2167 Each set may have any number of statuses.
2173 active => ['open', 'stalled'],
2174 inactive => ['resolved', 'rejected', 'deleted'],
2178 Status names can be from 1 to 64 ASCII characters. Statuses are
2179 localized using RT's standard internationalization and localization
2186 You can define multiple B<initial> statuses for tickets in a given
2189 RT will automatically set its B<Started> date when you change a
2190 ticket's status from an B<initial> state to an B<active> or
2195 B<Active> tickets are "currently in play" - they're things that are
2196 being worked on and not yet complete.
2200 B<Inactive> tickets are typically in their "final resting state".
2202 While you're free to implement a workflow that ignores that
2203 description, typically once a ticket enters an inactive state, it will
2204 never again enter an active state.
2206 RT will automatically set the B<Resolved> date when a ticket's status
2207 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2210 B<deleted> is still a special status and protected by the
2211 B<DeleteTicket> right, unless you re-defined rights (read below). If
2212 you don't want to allow ticket deletion at any time simply don't
2213 include it in your lifecycle.
2217 Statuses in each set are ordered and listed in the UI in the defined
2220 Changes between statuses are constrained by transition rules, as
2223 =head2 Default values
2225 In some cases a default value is used to display in UI or in API when
2226 value is not provided. You can configure defaults using the following
2233 on_resolve => 'resolved',
2238 The following defaults are used.
2244 If you (or your code) doesn't specify a status when creating a ticket,
2245 RT will use the this status. See also L</Statuses available during
2250 When tickets are merged, the status of the ticket that was merged
2251 away is forced to this value. It should be one of inactive statuses;
2252 'resolved' or its equivalent is most probably the best candidate.
2256 When an approval is accepted, the status of depending tickets will
2257 be changed to this value.
2261 When an approval is denied, the status of depending tickets will
2262 be changed to this value.
2264 =item reminder_on_open
2266 When a reminder is opened, the status will be changed to this value.
2268 =item reminder_on_resolve
2270 When a reminder is resolved, the status will be changed to this value.
2274 =head2 Transitions between statuses and UI actions
2276 A B<Transition> is a change of status from A to B. You should define
2277 all possible transitions in each lifecycle using the following format:
2282 '' => [qw(new open resolved)],
2283 new => [qw(open resolved rejected deleted)],
2284 open => [qw(stalled resolved rejected deleted)],
2285 stalled => [qw(open)],
2286 resolved => [qw(open)],
2287 rejected => [qw(open)],
2288 deleted => [qw(open)],
2293 =head3 Statuses available during ticket creation
2295 By default users can create tickets with a status of new,
2296 open, or resolved, but cannot create tickets with a status of
2297 rejected, stalled, or deleted. If you want to change the statuses
2298 available during creation, update the transition from '' (empty
2299 string), like in the example above.
2301 =head3 Protecting status changes with rights
2303 A transition or group of transitions can be protected by a specific
2304 right. Additionally, you can name new right names, which will be added
2305 to the system to control that transition. For example, if you wished to
2306 create a lesser right than ModifyTicket for rejecting tickets, you could
2312 '* -> deleted' => 'DeleteTicket',
2313 '* -> rejected' => 'RejectTicket',
2314 '* -> *' => 'ModifyTicket',
2319 This would create a new C<RejectTicket> right in the system which you
2320 could assign to whatever groups you choose.
2322 On the left hand side you can have the following variants:
2329 Valid transitions are listed in order of priority. If a user attempts
2330 to change a ticket's status from B<new> to B<open> then the lifecycle
2331 is checked for presence of an exact match, then for 'any to B<open>',
2332 'B<new> to any' and finally 'any to any'.
2334 If you don't define any rights, or there is no match for a transition,
2335 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2337 =head3 Labeling and defining actions
2339 For each transition you can define an action that will be shown in the
2340 UI; each action annotated with a label and an update type.
2342 Each action may provide a default update type, which can be
2343 B<Comment>, B<Respond>, or absent. For example, you may want your
2344 staff to write a reply to the end user when they change status from
2345 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2346 B<Comment> nor B<Respond> are mandatory, and user may leave the
2347 message empty, regardless of the update type.
2349 This configuration can be used to accomplish what
2350 $ResolveDefaultUpdateType was used for in RT 3.8.
2352 Use the following format to define labels and actions of transitions:
2357 'new -> open' => { label => 'Open it', update => 'Respond' },
2358 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2359 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2360 'new -> deleted' => { label => 'Delete' },
2362 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2363 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2364 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2366 'stalled -> open' => { label => 'Open it' },
2367 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2368 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2369 'deleted -> open' => { label => 'Undelete' },
2374 In addition, you may define multiple actions for the same transition.
2375 Alternately, you may use '* -> x' to match more than one transition.
2382 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2383 'new -> rejected' => { label => 'Quick Reject' },
2385 '* -> deleted' => { label => 'Delete' },
2391 =head2 Moving tickets between queues with different lifecycles
2393 Unless there is an explicit mapping between statuses in two different
2394 lifecycles, you can not move tickets between queues with these
2395 lifecycles. This is true even if the different lifecycles use the exact
2396 same set of statuses. Such a mapping is defined as follows:
2399 'from lifecycle -> to lifecycle' => {
2400 'status in left lifecycle' => 'status in right lifecycle',
2410 initial => [ 'new' ],
2411 active => [ 'open', 'stalled' ],
2412 inactive => [ 'resolved', 'rejected', 'deleted' ],
2416 on_merge => 'resolved',
2418 denied => 'rejected',
2419 reminder_on_open => 'open',
2420 reminder_on_resolve => 'resolved',
2424 '' => [qw(new open resolved)],
2426 # from => [ to list ],
2427 new => [qw(open stalled resolved rejected deleted)],
2428 open => [qw(new stalled resolved rejected deleted)],
2429 stalled => [qw(new open rejected resolved deleted)],
2430 resolved => [qw(new open stalled rejected deleted)],
2431 rejected => [qw(new open stalled resolved deleted)],
2432 deleted => [qw(new open stalled rejected resolved)],
2435 '* -> deleted' => 'DeleteTicket',
2436 '* -> *' => 'ModifyTicket',
2440 label => 'Open It', # loc
2441 update => 'Respond',
2443 'new -> resolved' => {
2444 label => 'Resolve', # loc
2445 update => 'Comment',
2447 'new -> rejected' => {
2448 label => 'Reject', # loc
2449 update => 'Respond',
2451 'new -> deleted' => {
2452 label => 'Delete', # loc
2455 'open -> stalled' => {
2456 label => 'Stall', # loc
2457 update => 'Comment',
2459 'open -> resolved' => {
2460 label => 'Resolve', # loc
2461 update => 'Comment',
2463 'open -> rejected' => {
2464 label => 'Reject', # loc
2465 update => 'Respond',
2468 'stalled -> open' => {
2469 label => 'Open It', # loc
2471 'resolved -> open' => {
2472 label => 'Re-open', # loc
2473 update => 'Comment',
2475 'rejected -> open' => {
2476 label => 'Re-open', # loc
2477 update => 'Comment',
2479 'deleted -> open' => {
2480 label => 'Undelete', # loc
2484 # don't change lifecyle of the approvals, they are not capable to deal with
2487 initial => [ 'new' ],
2488 active => [ 'open', 'stalled' ],
2489 inactive => [ 'resolved', 'rejected', 'deleted' ],
2493 on_merge => 'resolved',
2494 reminder_on_open => 'open',
2495 reminder_on_resolve => 'resolved',
2499 '' => [qw(new open resolved)],
2501 # from => [ to list ],
2502 new => [qw(open stalled resolved rejected deleted)],
2503 open => [qw(new stalled resolved rejected deleted)],
2504 stalled => [qw(new open rejected resolved deleted)],
2505 resolved => [qw(new open stalled rejected deleted)],
2506 rejected => [qw(new open stalled resolved deleted)],
2507 deleted => [qw(new open stalled rejected resolved)],
2510 '* -> deleted' => 'DeleteTicket',
2511 '* -> rejected' => 'ModifyTicket',
2512 '* -> *' => 'ModifyTicket',
2516 label => 'Open It', # loc
2517 update => 'Respond',
2519 'new -> resolved' => {
2520 label => 'Resolve', # loc
2521 update => 'Comment',
2523 'new -> rejected' => {
2524 label => 'Reject', # loc
2525 update => 'Respond',
2527 'new -> deleted' => {
2528 label => 'Delete', # loc
2531 'open -> stalled' => {
2532 label => 'Stall', # loc
2533 update => 'Comment',
2535 'open -> resolved' => {
2536 label => 'Resolve', # loc
2537 update => 'Comment',
2539 'open -> rejected' => {
2540 label => 'Reject', # loc
2541 update => 'Respond',
2544 'stalled -> open' => {
2545 label => 'Open It', # loc
2547 'resolved -> open' => {
2548 label => 'Re-open', # loc
2549 update => 'Comment',
2551 'rejected -> open' => {
2552 label => 'Re-open', # loc
2553 update => 'Comment',
2555 'deleted -> open' => {
2556 label => 'Undelete', # loc
2566 =head1 Administrative interface
2570 =item C<$ShowRTPortal>
2572 RT can show administrators a feed of recent RT releases and other
2573 related announcements and information from Best Practical on the top
2574 level Configuration page. This feature helps you stay up to date on
2575 RT security announcements and version updates.
2577 RT provides this feature using an "iframe" on C</Admin/index.html>
2578 which asks the administrator's browser to show an inline page from
2579 Best Practical's website.
2581 If you'd rather not make this feature available to your
2582 administrators, set C<$ShowRTPortal> to a false value.
2586 Set($ShowRTPortal, 1);
2588 =item C<%AdminSearchResultFormat>
2590 In the admin interface, format strings similar to tickets result
2591 formats are used. Use C<%AdminSearchResultFormat> to define the format
2592 strings used in the admin interface on a per-RT-class basis.
2596 Set(%AdminSearchResultFormat,
2598 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2599 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2600 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,'__Disabled__,__Lifecycle__},
2603 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2604 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2605 .q{,'__Description__'},
2608 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2609 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2610 .q{,__RealName__, __EmailAddress__},
2613 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2614 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2615 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2618 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2619 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2620 .q{,__Stage__, __Condition__, __Action__, __Template__},
2623 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2624 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2625 .q{,__Stage__, __Condition__, __Action__, __Template__},
2628 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2629 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2630 .q{,'__Description__'},
2632 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2633 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2634 .q{,__Description__},
2642 =head1 Development options
2648 RT comes with a "Development mode" setting. This setting, as a
2649 convenience for developers, turns on several of development options
2650 that you most likely don't want in production:
2656 Disables CSS and JS minification and concatenation. Both CSS and JS
2657 will be instead be served as a number of individual smaller files,
2658 unchanged from how they are stored on disk.
2662 Uses L<Module::Refresh> to reload changed Perl modules on each
2667 Turns off Mason's C<static_source> directive; this causes Mason to
2668 reload template files which have been modified on disk.
2672 Turns on Mason's HTML C<error_format>; this renders compilation errors
2673 to the browser, along with a full stack trace. It is possible for
2674 stack traces to reveal sensitive information such as passwords or
2679 Turns off caching of callbacks; this enables additional callbacks to
2680 be added while the server is running.
2686 Set($DevelMode, "@RT_DEVEL_MODE@");
2689 =item C<$RecordBaseClass>
2691 What abstract base class should RT use for its records. You should
2692 probably never change this.
2694 Valid values are C<DBIx::SearchBuilder::Record> or
2695 C<DBIx::SearchBuilder::Record::Cachable>
2699 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2702 =item C<@MasonParameters>
2704 C<@MasonParameters> is the list of parameters for the constructor of
2705 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2706 debugging, e.g. profiling individual components with:
2708 use MasonX::Profiler; # available on CPAN
2709 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2713 Set(@MasonParameters, ());
2715 =item C<$StatementLog>
2717 RT has rudimentary SQL statement logging support; simply set
2718 C<$StatementLog> to be the level that you wish SQL statements to be
2721 Enabling this option will also expose the SQL Queries page in the
2722 Configuration -> Tools menu for SuperUsers.
2726 Set($StatementLog, undef);
2733 =head1 Deprecated options
2737 =item C<$LinkTransactionsRun1Scrip>
2739 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2740 one transaction and run one scrip. Set this value to 1 if you want
2741 only one of the link transactions to have scrips run.
2745 Set($LinkTransactionsRun1Scrip, 0);
2747 =item C<$ResolveDefaultUpdateType>
2749 This option has been deprecated. You can configure this site-wide
2750 with L</Lifecycles> (see L</Labeling and defining actions>).