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");
513 =item C<$SetOutgoingMailFrom>
515 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
516 Correspond mail address of the ticket's queue.
518 Warning: If you use this setting, bounced mails will appear to be
519 incoming mail to the system, thus creating new tickets.
523 Set($SetOutgoingMailFrom, 0);
525 =item C<$OverrideOutgoingMailFrom>
527 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
528 address of the queue as it is handed to sendmail -f. This helps force
529 the From_ header away from www-data or other email addresses that show
530 up in the "Sent by" line in Outlook.
532 The option is a hash reference of queue name to email address. If
533 there is no ticket involved, then the value of the C<Default> key will
536 This option is irrelevant unless C<$SetOutgoingMailFrom> is set.
540 Set($OverrideOutgoingMailFrom, {
541 # 'Default' => 'admin@rt.example.com',
542 # 'General' => 'general@rt.example.com',
545 =item C<$DefaultMailPrecedence>
547 C<$DefaultMailPrecedence> is used to control the default Precedence
548 level of outgoing mail where none is specified. By default it is
549 C<bulk>, but if you only send mail to your staff, you may wish to
552 Note that you can set the precedence of individual templates by
553 including an explicit Precedence header.
555 If you set this value to C<undef> then we do not set a default
556 Precedence header to outgoing mail. However, if there already is a
557 Precedence header, it will be preserved.
561 Set($DefaultMailPrecedence, "bulk");
563 =item C<$DefaultErrorMailPrecedence>
565 C<$DefaultErrorMailPrecedence> is used to control the default
566 Precedence level of outgoing mail that indicates some kind of error
567 condition. By default it is C<bulk>, but if you only send mail to your
568 staff, you may wish to change it.
570 If you set this value to C<undef> then we do not add a Precedence
571 header to error mail.
575 Set($DefaultErrorMailPrecedence, "bulk");
577 =item C<$UseOriginatorHeader>
579 C<$UseOriginatorHeader> is used to control the insertion of an
580 RT-Originator Header in every outgoing mail, containing the mail
581 address of the transaction creator.
585 Set($UseOriginatorHeader, 1);
587 =item C<$UseFriendlyFromLine>
589 By default, RT sets the outgoing mail's "From:" header to "SenderName
590 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
594 Set($UseFriendlyFromLine, 1);
596 =item C<$FriendlyFromLineFormat>
598 C<sprintf()> format of the friendly 'From:' header; its arguments are
599 SenderName and SenderEmailAddress.
603 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
605 =item C<$UseFriendlyToLine>
607 RT can optionally set a "Friendly" 'To:' header when sending messages
608 to Ccs or AdminCcs (rather than having a blank 'To:' header.
610 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
611 are using sendmail, rather than postfix, qmail, exim or some other
612 MTA, you _must_ disable this option.
616 Set($UseFriendlyToLine, 0);
618 =item C<$FriendlyToLineFormat>
620 C<sprintf()> format of the friendly 'To:' header; its arguments are
621 WatcherType and TicketId.
625 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
627 =item C<$NotifyActor>
629 By default, RT doesn't notify the person who performs an update, as
630 they already know what they've done. If you'd like to change this
631 behavior, Set C<$NotifyActor> to 1
635 Set($NotifyActor, 0);
637 =item C<$RecordOutgoingEmail>
639 By default, RT records each message it sends out to its own internal
640 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
644 Set($RecordOutgoingEmail, 1);
646 =item C<$VERPPrefix>, C<$VERPDomain>
648 Setting these options enables VERP support
649 L<http://cr.yp.to/proto/verp.txt>.
651 Uncomment the following two directives to generate envelope senders
652 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
653 (i.e. rt-jesse=fsck.com@rt.example.com ).
655 This currently only works with sendmail and sendmailpipe.
659 # Set($VERPPrefix, "rt-");
660 # Set($VERPDomain, $RT::Organization);
663 =item C<$ForwardFromUser>
665 By default, RT forwards a message using queue's address and adds RT's
666 tag into subject of the outgoing message, so recipients' replies go
667 into RT as correspondents.
669 To change this behavior, set C<$ForwardFromUser> to 1 and RT
670 will use the address of the current user and remove RT's subject tag.
674 Set($ForwardFromUser, 0);
678 =head2 Email dashboards
682 =item C<$DashboardAddress>
684 The email address from which RT will send dashboards. If none is set,
685 then C<$OwnerEmail> will be used.
689 Set($DashboardAddress, '');
691 =item C<$DashboardSubject>
693 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
694 Weekly, Monthly) of the dashboard and the dashboard's name.
698 Set($DashboardSubject, "%s Dashboard: %s");
700 =item C<@EmailDashboardRemove>
702 A list of regular expressions that will be used to remove content from
707 Set(@EmailDashboardRemove, ());
713 =head2 Sendmail configuration
715 These options only take effect if C<$MailCommand> is 'sendmail' or
720 =item C<$SendmailArguments>
722 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
723 If you picked 'sendmailpipe', you MUST add a -t flag to
724 C<$SendmailArguments> These options are good for most sendmail
725 wrappers and work-a-likes.
727 These arguments are good for sendmail brand sendmail 8 and newer:
728 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
732 Set($SendmailArguments, "-oi -t");
735 =item C<$SendmailBounceArguments>
737 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
738 assuming RT needs to send an error (i.e. bounce).
742 Set($SendmailBounceArguments, '-f "<>"');
744 =item C<$SendmailPath>
746 If you selected 'sendmailpipe' above, you MUST specify the path to
747 your sendmail binary in C<$SendmailPath>.
751 Set($SendmailPath, "/usr/sbin/sendmail");
756 =head2 SMTP configuration
758 These options only take effect if C<$MailCommand> is 'smtp'
764 C<$SMTPServer> should be set to the hostname of the SMTP server to use
768 Set($SMTPServer, undef);
772 C<$SMTPFrom> should be set to the 'From' address to use, if not the
777 Set($SMTPFrom, undef);
781 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
795 C<@MailParams> defines a list of options passed to $MailCommand if it
796 is not 'sendmailpipe', 'sendmail', or 'smtp'
800 Set(@MailParams, ());
809 =item C<$WebDefaultStylesheet>
811 This determines the default stylesheet the RT web interface will use.
812 RT ships with several themes by default:
814 web2 The default layout for RT 3.8
815 aileron The default layout for RT 4.0
816 ballard Theme which doesn't rely on JavaScript for menuing
818 This bundled distibution of RT also includes:
819 freeside3 Integration with Freeside (enabled by default)
820 freeside2.1 Previous Freeside theme
822 This value actually specifies a directory in F<share/html/NoAuth/css/>
823 from which RT will try to load the file main.css (which should @import
824 any other files the stylesheet needs). This allows you to easily and
825 cleanly create your own stylesheets to apply to RT. This option can
826 be overridden by users in their preferences.
830 Set($WebDefaultStylesheet, "freeside3");
832 =item C<$DefaultQueue>
834 Use this to select the default queue name that will be used for
835 creating new tickets. You may use either the queue's name or its
836 ID. This only affects the queue selection boxes on the web interface.
840 # Set($DefaultQueue, "General");
842 =item C<$RememberDefaultQueue>
844 When a queue is selected in the new ticket dropdown, make it the new
845 default for the new ticket dropdown.
849 # Set($RememberDefaultQueue, 1);
851 =item C<$EnableReminders>
853 Hide all links and portlets related to Reminders by setting this to 0
857 Set($EnableReminders, 1);
859 =item C<@CustomFieldValuesSources>
861 Set C<@CustomFieldValuesSources> to a list of class names which extend
862 L<RT::CustomFieldValues::External>. This can be used to pull lists of
863 custom field values from external sources at runtime.
867 Set(@CustomFieldValuesSources, ('RT::CustomFieldValues::Queues'));
869 =item C<$CanonicalizeRedirectURLs>
871 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
872 redirecting rather than the one we get from C<%ENV>.
874 Apache's UseCanonicalName directive changes the hostname that RT
875 finds in C<%ENV>. You can read more about what turning it On or Off
876 means in the documentation for your version of Apache.
878 If you use RT behind a reverse proxy, you almost certainly want to
883 Set($CanonicalizeRedirectURLs, 0);
887 A list of JavaScript files to be included in head. Removing any of
888 the default entries is not suggested.
890 If you're a plugin author, refer to RT->AddJavaScript.
897 jquery-ui-1.8.4.custom.min.js
898 jquery-ui-patch-datepicker.js
903 jquery.event.hover-1.0.js
906 jquery.supposition.js
913 Path to the jsmin binary; if specified, it will be used to minify
914 C<JSFiles>. The default, and the fallback if the binary cannot be
915 found, is to simply concatenate the files.
917 jsmin can be installed by running 'make jsmin' from the RT install
918 directory, or from http://www.crockford.com/javascript/jsmin.html
922 # Set($JSMinPath, "/path/to/jsmin");
926 A list of additional CSS files to be included in head.
928 If you're a plugin author, refer to RT->AddStyleSheets.
932 Set(@CSSFiles, qw//);
934 =item C<$UsernameFormat>
936 This determines how user info is displayed. 'concise' will show one of
937 either NickName, RealName, Name or EmailAddress, depending on what
938 exists and whether the user is privileged or not. 'verbose' will show
939 RealName and EmailAddress.
943 Set($UsernameFormat, "verbose");
945 =item C<$WebBaseURL>, C<$WebURL>
947 Usually you don't want to set these options. The only obvious reason
948 is if RT is accessible via https protocol on a non standard port, e.g.
949 'https://rt.example.com:9999'. In all other cases these options are
950 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
952 C<$WebBaseURL> is the scheme, server and port
953 (e.g. 'http://rt.example.com') for constructing URLs to the web
954 UI. C<$WebBaseURL> doesn't need a trailing /.
956 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
957 example: 'http://www.example.com/rt/'.
961 my $port = RT->Config->Get('WebPort');
963 ($port == 443? 'https': 'http') .'://'
964 . RT->Config->Get('WebDomain')
965 . ($port != 80 && $port != 443? ":$port" : '')
968 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
970 =item C<$WebImagesURL>
972 C<$WebImagesURL> points to the base URL where RT can find its images.
973 Define the directory name to be used for images in RT web documents.
977 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
981 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
982 This can also be configured via the web UI.
986 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
988 =item C<$LogoLinkURL>
990 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
994 Set($LogoLinkURL, "http://bestpractical.com");
996 =item C<$LogoAltText>
998 C<$LogoAltText> is a string of text for the alt-text of the logo. It
999 will be passed through C<loc> for localization.
1003 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1005 =item C<$LogoImageHeight>
1007 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1012 Set($LogoImageHeight, 38);
1014 =item C<$LogoImageWidth>
1016 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1021 Set($LogoImageWidth, 181);
1023 =item C<$WebNoAuthRegex>
1025 What portion of RT's URL space should not require authentication. The
1026 default is almost certainly correct, and should only be changed if you
1031 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1033 =item C<$SelfServiceRegex>
1035 What portion of RT's URLspace should be accessible to Unprivileged
1036 users This does not override the redirect from F</Ticket/Display.html>
1037 to F</SelfService/Display.html> when Unprivileged users attempt to
1038 access ticked displays.
1042 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1044 =item C<$WebFlushDbCacheEveryRequest>
1046 By default, RT clears its database cache after every page view. This
1047 ensures that you've always got the most current information when
1048 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1049 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1050 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1054 Set($WebFlushDbCacheEveryRequest, 1);
1058 The L<GD> module (which RT uses for graphs) ships with a built-in font
1059 that doesn't have full Unicode support. You can use a given TrueType
1060 font for a specific language by setting %ChartFont to (language =E<gt>
1061 the absolute path of a font) pairs. Your GD library must have support
1062 for TrueType fonts to use this option. If there is no entry for a
1063 language in the hash then font with 'others' key is used.
1065 RT comes with two TrueType fonts covering most available languages.
1071 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1072 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1073 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1074 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1077 =item C<$ChartsTimezonesInDB>
1079 RT stores dates using the UTC timezone in the DB, so charts grouped by
1080 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1081 to enable timezone conversions using your DB's capabilities. You may
1082 need to do some work on the DB side to use this feature, read more in
1083 F<docs/customizing/timezones_in_charts.pod>.
1085 At this time, this feature only applies to MySQL and PostgreSQL.
1089 Set($ChartsTimezonesInDB, 0);
1099 =item C<$DefaultSummaryRows>
1101 C<$DefaultSummaryRows> is default number of rows displayed in for
1102 search results on the front page.
1106 Set($DefaultSummaryRows, 10);
1108 =item C<$HomePageRefreshInterval>
1110 C<$HomePageRefreshInterval> is default number of seconds to refresh
1111 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1115 Set($HomePageRefreshInterval, 0);
1117 =item C<$HomepageComponents>
1119 C<$HomepageComponents> is an arrayref of allowed components on a
1120 user's customized homepage ("RT at a glance").
1124 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
1131 =head2 Ticket search
1135 =item C<$UseSQLForACLChecks>
1137 Historically, ACLs were checked on display, which could lead to empty
1138 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1139 to limit search results in SQL instead, which eliminates these
1142 This option is still relatively new; it may result in performance
1143 problems in some cases, or significant speedups in others.
1147 Set($UseSQLForACLChecks, undef);
1149 =item C<$TicketsItemMapSize>
1151 On the display page of a ticket from search results, RT provides links
1152 to the first, next, previous and last ticket from the results. In
1153 order to build these links, RT needs to fetch the full result set from
1154 the database, which can be resource-intensive.
1156 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1157 to build these links. If the full result set is larger than this
1158 number, RT will omit the "last" link in the menu. Set this to zero to
1159 always examine all results.
1163 Set($TicketsItemMapSize, 1000);
1165 =item C<$SearchResultsRefreshInterval>
1167 C<$SearchResultsRefreshInterval> is default number of seconds to
1168 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1173 Set($SearchResultsRefreshInterval, 0);
1175 =item C<$DefaultSearchResultFormat>
1177 C<$DefaultSearchResultFormat> is the default format for RT search
1182 Set ($DefaultSearchResultFormat, qq{
1183 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1184 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1192 '<small>__Requestors__</small>',
1193 '<small>__CustomerTags__</small>',
1194 '<small>__CreatedRelative__</small>',
1195 '<small>__ToldRelative__</small>',
1196 '<small>__LastUpdatedRelative__</small>',
1197 '<small>__TimeLeft__</small>'});
1199 =item C<$DefaultSelfServiceSearchResultFormat>
1201 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1202 searches displayed in the SelfService interface.
1206 Set($DefaultSelfServiceSearchResultFormat, qq{
1207 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1208 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1213 =item C<%FullTextSearch>
1215 Full text search (FTS) without database indexing is a very slow
1216 operation, and is thus disabled by default.
1218 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1219 the full details of FTS on your particular database.
1221 It is possible to enable FTS without database indexing support, simply
1222 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1223 This is not generally suggested, as unindexed full-text searching can
1224 cause severe performance problems.
1228 Set(%FullTextSearch,
1234 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1236 When query in simple search doesn't have status info, use this to only
1241 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1243 =item C<$SearchResultsAutoRedirect>
1245 When only one ticket is found in search, use this to redirect to the
1246 ticket display page automatically.
1250 Set($SearchResultsAutoRedirect, 0);
1256 =head2 Ticket display
1260 =item C<$ShowMoreAboutPrivilegedUsers>
1262 This determines if the 'More about requestor' box on
1263 Ticket/Display.html is shown for Privileged Users.
1267 Set($ShowMoreAboutPrivilegedUsers, 0);
1269 =item C<$MoreAboutRequestorTicketList>
1271 This can be set to Active, Inactive, All or None. It controls what
1272 ticket list will be displayed in the 'More about requestor' box on
1273 Ticket/Display.html. This option can be controlled by users also.
1277 Set($MoreAboutRequestorTicketList, "Active");
1279 =item C<$MoreAboutRequestorExtraInfo>
1281 By default, the 'More about requestor' box on Ticket/Display.html
1282 shows the Requestor's name and ticket list. If you would like to see
1283 extra information about the user, this expects a Format string of user
1284 attributes. Please note that not all the attributes are supported in
1285 this display because we're not building a table.
1288 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1292 Set($MoreAboutRequestorExtraInfo, "");
1294 =item C<$MoreAboutRequestorGroupsLimit>
1296 By default, the 'More about requestor' box on Ticket/Display.html
1297 shows all the groups of the Requestor. Use this to limit the number
1298 of groups; a value of undef removes the group display entirely.
1302 Set($MoreAboutRequestorGroupsLimit, 0);
1304 =item C<$UseSideBySideLayout>
1306 Should the ticket create and update forms use a more space efficient
1307 two column layout. This layout may not work in narrow browsers if you
1308 set a MessageBoxWidth (below).
1312 Set($UseSideBySideLayout, 1);
1314 =item C<$EditCustomFieldsSingleColumn>
1316 When displaying a list of Ticket Custom Fields for editing, RT
1317 defaults to a 2 column list. If you set this to 1, it will instead
1318 display the Custom Fields in a single column.
1322 Set($EditCustomFieldsSingleColumn, 0);
1324 =item C<$ShowUnreadMessageNotifications>
1326 If set to 1, RT will prompt users when there are new,
1327 unread messages on tickets they are viewing.
1331 Set($ShowUnreadMessageNotifications, 0);
1333 =item C<$AutocompleteOwners>
1335 If set to 1, the owner drop-downs for ticket update/modify and the query
1336 builder are replaced by text fields that autocomplete. This can
1337 alleviate the sometimes huge owner list for installations where many
1338 users have the OwnTicket right.
1342 Set($AutocompleteOwners, 0);
1344 =item C<$AutocompleteOwnersForSearch>
1346 If set to 1, the owner drop-downs for the query builder are always
1347 replaced by text field that autocomplete and C<$AutocompleteOwners>
1348 is ignored. Helpful when owners list is huge in the query builder.
1352 Set($AutocompleteOwnersForSearch, 0);
1354 =item C<$UserAutocompleteFields>
1356 Specifies which fields of L<RT::User> to match against and how to
1357 match each field when autocompleting users. Valid match methods are
1358 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1362 Set($UserAutocompleteFields, {
1363 EmailAddress => 'STARTSWITH',
1364 Name => 'STARTSWITH',
1368 =item C<$AllowUserAutocompleteForUnprivileged>
1370 Should unprivileged users be allowed to autocomplete users. Setting
1371 this option to 1 means unprivileged users will be able to search all
1376 Set($AllowUserAutocompleteForUnprivileged, 0);
1378 =item C<$DisplayTicketAfterQuickCreate>
1380 Enable this to redirect to the created ticket display page
1381 automatically when using QuickCreate.
1385 Set($DisplayTicketAfterQuickCreate, 0);
1387 =item C<$WikiImplicitLinks>
1389 Support implicit links in WikiText custom fields? Setting this to 1
1390 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1391 become links to searches for those words. If used on Articles, it links
1392 to the Article with that name.
1396 Set($WikiImplicitLinks, 0);
1398 =item C<$PreviewScripMessages>
1400 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1401 reply page should include the content of the messages to be sent.
1405 Set($PreviewScripMessages, 0);
1407 =item C<$SimplifiedRecipients>
1409 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1410 B<any> kind of mail will be shown on the ticket reply page, instead of a
1411 detailed breakdown by scrip.
1415 Set($SimplifiedRecipients, 0);
1417 =item C<$HideResolveActionsWithDependencies>
1419 If set to 1, this option will skip ticket menu actions which can't be
1420 completed successfully because of outstanding active Depends On tickets.
1422 By default, all ticket actions are displayed in the menu even if some of
1423 them can't be successful until all Depends On links are resolved or
1424 transitioned to another inactive status.
1428 Set($HideResolveActionsWithDependencies, 0);
1438 =item C<$ArticleOnTicketCreate>
1440 Set this to 1 to display the Articles interface on the Ticket Create
1441 page in addition to the Reply/Comment page.
1445 Set($ArticleOnTicketCreate, 0);
1447 =item C<$HideArticleSearchOnReplyCreate>
1449 Set this to 1 to hide the search and include boxes from the Article
1450 UI. This assumes you have enabled Article Hotlist feature, otherwise
1451 you will have no access to Articles.
1455 Set($HideArticleSearchOnReplyCreate, 0);
1461 =head2 Message box properties
1465 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1467 For message boxes, set the entry box width, height and what type of
1468 wrapping to use. These options can be overridden by users in their
1471 When the width is set to undef, no column count is specified and the
1472 message box will take up 100% of the available width. Combining this
1473 with HARD messagebox wrapping (below) is not recommended, as it will
1474 lead to inconsistent width in transactions between browsers.
1476 These settings only apply to the non-RichText message box. See below
1477 for Rich Text settings.
1481 Set($MessageBoxWidth, undef);
1482 Set($MessageBoxHeight, 15);
1484 =item C<$MessageBoxWrap>
1486 Wrapping is disabled when using MessageBoxRichText because of a bad
1487 interaction between IE and wrapping with the Rich Text Editor.
1491 Set($MessageBoxWrap, "SOFT");
1493 =item C<$MessageBoxRichText>
1495 Should "rich text" editing be enabled? This option lets your users
1496 send HTML email messages from the web interface.
1500 Set($MessageBoxRichText, 1);
1502 =item C<$MessageBoxRichTextHeight>
1504 Height of rich text JavaScript enabled editing boxes (in pixels)
1508 Set($MessageBoxRichTextHeight, 200);
1510 =item C<$MessageBoxIncludeSignature>
1512 Should your users' signatures (from their Preferences page) be
1513 included in Comments and Replies.
1517 Set($MessageBoxIncludeSignature, 1);
1519 =item C<$MessageBoxIncludeSignatureOnComment>
1521 Should your users' signatures (from their Preferences page) be
1522 included in Comments. Setting this to false overrides
1523 C<$MessageBoxIncludeSignature>.
1527 Set($MessageBoxIncludeSignatureOnComment, 1);
1532 =head2 Transaction display
1536 =item C<$OldestTransactionsFirst>
1538 By default, RT shows newest transactions at the bottom of the ticket
1539 history page, if you want see them at the top set this to 0. This
1540 option can be overridden by users in their preferences.
1544 Set($OldestTransactionsFirst, 1);
1546 =item C<$DeferTransactionLoading>
1548 When set, defers loading ticket history until the user clicks a link.
1549 This should end up serving pages to users quicker, since generating
1550 all the HTML for transaction history can be slow for long tickets.
1554 # Set($DeferTransactionLoading, 1);
1556 =item C<$ShowBccHeader>
1558 By default, RT hides from the web UI information about blind copies
1559 user sent on reply or comment.
1563 Set($ShowBccHeader, 0);
1565 =item C<$TrustHTMLAttachments>
1567 If C<TrustHTMLAttachments> is not defined, we will display them as
1568 text. This prevents malicious HTML and JavaScript from being sent in a
1569 request (although there is probably more to it than that)
1573 Set($TrustHTMLAttachments, undef);
1575 =item C<$AlwaysDownloadAttachments>
1577 Always download attachments, regardless of content type. If set, this
1578 overrides C<TrustHTMLAttachments>.
1582 Set($AlwaysDownloadAttachments, undef);
1584 =item C<$AttachmentUnits>
1586 Controls the units (kilobytes or bytes) that attachment sizes use for
1587 display. The default is to display kilobytes if the attachment is
1588 larger than 1024 bytes, bytes otherwise. If you set
1589 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1590 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1594 Set($AttachmentUnits, undef);
1596 =item C<$PreferRichText>
1598 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1599 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1600 show only a minimal subset of HTML to avoid possible contamination by
1601 cross-site-scripting attacks.
1605 Set($PreferRichText, undef);
1607 =item C<$MaxInlineBody>
1609 C<$MaxInlineBody> is the maximum attachment size that we want to see
1610 inline when viewing a transaction. RT will inline any text if the
1611 value is undefined or 0. This option can be overridden by users in
1616 Set($MaxInlineBody, 12000);
1618 =item C<$ShowTransactionImages>
1620 By default, RT shows images attached to incoming (and outgoing) ticket
1621 updates inline. Set this variable to 0 if you'd like to disable that
1626 Set($ShowTransactionImages, 1);
1628 =item C<$PlainTextPre>
1630 Normally plaintext attachments are displayed as HTML with line breaks
1631 preserved. This causes space- and tab-based formatting not to be
1632 displayed correctly. By setting $PlainTextPre messages will be
1633 displayed using <pre>.
1637 Set($PlainTextPre, 0);
1640 =item C<$PlainTextMono>
1642 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1643 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1644 of the browser window; this option overrides C<$PlainTextPre>.
1648 Set($PlainTextMono, 0);
1650 =item C<$SuppressInlineTextFiles>
1652 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1653 (text-type attachments with file names) are prevented from being
1654 displayed in-line when viewing a ticket's history.
1658 Set($SuppressInlineTextFiles, undef);
1661 =item C<@Active_MakeClicky>
1663 MakeClicky detects various formats of data in headers and email
1664 messages, and extends them with supporting links. By default, RT
1665 provides two formats:
1667 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1670 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1671 replaces the URL with a link.
1673 See F<share/html/Elements/MakeClicky> for documentation on how to add
1674 your own styles of link detection.
1678 Set(@Active_MakeClicky, qw());
1684 =head1 Application logic
1688 =item C<$ParseNewMessageForTicketCcs>
1690 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1691 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1692 messages. Be forewarned that if you have I<any> addresses which forward
1693 mail to RT automatically and you enable this option without modifying
1694 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1698 Set($ParseNewMessageForTicketCcs, undef);
1700 =item C<$UseTransactionBatch>
1702 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1703 such that a resolve and comment (for example) would happen
1704 simultaneously, instead of as two transactions, unaware of each
1709 Set($UseTransactionBatch, 1);
1711 =item C<$StrictLinkACL>
1713 When this feature is enabled a user needs I<ModifyTicket> rights on
1714 both tickets to link them together; otherwise, I<ModifyTicket> rights
1715 on either of them is sufficient.
1719 Set($StrictLinkACL, 1);
1721 =item C<$RedistributeAutoGeneratedMessages>
1723 Should RT redistribute correspondence that it identifies as machine
1724 generated? A 1 will do so; setting this to 0 will cause no
1725 such messages to be redistributed. You can also use 'privileged' (the
1726 default), which will redistribute only to privileged users. This helps
1727 to protect against malformed bounces and loops caused by auto-created
1728 requestors with bogus addresses.
1732 Set($RedistributeAutoGeneratedMessages, "privileged");
1734 =item C<$ApprovalRejectionNotes>
1736 Should rejection notes from approvals be sent to the requestors?
1740 Set($ApprovalRejectionNotes, 1);
1742 =item C<$ForceApprovalsView>
1744 Should approval tickets only be viewed and modified through the standard
1745 approval interface? Changing this setting to 1 will redirect any attempt to
1746 use the normal ticket display and modify page for approval tickets.
1748 For example, with this option set to 1 and an approval ticket #123:
1750 /Ticket/Display.html?id=123
1754 /Approval/Display.html?id=123
1760 Set($ForceApprovalsView, 0);
1762 =head1 Extra security
1766 This is a list of extra security measures to enable that help keep your RT
1767 safe. If you don't know what these mean, you should almost certainly leave the
1770 =item C<$DisallowExecuteCode>
1772 If set to a true value, the C<ExecuteCode> right will be removed from
1773 all users, B<including> the superuser. This is intended for when RT is
1774 installed into a shared environment where even the superuser should not
1775 be allowed to run arbitrary Perl code on the server via scrips.
1779 Set($DisallowExecuteCode, 0);
1781 =item C<$Framebusting>
1783 If set to a false value, framekiller javascript will be disabled and the
1784 X-Frame-Options: DENY header will be suppressed from all responses.
1785 This disables RT's clickjacking protection.
1789 Set($Framebusting, 1);
1791 =item C<$RestrictReferrer>
1793 If set to a false value, the HTTP C<Referer> (sic) header will not be
1794 checked to ensure that requests come from RT's own domain. As RT allows
1795 for GET requests to alter state, disabling this opens RT up to
1796 cross-site request forgery (CSRF) attacks.
1800 Set($RestrictReferrer, 1);
1802 =item C<$RestrictLoginReferrer>
1804 If set to a false value, RT will allow the user to log in from any link
1805 or request, merely by passing in C<user> and C<pass> parameters; setting
1806 it to a true value forces all logins to come from the login box, so the
1807 user is aware that they are being logged in. The default is off, for
1808 backwards compatability.
1812 Set($RestrictLoginReferrer, 0);
1814 =item C<$ReferrerWhitelist>
1816 This is a list of hostname:port combinations that RT will treat as being
1817 part of RT's domain. This is particularly useful if you access RT as
1818 multiple hostnames or have an external auth system that needs to
1819 redirect back to RT once authentication is complete.
1821 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1823 If the "RT has detected a possible cross-site request forgery" error is triggered
1824 by a host:port sent by your browser that you believe should be valid, you can copy
1825 the host:port from the error message into this list.
1829 Set(@ReferrerWhitelist, qw());
1835 =head1 Authorization and user configuration
1839 =item C<$WebExternalAuth>
1841 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1842 REMOTE_USER variable.
1846 Set($WebExternalAuth, undef);
1848 =item C<$WebExternalAuthContinuous>
1850 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1851 REMOTE_USER on each access. If you would prefer this to only happen
1852 once (at initial login) set this to a false value. The default
1853 setting will help ensure that if your external authentication system
1854 deauthenticates a user, RT notices as soon as possible.
1858 Set($WebExternalAuthContinuous, 1);
1860 =item C<$WebFallbackToInternalAuth>
1862 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1863 chance of fallback to the login screen, even if REMOTE_USER failed.
1867 Set($WebFallbackToInternalAuth, undef);
1869 =item C<$WebExternalGecos>
1871 C<$WebExternalGecos> means to match 'gecos' field as the user
1872 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1877 Set($WebExternalGecos, undef);
1879 =item C<$WebExternalAuto>
1881 C<$WebExternalAuto> will create users under the same name as
1882 REMOTE_USER upon login, if it's missing in the Users table.
1886 Set($WebExternalAuto, undef);
1888 =item C<$AutoCreate>
1890 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1891 User's Create method. Use it to set defaults, such as creating
1892 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1896 Set($AutoCreate, undef);
1898 =item C<$WebSessionClass>
1900 C<$WebSessionClass> is the class you wish to use for managing sessions.
1901 It defaults to use your SQL database, except on Oracle, where it
1902 defaults to files on disk.
1906 # Set($WebSessionClass, "Apache::Session::File");
1908 =item C<$AutoLogoff>
1910 By default, RT's user sessions persist until a user closes his or her
1911 browser. With the C<$AutoLogoff> option you can setup session lifetime
1912 in minutes. A user will be logged out if he or she doesn't send any
1913 requests to RT for the defined time.
1917 Set($AutoLogoff, 0);
1919 =item C<$LogoutRefresh>
1921 The number of seconds to wait after logout before sending the user to
1922 the login page. By default, 1 second, though you may want to increase
1923 this if you display additional information on the logout page.
1927 Set($LogoutRefresh, 1);
1929 =item C<$WebSecureCookies>
1931 By default, RT's session cookie isn't marked as "secure". Some web
1932 browsers will treat secure cookies more carefully than non-secure
1933 ones, being careful not to write them to disk, only sending them over
1934 an SSL secured connection, and so on. To enable this behavior, set
1935 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1936 on I<unless> users are only connecting via SSL encrypted HTTPS
1941 Set($WebSecureCookies, 0);
1943 =item C<$WebHttpOnlyCookies>
1945 Default RT's session cookie to not being directly accessible to
1946 javascript. The content is still sent during regular and AJAX requests,
1947 and other cookies are unaffected, but the session-id is less
1948 programmatically accessible to javascript. Turning this off should only
1949 be necessary in situations with odd client-side authentication
1954 Set($WebHttpOnlyCookies, 1);
1956 =item C<$MinimumPasswordLength>
1958 C<$MinimumPasswordLength> defines the minimum length for user
1959 passwords. Setting it to 0 disables this check.
1963 Set($MinimumPasswordLength, 5);
1968 =head1 Internationalization
1972 =item C<@LexiconLanguages>
1974 An array that contains languages supported by RT's
1975 internationalization interface. Defaults to all *.po lexicons;
1976 setting it to C<qw(en ja)> will make RT bilingual instead of
1977 multilingual, but will save some memory.
1981 Set(@LexiconLanguages, qw(*));
1983 =item C<@EmailInputEncodings>
1985 An array that contains default encodings used to guess which charset
1986 an attachment uses, if it does not specify one explicitly. All
1987 options must be recognized by L<Encode::Guess>. The first element may
1988 also be '*', which enables encoding detection using
1989 L<Encode::Detect::Detector>, if installed.
1993 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1995 =item C<$EmailOutputEncoding>
1997 The charset for localized email. Must be recognized by Encode.
2001 Set($EmailOutputEncoding, "utf-8");
2011 =head1 Date and time handling
2015 =item C<$DateTimeFormat>
2017 You can choose date and time format. See the "Output formatters"
2018 section in perldoc F<lib/RT/Date.pm> for more options. This option
2019 can be overridden by users in their preferences.
2023 C<Set($DateTimeFormat, "LocalizedDateTime");>
2024 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2025 C<Set($DateTimeFormat, "RFC2822");>
2026 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2030 Set($DateTimeFormat, "DefaultFormat");
2032 # Next two options are for Time::ParseDate
2034 =item C<$DateDayBeforeMonth>
2036 Set this to 1 if your local date convention looks like "dd/mm/yy"
2037 instead of "mm/dd/yy". Used only for parsing, not for displaying
2042 Set($DateDayBeforeMonth, 1);
2044 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2046 Should an unspecified day or year in a date refer to a future or a
2047 past value? For example, should a date of "Tuesday" default to mean
2048 the date for next Tuesday or last Tuesday? Should the date "March 1"
2049 default to the date for next March or last March?
2051 Set C<$AmbiguousDayInPast> for the last date, or
2052 C<$AmbiguousDayInFuture> for the next date; the default is usually
2053 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2057 Set($AmbiguousDayInPast, 0);
2058 Set($AmbiguousDayInFuture, 0);
2060 =item C<$DefaultTimeUnitsToHours>
2062 Use this to set the default units for time entry to hours instead of
2063 minutes. Note that this only effects entry, not display.
2067 Set($DefaultTimeUnitsToHours, 0);
2069 =item C<$SimpleSearchIncludeResolved>
2071 By default, the simple ticket search in the top bar excludes "resolved" tickets
2072 unless a status argument is specified. Set this to a true value to include
2077 Set($SimpleSearchIncludeResolved, 0);
2084 =head1 GnuPG integration
2086 A full description of the (somewhat extensive) GnuPG integration can
2087 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2088 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2094 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2095 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2097 If you want to allow people to encrypt attachments inside the DB then
2098 set C<AllowEncryptDataInDB> to 1.
2100 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2101 emails encrypted for key RT doesn't have and can not decrypt.
2103 Set C<RejectOnBadData> to false if you don't want to reject letters
2104 with incorrect GnuPG data.
2110 OutgoingMessagesFormat => "RFC", # Inline
2111 AllowEncryptDataInDB => 0,
2113 RejectOnMissingPrivateKey => 1,
2114 RejectOnBadData => 1,
2117 =item C<%GnuPGOptions>
2119 Options to pass to the GnuPG program.
2121 If you override this in your RT_SiteConfig, you should be sure to
2122 include a homedir setting.
2124 Note that options with '-' character MUST be quoted.
2129 homedir => q{@RT_VAR_PATH@/data/gpg},
2131 # URL of a keyserver
2132 # keyserver => 'hkp://subkeys.pgp.net',
2134 # enables the automatic retrieving of keys when encrypting
2135 # 'auto-key-locate' => 'keyserver',
2137 # enables the automatic retrieving of keys when verifying signatures
2138 # 'auto-key-retrieve' => undef,
2147 =head2 Lifecycle definitions
2149 Each lifecycle is a list of possible statuses split into three logic
2150 sets: B<initial>, B<active> and B<inactive>. Each status in a
2151 lifecycle must be unique. (Statuses may not be repeated across sets.)
2152 Each set may have any number of statuses.
2158 active => ['open', 'stalled'],
2159 inactive => ['resolved', 'rejected', 'deleted'],
2163 Status names can be from 1 to 64 ASCII characters. Statuses are
2164 localized using RT's standard internationalization and localization
2171 You can define multiple B<initial> statuses for tickets in a given
2174 RT will automatically set its B<Started> date when you change a
2175 ticket's status from an B<initial> state to an B<active> or
2180 B<Active> tickets are "currently in play" - they're things that are
2181 being worked on and not yet complete.
2185 B<Inactive> tickets are typically in their "final resting state".
2187 While you're free to implement a workflow that ignores that
2188 description, typically once a ticket enters an inactive state, it will
2189 never again enter an active state.
2191 RT will automatically set the B<Resolved> date when a ticket's status
2192 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2195 B<deleted> is still a special status and protected by the
2196 B<DeleteTicket> right, unless you re-defined rights (read below). If
2197 you don't want to allow ticket deletion at any time simply don't
2198 include it in your lifecycle.
2202 Statuses in each set are ordered and listed in the UI in the defined
2205 Changes between statuses are constrained by transition rules, as
2208 =head2 Default values
2210 In some cases a default value is used to display in UI or in API when
2211 value is not provided. You can configure defaults using the following
2218 on_resolve => 'resolved',
2223 The following defaults are used.
2229 If you (or your code) doesn't specify a status when creating a ticket,
2230 RT will use the this status. See also L</Statuses available during
2235 When tickets are merged, the status of the ticket that was merged
2236 away is forced to this value. It should be one of inactive statuses;
2237 'resolved' or its equivalent is most probably the best candidate.
2241 When an approval is accepted, the status of depending tickets will
2242 be changed to this value.
2246 When an approval is denied, the status of depending tickets will
2247 be changed to this value.
2249 =item reminder_on_open
2251 When a reminder is opened, the status will be changed to this value.
2253 =item reminder_on_resolve
2255 When a reminder is resolved, the status will be changed to this value.
2259 =head2 Transitions between statuses and UI actions
2261 A B<Transition> is a change of status from A to B. You should define
2262 all possible transitions in each lifecycle using the following format:
2267 '' => [qw(new open resolved)],
2268 new => [qw(open resolved rejected deleted)],
2269 open => [qw(stalled resolved rejected deleted)],
2270 stalled => [qw(open)],
2271 resolved => [qw(open)],
2272 rejected => [qw(open)],
2273 deleted => [qw(open)],
2278 =head3 Statuses available during ticket creation
2280 By default users can create tickets with any status, except
2281 deleted. If you want to restrict statuses available during creation
2282 then describe transition from '' (empty string), like in the example
2285 =head3 Protecting status changes with rights
2287 A transition or group of transitions can be protected by a specific
2288 right. Additionally, you can name new right names, which will be added
2289 to the system to control that transition. For example, if you wished to
2290 create a lesser right than ModifyTicket for rejecting tickets, you could
2296 '* -> deleted' => 'DeleteTicket',
2297 '* -> rejected' => 'RejectTicket',
2298 '* -> *' => 'ModifyTicket',
2303 This would create a new C<RejectTicket> right in the system which you
2304 could assign to whatever groups you choose.
2306 On the left hand side you can have the following variants:
2313 Valid transitions are listed in order of priority. If a user attempts
2314 to change a ticket's status from B<new> to B<open> then the lifecycle
2315 is checked for presence of an exact match, then for 'any to B<open>',
2316 'B<new> to any' and finally 'any to any'.
2318 If you don't define any rights, or there is no match for a transition,
2319 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2321 =head3 Labeling and defining actions
2323 For each transition you can define an action that will be shown in the
2324 UI; each action annotated with a label and an update type.
2326 Each action may provide a default update type, which can be
2327 B<Comment>, B<Respond>, or absent. For example, you may want your
2328 staff to write a reply to the end user when they change status from
2329 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2330 B<Comment> nor B<Respond> are mandatory, and user may leave the
2331 message empty, regardless of the update type.
2333 This configuration can be used to accomplish what
2334 $ResolveDefaultUpdateType was used for in RT 3.8.
2336 Use the following format to define labels and actions of transitions:
2341 'new -> open' => { label => 'Open it', update => 'Respond' },
2342 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2343 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2344 'new -> deleted' => { label => 'Delete' },
2346 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2347 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2348 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2350 'stalled -> open' => { label => 'Open it' },
2351 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2352 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2353 'deleted -> open' => { label => 'Undelete' },
2358 In addition, you may define multiple actions for the same transition.
2359 Alternately, you may use '* -> x' to match more than one transition.
2366 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2367 'new -> rejected' => { label => 'Quick Reject' },
2369 '* -> deleted' => { label => 'Delete' },
2375 =head2 Moving tickets between queues with different lifecycles
2377 Unless there is an explicit mapping between statuses in two different
2378 lifecycles, you can not move tickets between queues with these
2379 lifecycles. This is true even if the different lifecycles use the exact
2380 same set of statuses. Such a mapping is defined as follows:
2383 'from lifecycle -> to lifecycle' => {
2384 'status in left lifecycle' => 'status in right lifecycle',
2394 initial => [ 'new' ],
2395 active => [ 'open', 'stalled' ],
2396 inactive => [ 'resolved', 'rejected', 'deleted' ],
2400 on_merge => 'resolved',
2402 denied => 'rejected',
2403 reminder_on_open => 'open',
2404 reminder_on_resolve => 'resolved',
2408 '' => [qw(new open resolved)],
2410 # from => [ to list ],
2411 new => [qw(open stalled resolved rejected deleted)],
2412 open => [qw(new stalled resolved rejected deleted)],
2413 stalled => [qw(new open rejected resolved deleted)],
2414 resolved => [qw(new open stalled rejected deleted)],
2415 rejected => [qw(new open stalled resolved deleted)],
2416 deleted => [qw(new open stalled rejected resolved)],
2419 '* -> deleted' => 'DeleteTicket',
2420 '* -> *' => 'ModifyTicket',
2424 label => 'Open It', # loc
2425 update => 'Respond',
2427 'new -> resolved' => {
2428 label => 'Resolve', # loc
2429 update => 'Comment',
2431 'new -> rejected' => {
2432 label => 'Reject', # loc
2433 update => 'Respond',
2435 'new -> deleted' => {
2436 label => 'Delete', # loc
2439 'open -> stalled' => {
2440 label => 'Stall', # loc
2441 update => 'Comment',
2443 'open -> resolved' => {
2444 label => 'Resolve', # loc
2445 update => 'Comment',
2447 'open -> rejected' => {
2448 label => 'Reject', # loc
2449 update => 'Respond',
2452 'stalled -> open' => {
2453 label => 'Open It', # loc
2455 'resolved -> open' => {
2456 label => 'Re-open', # loc
2457 update => 'Comment',
2459 'rejected -> open' => {
2460 label => 'Re-open', # loc
2461 update => 'Comment',
2463 'deleted -> open' => {
2464 label => 'Undelete', # loc
2468 # don't change lifecyle of the approvals, they are not capable to deal with
2471 initial => [ 'new' ],
2472 active => [ 'open', 'stalled' ],
2473 inactive => [ 'resolved', 'rejected', 'deleted' ],
2477 on_merge => 'resolved',
2478 reminder_on_open => 'open',
2479 reminder_on_resolve => 'resolved',
2483 '' => [qw(new open resolved)],
2485 # from => [ to list ],
2486 new => [qw(open stalled resolved rejected deleted)],
2487 open => [qw(new stalled resolved rejected deleted)],
2488 stalled => [qw(new open rejected resolved deleted)],
2489 resolved => [qw(new open stalled rejected deleted)],
2490 rejected => [qw(new open stalled resolved deleted)],
2491 deleted => [qw(new open stalled rejected resolved)],
2494 '* -> deleted' => 'DeleteTicket',
2495 '* -> rejected' => 'ModifyTicket',
2496 '* -> *' => 'ModifyTicket',
2500 label => 'Open It', # loc
2501 update => 'Respond',
2503 'new -> resolved' => {
2504 label => 'Resolve', # loc
2505 update => 'Comment',
2507 'new -> rejected' => {
2508 label => 'Reject', # loc
2509 update => 'Respond',
2511 'new -> deleted' => {
2512 label => 'Delete', # loc
2515 'open -> stalled' => {
2516 label => 'Stall', # loc
2517 update => 'Comment',
2519 'open -> resolved' => {
2520 label => 'Resolve', # loc
2521 update => 'Comment',
2523 'open -> rejected' => {
2524 label => 'Reject', # loc
2525 update => 'Respond',
2528 'stalled -> open' => {
2529 label => 'Open It', # loc
2531 'resolved -> open' => {
2532 label => 'Re-open', # loc
2533 update => 'Comment',
2535 'rejected -> open' => {
2536 label => 'Re-open', # loc
2537 update => 'Comment',
2539 'deleted -> open' => {
2540 label => 'Undelete', # loc
2550 =head1 Administrative interface
2554 =item C<$ShowRTPortal>
2556 RT can show administrators a feed of recent RT releases and other
2557 related announcements and information from Best Practical on the top
2558 level Configuration page. This feature helps you stay up to date on
2559 RT security announcements and version updates.
2561 RT provides this feature using an "iframe" on C</Admin/index.html>
2562 which asks the administrator's browser to show an inline page from
2563 Best Practical's website.
2565 If you'd rather not make this feature available to your
2566 administrators, set C<$ShowRTPortal> to a false value.
2570 Set($ShowRTPortal, 1);
2572 =item C<%AdminSearchResultFormat>
2574 In the admin interface, format strings similar to tickets result
2575 formats are used. Use C<%AdminSearchResultFormat> to define the format
2576 strings used in the admin interface on a per-RT-class basis.
2580 Set(%AdminSearchResultFormat,
2582 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2583 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2584 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,'__Disabled__,__Lifecycle__},
2587 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2588 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2589 .q{,'__Description__'},
2592 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2593 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2594 .q{,__RealName__, __EmailAddress__},
2597 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2598 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2599 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2602 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2603 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2604 .q{,__Stage__, __Condition__, __Action__, __Template__},
2607 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2608 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2609 .q{,__Stage__, __Condition__, __Action__, __Template__},
2612 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2613 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2614 .q{,'__Description__'},
2616 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2617 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2618 .q{,__Description__},
2626 =head1 Development options
2632 RT comes with a "Development mode" setting. This setting, as a
2633 convenience for developers, turns on several of development options
2634 that you most likely don't want in production:
2640 Disables CSS and JS minification and concatenation. Both CSS and JS
2641 will be instead be served as a number of individual smaller files,
2642 unchanged from how they are stored on disk.
2646 Uses L<Module::Refresh> to reload changed Perl modules on each
2651 Turns off Mason's C<static_source> directive; this causes Mason to
2652 reload template files which have been modified on disk.
2656 Turns on Mason's HTML C<error_format>; this renders compilation errors
2657 to the browser, along with a full stack trace. It is possible for
2658 stack traces to reveal sensitive information such as passwords or
2663 Turns off caching of callbacks; this enables additional callbacks to
2664 be added while the server is running.
2670 Set($DevelMode, "@RT_DEVEL_MODE@");
2673 =item C<$RecordBaseClass>
2675 What abstract base class should RT use for its records. You should
2676 probably never change this.
2678 Valid values are C<DBIx::SearchBuilder::Record> or
2679 C<DBIx::SearchBuilder::Record::Cachable>
2683 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2686 =item C<@MasonParameters>
2688 C<@MasonParameters> is the list of parameters for the constructor of
2689 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2690 debugging, e.g. profiling individual components with:
2692 use MasonX::Profiler; # available on CPAN
2693 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2697 Set(@MasonParameters, ());
2699 =item C<$StatementLog>
2701 RT has rudimentary SQL statement logging support; simply set
2702 C<$StatementLog> to be the level that you wish SQL statements to be
2705 Enabling this option will also expose the SQL Queries page in the
2706 Configuration -> Tools menu for SuperUsers.
2710 Set($StatementLog, undef);
2717 =head1 Deprecated options
2721 =item C<$LinkTransactionsRun1Scrip>
2723 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2724 one transaction and run one scrip. Set this value to 1 if you want
2725 only one of the link transactions to have scrips run.
2729 Set($LinkTransactionsRun1Scrip, 0);
2731 =item C<$ResolveDefaultUpdateType>
2733 This option has been deprecated. You can configure this site-wide
2734 with L</Lifecycles> (see L</Labeling and defining actions>).