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. This setting is irrelevant unless one of
352 $TruncateLongAttachments or $DropLongAttachments (below) are set.
356 Set($MaxAttachmentSize, 10_000_000);
358 =item C<$TruncateLongAttachments>
360 If this is set to a non-undef value, RT will truncate attachments
361 longer than C<$MaxAttachmentSize>.
365 Set($TruncateLongAttachments, undef);
367 =item C<$DropLongAttachments>
369 If this is set to a non-undef value, RT will silently drop attachments
370 longer than C<MaxAttachmentSize>. C<$TruncateLongAttachments>, above,
371 takes priority over this.
375 Set($DropLongAttachments, undef);
377 =item C<$RTAddressRegexp>
379 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a
380 ticket CC if C<$ParseNewMessageForTicketCcs>, above, is enabled. It
381 is important that you set this to a regular expression that matches
382 all addresses used by your RT. This lets RT avoid sending mail to
383 itself. It will also hide RT addresses from the list of "One-time Cc"
384 and Bcc lists on ticket reply.
386 If you have a number of addresses configured in your RT database
387 already, you can generate a naive first pass regexp by using:
389 perl etc/upgrade/generate-rtaddressregexp
391 If left blank, RT will generate a regexp for you, based on your
392 comment and correspond address settings on your queues; this comes at
393 a small cost in start-up speed.
397 Set($RTAddressRegexp, undef);
399 =item C<$IgnoreCcRegexp>
401 C<$IgnoreCcRegexp> is a regexp to exclude addresses from automatic addition
402 to the Cc list. Use this for addresses that are I<not> received by RT but
403 are sometimes added to Cc lists by mistake. Unlike C<$RTAddressRegexp>,
404 these addresses can still receive email from RT otherwise.
408 Set($IgnoreCcRegexp, undef);
410 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
412 RT provides functionality which allows the system to rewrite incoming
413 email addresses. In its simplest form, you can substitute the value
414 in C<CanonicalizeEmailAddressReplace> for the value in
415 C<CanonicalizeEmailAddressMatch> (These values are passed to the
416 C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>)
418 By default, that routine performs a C<s/$Match/$Replace/gi> on any
419 address passed to it.
423 # Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$');
424 # Set($CanonicalizeEmailAddressReplace, '@example.com');
426 =item C<$CanonicalizeOnCreate>
428 Set this to 1 and the create new user page will use the values that
429 you enter in the form but use the function CanonicalizeUserInfo in
434 Set($CanonicalizeOnCreate, 0);
436 =item C<$ValidateUserEmailAddresses>
438 If C<$ValidateUserEmailAddresses> is 1, RT will refuse to create
439 users with an invalid email address (as specified in RFC 2822) or with
440 an email address made of multiple email addresses.
444 Set($ValidateUserEmailAddresses, undef);
446 =item C<$NonCustomerEmailRegexp>
448 Normally, when a ticket is linked to a customer, any requestors on that
449 ticket that didn't previously have customer memberships are linked to
450 the customer also. C<$NonCustomerEmailRegexp> is a regexp for email
451 addresses that should I<not> automatically be linked to a customer in
456 Set($NonCustomerEmailRegexp, undef);
458 =item C<@MailPlugins>
460 C<@MailPlugins> is a list of authentication plugins for
461 L<RT::Interface::Email> to use; see L<rt-mailgate>
465 =item C<$UnsafeEmailCommands>
467 C<$UnsafeEmailCommands>, if set to 1, enables 'take' and 'resolve'
468 as possible actions via the mail gateway. As its name implies, this
469 is very unsafe, as it allows email with a forged sender to possibly
470 resolve arbitrary tickets!
474 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
476 The default "extract remote tracking tags" scrip settings; these
477 detect when your RT is talking to another RT, and adjust the subject
482 Set($ExtractSubjectTagMatch, qr/\[.+? #\d+\]/);
483 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
484 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
485 : qr/\[\Q$RT::rtname\E #\d+\]/));
495 =item C<$MailCommand>
497 C<$MailCommand> defines which method RT will use to try to send mail.
498 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
499 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
502 Note that you should remove the '-t' from C<$SendmailArguments> if you
503 use 'sendmail' rather than 'sendmailpipe'
505 For testing purposes, or to simply disable sending mail out into the
506 world, you can set C<$MailCommand> to 'testfile' which writes all mail
507 to a temporary file. RT will log the location of the temporary file
508 so you can extract mail from it afterward.
512 #Set($MailCommand, "sendmailpipe");
513 Set($MailCommand, "sendmail");
515 =item C<$SetOutgoingMailFrom>
517 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
518 Correspond mail address of the ticket's queue.
520 Warning: If you use this setting, bounced mails will appear to be
521 incoming mail to the system, thus creating new tickets.
525 Set($SetOutgoingMailFrom, 0);
527 =item C<$OverrideOutgoingMailFrom>
529 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
530 address of the queue as it is handed to sendmail -f. This helps force
531 the From_ header away from www-data or other email addresses that show
532 up in the "Sent by" line in Outlook.
534 The option is a hash reference of queue name to email address. If
535 there is no ticket involved, then the value of the C<Default> key will
538 This option is irrelevant unless C<$SetOutgoingMailFrom> is set.
542 Set($OverrideOutgoingMailFrom, {
543 # 'Default' => 'admin@rt.example.com',
544 # 'General' => 'general@rt.example.com',
547 =item C<$DefaultMailPrecedence>
549 C<$DefaultMailPrecedence> is used to control the default Precedence
550 level of outgoing mail where none is specified. By default it is
551 C<bulk>, but if you only send mail to your staff, you may wish to
554 Note that you can set the precedence of individual templates by
555 including an explicit Precedence header.
557 If you set this value to C<undef> then we do not set a default
558 Precedence header to outgoing mail. However, if there already is a
559 Precedence header, it will be preserved.
563 Set($DefaultMailPrecedence, "bulk");
565 =item C<$DefaultErrorMailPrecedence>
567 C<$DefaultErrorMailPrecedence> is used to control the default
568 Precedence level of outgoing mail that indicates some kind of error
569 condition. By default it is C<bulk>, but if you only send mail to your
570 staff, you may wish to change it.
572 If you set this value to C<undef> then we do not add a Precedence
573 header to error mail.
577 Set($DefaultErrorMailPrecedence, "bulk");
579 =item C<$UseOriginatorHeader>
581 C<$UseOriginatorHeader> is used to control the insertion of an
582 RT-Originator Header in every outgoing mail, containing the mail
583 address of the transaction creator.
587 Set($UseOriginatorHeader, 1);
589 =item C<$UseFriendlyFromLine>
591 By default, RT sets the outgoing mail's "From:" header to "SenderName
592 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
596 Set($UseFriendlyFromLine, 1);
598 =item C<$FriendlyFromLineFormat>
600 C<sprintf()> format of the friendly 'From:' header; its arguments are
601 SenderName and SenderEmailAddress.
605 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
607 =item C<$UseFriendlyToLine>
609 RT can optionally set a "Friendly" 'To:' header when sending messages
610 to Ccs or AdminCcs (rather than having a blank 'To:' header.
612 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
613 are using sendmail, rather than postfix, qmail, exim or some other
614 MTA, you _must_ disable this option.
618 Set($UseFriendlyToLine, 0);
620 =item C<$FriendlyToLineFormat>
622 C<sprintf()> format of the friendly 'To:' header; its arguments are
623 WatcherType and TicketId.
627 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
629 =item C<$NotifyActor>
631 By default, RT doesn't notify the person who performs an update, as
632 they already know what they've done. If you'd like to change this
633 behavior, Set C<$NotifyActor> to 1
637 Set($NotifyActor, 0);
639 =item C<$RecordOutgoingEmail>
641 By default, RT records each message it sends out to its own internal
642 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
644 If this is disabled, users' digest mail delivery preferences
645 (i.e. EmailFrequency) will also be ignored.
649 Set($RecordOutgoingEmail, 1);
651 =item C<$VERPPrefix>, C<$VERPDomain>
653 Setting these options enables VERP support
654 L<http://cr.yp.to/proto/verp.txt>.
656 Uncomment the following two directives to generate envelope senders
657 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
658 (i.e. rt-jesse=fsck.com@rt.example.com ).
660 This currently only works with sendmail and sendmailpipe.
664 # Set($VERPPrefix, "rt-");
665 # Set($VERPDomain, $RT::Organization);
668 =item C<$ForwardFromUser>
670 By default, RT forwards a message using queue's address and adds RT's
671 tag into subject of the outgoing message, so recipients' replies go
672 into RT as correspondents.
674 To change this behavior, set C<$ForwardFromUser> to 1 and RT
675 will use the address of the current user and remove RT's subject tag.
679 Set($ForwardFromUser, 0);
683 =head2 Email dashboards
687 =item C<$DashboardAddress>
689 The email address from which RT will send dashboards. If none is set,
690 then C<$OwnerEmail> will be used.
694 Set($DashboardAddress, '');
696 =item C<$DashboardSubject>
698 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
699 Weekly, Monthly) of the dashboard and the dashboard's name.
703 Set($DashboardSubject, "%s Dashboard: %s");
705 =item C<@EmailDashboardRemove>
707 A list of regular expressions that will be used to remove content from
712 Set(@EmailDashboardRemove, ());
718 =head2 Sendmail configuration
720 These options only take effect if C<$MailCommand> is 'sendmail' or
725 =item C<$SendmailArguments>
727 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
728 If you picked 'sendmailpipe', you MUST add a -t flag to
729 C<$SendmailArguments> These options are good for most sendmail
730 wrappers and work-a-likes.
732 These arguments are good for sendmail brand sendmail 8 and newer:
733 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
737 #Set($SendmailArguments, "-oi -t");
738 Set($SendmailArguments, "-oi");
741 =item C<$SendmailBounceArguments>
743 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
744 assuming RT needs to send an error (i.e. bounce).
748 Set($SendmailBounceArguments, '-f "<>"');
750 =item C<$SendmailPath>
752 If you selected 'sendmailpipe' above, you MUST specify the path to
753 your sendmail binary in C<$SendmailPath>.
757 Set($SendmailPath, "/usr/sbin/sendmail");
762 =head2 SMTP configuration
764 These options only take effect if C<$MailCommand> is 'smtp'
770 C<$SMTPServer> should be set to the hostname of the SMTP server to use
774 Set($SMTPServer, undef);
778 C<$SMTPFrom> should be set to the 'From' address to use, if not the
783 Set($SMTPFrom, undef);
787 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
801 C<@MailParams> defines a list of options passed to $MailCommand if it
802 is not 'sendmailpipe', 'sendmail', or 'smtp'
806 Set(@MailParams, ());
815 =item C<$WebDefaultStylesheet>
817 This determines the default stylesheet the RT web interface will use.
818 RT ships with several themes by default:
820 web2 The default layout for RT 3.8
821 aileron The default layout for RT 4.0
822 ballard Theme which doesn't rely on JavaScript for menuing
824 This bundled distibution of RT also includes:
825 freeside3 Integration with Freeside (enabled by default)
826 freeside2.1 Previous Freeside theme
828 This value actually specifies a directory in F<share/html/NoAuth/css/>
829 from which RT will try to load the file main.css (which should @import
830 any other files the stylesheet needs). This allows you to easily and
831 cleanly create your own stylesheets to apply to RT. This option can
832 be overridden by users in their preferences.
836 Set($WebDefaultStylesheet, "freeside3");
838 =item C<$DefaultQueue>
840 Use this to select the default queue name that will be used for
841 creating new tickets. You may use either the queue's name or its
842 ID. This only affects the queue selection boxes on the web interface.
846 # Set($DefaultQueue, "General");
848 =item C<$RememberDefaultQueue>
850 When a queue is selected in the new ticket dropdown, make it the new
851 default for the new ticket dropdown.
855 # Set($RememberDefaultQueue, 1);
857 =item C<$EnableReminders>
859 Hide all links and portlets related to Reminders by setting this to 0
863 Set($EnableReminders, 1);
865 =item C<@CustomFieldValuesSources>
867 Set C<@CustomFieldValuesSources> to a list of class names which extend
868 L<RT::CustomFieldValues::External>. This can be used to pull lists of
869 custom field values from external sources at runtime.
873 Set(@CustomFieldValuesSources, ('RT::CustomFieldValues::Queues'));
875 =item C<$CanonicalizeRedirectURLs>
877 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
878 redirecting rather than the one we get from C<%ENV>.
880 Apache's UseCanonicalName directive changes the hostname that RT
881 finds in C<%ENV>. You can read more about what turning it On or Off
882 means in the documentation for your version of Apache.
884 If you use RT behind a reverse proxy, you almost certainly want to
889 Set($CanonicalizeRedirectURLs, 0);
893 A list of JavaScript files to be included in head. Removing any of
894 the default entries is not suggested.
896 If you're a plugin author, refer to RT->AddJavaScript.
903 jquery-ui-1.8.4.custom.min.js
904 jquery-ui-timepicker-addon.js
905 jquery-ui-patch-datepicker.js
909 jquery.event.hover-1.0.js
912 jquery.supposition.js
919 Path to the jsmin binary; if specified, it will be used to minify
920 C<JSFiles>. The default, and the fallback if the binary cannot be
921 found, is to simply concatenate the files.
923 jsmin can be installed by running 'make jsmin' from the RT install
924 directory, or from http://www.crockford.com/javascript/jsmin.html
928 # Set($JSMinPath, "/path/to/jsmin");
932 A list of additional CSS files to be included in head.
934 If you're a plugin author, refer to RT->AddStyleSheets.
938 Set(@CSSFiles, qw//);
940 =item C<$UsernameFormat>
942 This determines how user info is displayed. 'concise' will show one of
943 either NickName, RealName, Name or EmailAddress, depending on what
944 exists and whether the user is privileged or not. 'verbose' will show
945 RealName and EmailAddress.
949 Set($UsernameFormat, "verbose");
951 =item C<$WebBaseURL>, C<$WebURL>
953 Usually you don't want to set these options. The only obvious reason
954 is if RT is accessible via https protocol on a non standard port, e.g.
955 'https://rt.example.com:9999'. In all other cases these options are
956 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
958 C<$WebBaseURL> is the scheme, server and port
959 (e.g. 'http://rt.example.com') for constructing URLs to the web
960 UI. C<$WebBaseURL> doesn't need a trailing /.
962 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
963 example: 'http://www.example.com/rt/'.
967 my $port = RT->Config->Get('WebPort');
969 ($port == 443? 'https': 'http') .'://'
970 . RT->Config->Get('WebDomain')
971 . ($port != 80 && $port != 443? ":$port" : '')
974 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
976 =item C<$WebImagesURL>
978 C<$WebImagesURL> points to the base URL where RT can find its images.
979 Define the directory name to be used for images in RT web documents.
983 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
987 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
988 This can also be configured via the web UI.
992 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
994 =item C<$LogoLinkURL>
996 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
1000 Set($LogoLinkURL, "http://bestpractical.com");
1002 =item C<$LogoAltText>
1004 C<$LogoAltText> is a string of text for the alt-text of the logo. It
1005 will be passed through C<loc> for localization.
1009 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1011 =item C<$LogoImageHeight>
1013 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1018 Set($LogoImageHeight, 38);
1020 =item C<$LogoImageWidth>
1022 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1027 Set($LogoImageWidth, 181);
1029 =item C<$WebNoAuthRegex>
1031 What portion of RT's URL space should not require authentication. The
1032 default is almost certainly correct, and should only be changed if you
1037 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1039 =item C<$SelfServiceRegex>
1041 What portion of RT's URLspace should be accessible to Unprivileged
1042 users This does not override the redirect from F</Ticket/Display.html>
1043 to F</SelfService/Display.html> when Unprivileged users attempt to
1044 access ticked displays.
1048 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1050 =item C<$WebFlushDbCacheEveryRequest>
1052 By default, RT clears its database cache after every page view. This
1053 ensures that you've always got the most current information when
1054 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1055 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1056 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1060 Set($WebFlushDbCacheEveryRequest, 1);
1064 The L<GD> module (which RT uses for graphs) ships with a built-in font
1065 that doesn't have full Unicode support. You can use a given TrueType
1066 font for a specific language by setting %ChartFont to (language =E<gt>
1067 the absolute path of a font) pairs. Your GD library must have support
1068 for TrueType fonts to use this option. If there is no entry for a
1069 language in the hash then font with 'others' key is used.
1071 RT comes with two TrueType fonts covering most available languages.
1077 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1078 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1079 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1080 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1083 =item C<$ChartsTimezonesInDB>
1085 RT stores dates using the UTC timezone in the DB, so charts grouped by
1086 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1087 to enable timezone conversions using your DB's capabilities. You may
1088 need to do some work on the DB side to use this feature, read more in
1089 F<docs/customizing/timezones_in_charts.pod>.
1091 At this time, this feature only applies to MySQL and PostgreSQL.
1095 Set($ChartsTimezonesInDB, 0);
1105 =item C<$DefaultSummaryRows>
1107 C<$DefaultSummaryRows> is default number of rows displayed in for
1108 search results on the front page.
1112 Set($DefaultSummaryRows, 10);
1114 =item C<$HomePageRefreshInterval>
1116 C<$HomePageRefreshInterval> is default number of seconds to refresh
1117 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1121 Set($HomePageRefreshInterval, 0);
1123 =item C<$HomepageComponents>
1125 C<$HomepageComponents> is an arrayref of allowed components on a
1126 user's customized homepage ("RT at a glance").
1130 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
1137 =head2 Ticket search
1141 =item C<$UseSQLForACLChecks>
1143 Historically, ACLs were checked on display, which could lead to empty
1144 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1145 to limit search results in SQL instead, which eliminates these
1148 This option is still relatively new; it may result in performance
1149 problems in some cases, or significant speedups in others.
1153 Set($UseSQLForACLChecks, undef);
1155 =item C<$TicketsItemMapSize>
1157 On the display page of a ticket from search results, RT provides links
1158 to the first, next, previous and last ticket from the results. In
1159 order to build these links, RT needs to fetch the full result set from
1160 the database, which can be resource-intensive.
1162 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1163 to build these links. If the full result set is larger than this
1164 number, RT will omit the "last" link in the menu. Set this to zero to
1165 always examine all results.
1169 Set($TicketsItemMapSize, 1000);
1171 =item C<$SearchResultsRefreshInterval>
1173 C<$SearchResultsRefreshInterval> is default number of seconds to
1174 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1179 Set($SearchResultsRefreshInterval, 0);
1181 =item C<$DefaultSearchResultFormat>
1183 C<$DefaultSearchResultFormat> is the default format for RT search
1188 Set ($DefaultSearchResultFormat, qq{
1189 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1190 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1198 '<small>__Requestors__</small>',
1199 '<small>__CustomerTags__</small>',
1200 '<small>__CreatedRelative__</small>',
1201 '<small>__ToldRelative__</small>',
1202 '<small>__LastUpdatedRelative__</small>',
1203 '<small>__TimeLeft__</small>'});
1205 =item C<$DefaultSelfServiceSearchResultFormat>
1207 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1208 searches displayed in the SelfService interface.
1212 Set($DefaultSelfServiceSearchResultFormat, qq{
1213 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1214 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1219 =item C<%FullTextSearch>
1221 Full text search (FTS) without database indexing is a very slow
1222 operation, and is thus disabled by default.
1224 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1225 the full details of FTS on your particular database.
1227 It is possible to enable FTS without database indexing support, simply
1228 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1229 This is not generally suggested, as unindexed full-text searching can
1230 cause severe performance problems.
1234 Set(%FullTextSearch,
1240 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1242 When query in simple search doesn't have status info, use this to only
1247 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1249 =item C<$SearchResultsAutoRedirect>
1251 When only one ticket is found in search, use this to redirect to the
1252 ticket display page automatically.
1256 Set($SearchResultsAutoRedirect, 0);
1262 =head2 Ticket display
1266 =item C<$ShowMoreAboutPrivilegedUsers>
1268 This determines if the 'More about requestor' box on
1269 Ticket/Display.html is shown for Privileged Users.
1273 Set($ShowMoreAboutPrivilegedUsers, 0);
1275 =item C<$MoreAboutRequestorTicketList>
1277 This can be set to Active, Inactive, All or None. It controls what
1278 ticket list will be displayed in the 'More about requestor' box on
1279 Ticket/Display.html. This option can be controlled by users also.
1283 Set($MoreAboutRequestorTicketList, "Active");
1285 =item C<$MoreAboutRequestorExtraInfo>
1287 By default, the 'More about requestor' box on Ticket/Display.html
1288 shows the Requestor's name and ticket list. If you would like to see
1289 extra information about the user, this expects a Format string of user
1290 attributes. Please note that not all the attributes are supported in
1291 this display because we're not building a table.
1294 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1298 Set($MoreAboutRequestorExtraInfo, "");
1300 =item C<$MoreAboutRequestorGroupsLimit>
1302 By default, the 'More about requestor' box on Ticket/Display.html
1303 shows all the groups of the Requestor. Use this to limit the number
1304 of groups; a value of undef removes the group display entirely.
1308 Set($MoreAboutRequestorGroupsLimit, 0);
1310 =item C<$UseSideBySideLayout>
1312 Should the ticket create and update forms use a more space efficient
1313 two column layout. This layout may not work in narrow browsers if you
1314 set a MessageBoxWidth (below).
1318 Set($UseSideBySideLayout, 1);
1320 =item C<$EditCustomFieldsSingleColumn>
1322 When displaying a list of Ticket Custom Fields for editing, RT
1323 defaults to a 2 column list. If you set this to 1, it will instead
1324 display the Custom Fields in a single column.
1328 Set($EditCustomFieldsSingleColumn, 0);
1330 =item C<$ShowUnreadMessageNotifications>
1332 If set to 1, RT will prompt users when there are new,
1333 unread messages on tickets they are viewing.
1337 Set($ShowUnreadMessageNotifications, 0);
1339 =item C<$AutocompleteOwners>
1341 If set to 1, the owner drop-downs for ticket update/modify and the query
1342 builder are replaced by text fields that autocomplete. This can
1343 alleviate the sometimes huge owner list for installations where many
1344 users have the OwnTicket right.
1348 Set($AutocompleteOwners, 0);
1350 =item C<$AutocompleteOwnersForSearch>
1352 If set to 1, the owner drop-downs for the query builder are always
1353 replaced by text field that autocomplete and C<$AutocompleteOwners>
1354 is ignored. Helpful when owners list is huge in the query builder.
1358 Set($AutocompleteOwnersForSearch, 0);
1360 =item C<$UserAutocompleteFields>
1362 Specifies which fields of L<RT::User> to match against and how to
1363 match each field when autocompleting users. Valid match methods are
1364 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1368 Set($UserAutocompleteFields, {
1369 EmailAddress => 'STARTSWITH',
1370 Name => 'STARTSWITH',
1374 =item C<$AllowUserAutocompleteForUnprivileged>
1376 Should unprivileged users be allowed to autocomplete users. Setting
1377 this option to 1 means unprivileged users will be able to search all
1382 Set($AllowUserAutocompleteForUnprivileged, 0);
1384 =item C<$DisplayTicketAfterQuickCreate>
1386 Enable this to redirect to the created ticket display page
1387 automatically when using QuickCreate.
1391 Set($DisplayTicketAfterQuickCreate, 0);
1393 =item C<$WikiImplicitLinks>
1395 Support implicit links in WikiText custom fields? Setting this to 1
1396 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1397 become links to searches for those words. If used on Articles, it links
1398 to the Article with that name.
1402 Set($WikiImplicitLinks, 0);
1404 =item C<$PreviewScripMessages>
1406 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1407 reply page should include the content of the messages to be sent.
1411 Set($PreviewScripMessages, 0);
1413 =item C<$SimplifiedRecipients>
1415 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1416 B<any> kind of mail will be shown on the ticket reply page, instead of a
1417 detailed breakdown by scrip.
1421 Set($SimplifiedRecipients, 0);
1423 =item C<$HideResolveActionsWithDependencies>
1425 If set to 1, this option will skip ticket menu actions which can't be
1426 completed successfully because of outstanding active Depends On tickets.
1428 By default, all ticket actions are displayed in the menu even if some of
1429 them can't be successful until all Depends On links are resolved or
1430 transitioned to another inactive status.
1434 Set($HideResolveActionsWithDependencies, 0);
1444 =item C<$ArticleOnTicketCreate>
1446 Set this to 1 to display the Articles interface on the Ticket Create
1447 page in addition to the Reply/Comment page.
1451 Set($ArticleOnTicketCreate, 0);
1453 =item C<$HideArticleSearchOnReplyCreate>
1455 Set this to 1 to hide the search and include boxes from the Article
1456 UI. This assumes you have enabled Article Hotlist feature, otherwise
1457 you will have no access to Articles.
1461 Set($HideArticleSearchOnReplyCreate, 0);
1467 =head2 Message box properties
1471 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1473 For message boxes, set the entry box width, height and what type of
1474 wrapping to use. These options can be overridden by users in their
1477 When the width is set to undef, no column count is specified and the
1478 message box will take up 100% of the available width. Combining this
1479 with HARD messagebox wrapping (below) is not recommended, as it will
1480 lead to inconsistent width in transactions between browsers.
1482 These settings only apply to the non-RichText message box. See below
1483 for Rich Text settings.
1487 Set($MessageBoxWidth, undef);
1488 Set($MessageBoxHeight, 15);
1490 =item C<$MessageBoxWrap>
1492 Wrapping is disabled when using MessageBoxRichText because of a bad
1493 interaction between IE and wrapping with the Rich Text Editor.
1497 Set($MessageBoxWrap, "SOFT");
1499 =item C<$MessageBoxRichText>
1501 Should "rich text" editing be enabled? This option lets your users
1502 send HTML email messages from the web interface.
1506 Set($MessageBoxRichText, 1);
1508 =item C<$MessageBoxRichTextHeight>
1510 Height of rich text JavaScript enabled editing boxes (in pixels)
1514 Set($MessageBoxRichTextHeight, 200);
1516 =item C<$MessageBoxIncludeSignature>
1518 Should your users' signatures (from their Preferences page) be
1519 included in Comments and Replies.
1523 Set($MessageBoxIncludeSignature, 1);
1525 =item C<$MessageBoxIncludeSignatureOnComment>
1527 Should your users' signatures (from their Preferences page) be
1528 included in Comments. Setting this to false overrides
1529 C<$MessageBoxIncludeSignature>.
1533 Set($MessageBoxIncludeSignatureOnComment, 1);
1538 =head2 Transaction display
1542 =item C<$OldestTransactionsFirst>
1544 By default, RT shows newest transactions at the bottom of the ticket
1545 history page, if you want see them at the top set this to 0. This
1546 option can be overridden by users in their preferences.
1550 Set($OldestTransactionsFirst, 1);
1552 =item C<$DeferTransactionLoading>
1554 When set, defers loading ticket history until the user clicks a link.
1555 This should end up serving pages to users quicker, since generating
1556 all the HTML for transaction history can be slow for long tickets.
1560 # Set($DeferTransactionLoading, 1);
1562 =item C<$ShowBccHeader>
1564 By default, RT hides from the web UI information about blind copies
1565 user sent on reply or comment.
1569 Set($ShowBccHeader, 0);
1571 =item C<$TrustHTMLAttachments>
1573 If C<TrustHTMLAttachments> is not defined, we will display them as
1574 text. This prevents malicious HTML and JavaScript from being sent in a
1575 request (although there is probably more to it than that)
1579 Set($TrustHTMLAttachments, undef);
1581 =item C<$AlwaysDownloadAttachments>
1583 Always download attachments, regardless of content type. If set, this
1584 overrides C<TrustHTMLAttachments>.
1588 Set($AlwaysDownloadAttachments, undef);
1590 =item C<$AttachmentUnits>
1592 Controls the units (kilobytes or bytes) that attachment sizes use for
1593 display. The default is to display kilobytes if the attachment is
1594 larger than 1024 bytes, bytes otherwise. If you set
1595 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1596 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1600 Set($AttachmentUnits, undef);
1602 =item C<$PreferRichText>
1604 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1605 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1606 show only a minimal subset of HTML to avoid possible contamination by
1607 cross-site-scripting attacks.
1611 Set($PreferRichText, undef);
1613 =item C<$MaxInlineBody>
1615 C<$MaxInlineBody> is the maximum attachment size that we want to see
1616 inline when viewing a transaction. RT will inline any text if the
1617 value is undefined or 0. This option can be overridden by users in
1622 Set($MaxInlineBody, 12000);
1624 =item C<$ShowTransactionImages>
1626 By default, RT shows images attached to incoming (and outgoing) ticket
1627 updates inline. Set this variable to 0 if you'd like to disable that
1632 Set($ShowTransactionImages, 1);
1634 =item C<$PlainTextPre>
1636 Normally plaintext attachments are displayed as HTML with line breaks
1637 preserved. This causes space- and tab-based formatting not to be
1638 displayed correctly. By setting $PlainTextPre messages will be
1639 displayed using <pre>.
1643 Set($PlainTextPre, 0);
1646 =item C<$PlainTextMono>
1648 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1649 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1650 of the browser window; this option overrides C<$PlainTextPre>.
1654 Set($PlainTextMono, 0);
1656 =item C<$SuppressInlineTextFiles>
1658 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1659 (text-type attachments with file names) are prevented from being
1660 displayed in-line when viewing a ticket's history.
1664 Set($SuppressInlineTextFiles, undef);
1667 =item C<@Active_MakeClicky>
1669 MakeClicky detects various formats of data in headers and email
1670 messages, and extends them with supporting links. By default, RT
1671 provides two formats:
1673 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1676 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1677 replaces the URL with a link.
1679 See F<share/html/Elements/MakeClicky> for documentation on how to add
1680 your own styles of link detection.
1684 Set(@Active_MakeClicky, qw());
1690 =head1 Application logic
1694 =item C<$ParseNewMessageForTicketCcs>
1696 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1697 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1698 messages. Be forewarned that if you have I<any> addresses which forward
1699 mail to RT automatically and you enable this option without modifying
1700 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1704 Set($ParseNewMessageForTicketCcs, undef);
1706 =item C<$UseTransactionBatch>
1708 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1709 such that a resolve and comment (for example) would happen
1710 simultaneously, instead of as two transactions, unaware of each
1715 Set($UseTransactionBatch, 1);
1717 =item C<$StrictLinkACL>
1719 When this feature is enabled a user needs I<ModifyTicket> rights on
1720 both tickets to link them together; otherwise, I<ModifyTicket> rights
1721 on either of them is sufficient.
1725 Set($StrictLinkACL, 1);
1727 =item C<$RedistributeAutoGeneratedMessages>
1729 Should RT redistribute correspondence that it identifies as machine
1730 generated? A 1 will do so; setting this to 0 will cause no
1731 such messages to be redistributed. You can also use 'privileged' (the
1732 default), which will redistribute only to privileged users. This helps
1733 to protect against malformed bounces and loops caused by auto-created
1734 requestors with bogus addresses.
1738 Set($RedistributeAutoGeneratedMessages, "privileged");
1740 =item C<$ApprovalRejectionNotes>
1742 Should rejection notes from approvals be sent to the requestors?
1746 Set($ApprovalRejectionNotes, 1);
1748 =item C<$ForceApprovalsView>
1750 Should approval tickets only be viewed and modified through the standard
1751 approval interface? Changing this setting to 1 will redirect any attempt to
1752 use the normal ticket display and modify page for approval tickets.
1754 For example, with this option set to 1 and an approval ticket #123:
1756 /Ticket/Display.html?id=123
1760 /Approval/Display.html?id=123
1766 Set($ForceApprovalsView, 0);
1768 =head1 Extra security
1770 This is a list of extra security measures to enable that help keep your RT
1771 safe. If you don't know what these mean, you should almost certainly leave the
1776 =item C<$DisallowExecuteCode>
1778 If set to a true value, the C<ExecuteCode> right will be removed from
1779 all users, B<including> the superuser. This is intended for when RT is
1780 installed into a shared environment where even the superuser should not
1781 be allowed to run arbitrary Perl code on the server via scrips.
1785 Set($DisallowExecuteCode, 0);
1787 =item C<$Framebusting>
1789 If set to a false value, framekiller javascript will be disabled and the
1790 X-Frame-Options: DENY header will be suppressed from all responses.
1791 This disables RT's clickjacking protection.
1795 Set($Framebusting, 1);
1797 =item C<$RestrictReferrer>
1799 If set to a false value, the HTTP C<Referer> (sic) header will not be
1800 checked to ensure that requests come from RT's own domain. As RT allows
1801 for GET requests to alter state, disabling this opens RT up to
1802 cross-site request forgery (CSRF) attacks.
1806 Set($RestrictReferrer, 1);
1808 =item C<$RestrictLoginReferrer>
1810 If set to a false value, RT will allow the user to log in from any link
1811 or request, merely by passing in C<user> and C<pass> parameters; setting
1812 it to a true value forces all logins to come from the login box, so the
1813 user is aware that they are being logged in. The default is off, for
1814 backwards compatability.
1818 Set($RestrictLoginReferrer, 0);
1820 =item C<@ReferrerWhitelist>
1822 This is a list of hostname:port combinations that RT will treat as being
1823 part of RT's domain. This is particularly useful if you access RT as
1824 multiple hostnames or have an external auth system that needs to
1825 redirect back to RT once authentication is complete.
1827 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1829 If the "RT has detected a possible cross-site request forgery" error is triggered
1830 by a host:port sent by your browser that you believe should be valid, you can copy
1831 the host:port from the error message into this list.
1833 Simple wildcards, similar to SSL certificates, are allowed. For example:
1835 *.example.com:80 # matches foo.example.com
1836 # but not example.com
1837 # or foo.bar.example.com
1839 www*.example.com:80 # matches www3.example.com
1840 # and www-test.example.com
1841 # and www.example.com
1845 Set(@ReferrerWhitelist, qw());
1851 =head1 Authorization and user configuration
1855 =item C<$WebExternalAuth>
1857 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1858 REMOTE_USER variable.
1862 Set($WebExternalAuth, undef);
1864 =item C<$WebExternalAuthContinuous>
1866 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1867 REMOTE_USER on each access. If you would prefer this to only happen
1868 once (at initial login) set this to a false value. The default
1869 setting will help ensure that if your external authentication system
1870 deauthenticates a user, RT notices as soon as possible.
1874 Set($WebExternalAuthContinuous, 1);
1876 =item C<$WebFallbackToInternalAuth>
1878 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1879 chance of fallback to the login screen, even if REMOTE_USER failed.
1883 Set($WebFallbackToInternalAuth, undef);
1885 =item C<$WebExternalGecos>
1887 C<$WebExternalGecos> means to match 'gecos' field as the user
1888 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1893 Set($WebExternalGecos, undef);
1895 =item C<$WebExternalAuto>
1897 C<$WebExternalAuto> will create users under the same name as
1898 REMOTE_USER upon login, if it's missing in the Users table.
1902 Set($WebExternalAuto, undef);
1904 =item C<$AutoCreate>
1906 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1907 User's Create method. Use it to set defaults, such as creating
1908 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1912 Set($AutoCreate, undef);
1914 =item C<$WebSessionClass>
1916 C<$WebSessionClass> is the class you wish to use for managing sessions.
1917 It defaults to use your SQL database, except on Oracle, where it
1918 defaults to files on disk.
1922 # Set($WebSessionClass, "Apache::Session::File");
1924 =item C<$AutoLogoff>
1926 By default, RT's user sessions persist until a user closes his or her
1927 browser. With the C<$AutoLogoff> option you can setup session lifetime
1928 in minutes. A user will be logged out if he or she doesn't send any
1929 requests to RT for the defined time.
1933 Set($AutoLogoff, 0);
1935 =item C<$LogoutRefresh>
1937 The number of seconds to wait after logout before sending the user to
1938 the login page. By default, 1 second, though you may want to increase
1939 this if you display additional information on the logout page.
1943 Set($LogoutRefresh, 1);
1945 =item C<$WebSecureCookies>
1947 By default, RT's session cookie isn't marked as "secure". Some web
1948 browsers will treat secure cookies more carefully than non-secure
1949 ones, being careful not to write them to disk, only sending them over
1950 an SSL secured connection, and so on. To enable this behavior, set
1951 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1952 on I<unless> users are only connecting via SSL encrypted HTTPS
1957 Set($WebSecureCookies, 0);
1959 =item C<$WebHttpOnlyCookies>
1961 Default RT's session cookie to not being directly accessible to
1962 javascript. The content is still sent during regular and AJAX requests,
1963 and other cookies are unaffected, but the session-id is less
1964 programmatically accessible to javascript. Turning this off should only
1965 be necessary in situations with odd client-side authentication
1970 Set($WebHttpOnlyCookies, 1);
1972 =item C<$MinimumPasswordLength>
1974 C<$MinimumPasswordLength> defines the minimum length for user
1975 passwords. Setting it to 0 disables this check.
1979 Set($MinimumPasswordLength, 5);
1984 =head1 Internationalization
1988 =item C<@LexiconLanguages>
1990 An array that contains languages supported by RT's
1991 internationalization interface. Defaults to all *.po lexicons;
1992 setting it to C<qw(en ja)> will make RT bilingual instead of
1993 multilingual, but will save some memory.
1997 Set(@LexiconLanguages, qw(*));
1999 =item C<@EmailInputEncodings>
2001 An array that contains default encodings used to guess which charset
2002 an attachment uses, if it does not specify one explicitly. All
2003 options must be recognized by L<Encode::Guess>. The first element may
2004 also be '*', which enables encoding detection using
2005 L<Encode::Detect::Detector>, if installed.
2009 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
2011 =item C<$EmailOutputEncoding>
2013 The charset for localized email. Must be recognized by Encode.
2017 Set($EmailOutputEncoding, "utf-8");
2027 =head1 Date and time handling
2031 =item C<$DateTimeFormat>
2033 You can choose date and time format. See the "Output formatters"
2034 section in perldoc F<lib/RT/Date.pm> for more options. This option
2035 can be overridden by users in their preferences.
2039 C<Set($DateTimeFormat, "LocalizedDateTime");>
2040 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2041 C<Set($DateTimeFormat, "RFC2822");>
2042 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2046 Set($DateTimeFormat, "DefaultFormat");
2048 # Next two options are for Time::ParseDate
2050 =item C<$DateDayBeforeMonth>
2052 Set this to 1 if your local date convention looks like "dd/mm/yy"
2053 instead of "mm/dd/yy". Used only for parsing, not for displaying
2058 Set($DateDayBeforeMonth, 1);
2060 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2062 Should an unspecified day or year in a date refer to a future or a
2063 past value? For example, should a date of "Tuesday" default to mean
2064 the date for next Tuesday or last Tuesday? Should the date "March 1"
2065 default to the date for next March or last March?
2067 Set C<$AmbiguousDayInPast> for the last date, or
2068 C<$AmbiguousDayInFuture> for the next date; the default is usually
2069 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2073 Set($AmbiguousDayInPast, 0);
2074 Set($AmbiguousDayInFuture, 0);
2076 =item C<$DefaultTimeUnitsToHours>
2078 Use this to set the default units for time entry to hours instead of
2079 minutes. Note that this only effects entry, not display.
2083 Set($DefaultTimeUnitsToHours, 0);
2085 =item C<$SimpleSearchIncludeResolved>
2087 By default, the simple ticket search in the top bar excludes "resolved" tickets
2088 unless a status argument is specified. Set this to a true value to include
2093 Set($SimpleSearchIncludeResolved, 0);
2100 =head1 GnuPG integration
2102 A full description of the (somewhat extensive) GnuPG integration can
2103 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2104 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2110 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2111 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2113 If you want to allow people to encrypt attachments inside the DB then
2114 set C<AllowEncryptDataInDB> to 1.
2116 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2117 emails encrypted for key RT doesn't have and can not decrypt.
2119 Set C<RejectOnBadData> to false if you don't want to reject letters
2120 with incorrect GnuPG data.
2126 OutgoingMessagesFormat => "RFC", # Inline
2127 AllowEncryptDataInDB => 0,
2129 RejectOnMissingPrivateKey => 1,
2130 RejectOnBadData => 1,
2133 =item C<%GnuPGOptions>
2135 Options to pass to the GnuPG program.
2137 If you override this in your RT_SiteConfig, you should be sure to
2138 include a homedir setting.
2140 Note that options with '-' character MUST be quoted.
2145 homedir => q{@RT_VAR_PATH@/data/gpg},
2147 # URL of a keyserver
2148 # keyserver => 'hkp://subkeys.pgp.net',
2150 # enables the automatic retrieving of keys when encrypting
2151 # 'auto-key-locate' => 'keyserver',
2153 # enables the automatic retrieving of keys when verifying signatures
2154 # 'auto-key-retrieve' => undef,
2163 =head2 Lifecycle definitions
2165 Each lifecycle is a list of possible statuses split into three logic
2166 sets: B<initial>, B<active> and B<inactive>. Each status in a
2167 lifecycle must be unique. (Statuses may not be repeated across sets.)
2168 Each set may have any number of statuses.
2174 active => ['open', 'stalled'],
2175 inactive => ['resolved', 'rejected', 'deleted'],
2179 Status names can be from 1 to 64 ASCII characters. Statuses are
2180 localized using RT's standard internationalization and localization
2187 You can define multiple B<initial> statuses for tickets in a given
2190 RT will automatically set its B<Started> date when you change a
2191 ticket's status from an B<initial> state to an B<active> or
2196 B<Active> tickets are "currently in play" - they're things that are
2197 being worked on and not yet complete.
2201 B<Inactive> tickets are typically in their "final resting state".
2203 While you're free to implement a workflow that ignores that
2204 description, typically once a ticket enters an inactive state, it will
2205 never again enter an active state.
2207 RT will automatically set the B<Resolved> date when a ticket's status
2208 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2211 B<deleted> is still a special status and protected by the
2212 B<DeleteTicket> right, unless you re-defined rights (read below). If
2213 you don't want to allow ticket deletion at any time simply don't
2214 include it in your lifecycle.
2218 Statuses in each set are ordered and listed in the UI in the defined
2221 Changes between statuses are constrained by transition rules, as
2224 =head2 Default values
2226 In some cases a default value is used to display in UI or in API when
2227 value is not provided. You can configure defaults using the following
2234 on_resolve => 'resolved',
2239 The following defaults are used.
2245 If you (or your code) doesn't specify a status when creating a ticket,
2246 RT will use the this status. See also L</Statuses available during
2251 When tickets are merged, the status of the ticket that was merged
2252 away is forced to this value. It should be one of inactive statuses;
2253 'resolved' or its equivalent is most probably the best candidate.
2257 When an approval is accepted, the status of depending tickets will
2258 be changed to this value.
2262 When an approval is denied, the status of depending tickets will
2263 be changed to this value.
2265 =item reminder_on_open
2267 When a reminder is opened, the status will be changed to this value.
2269 =item reminder_on_resolve
2271 When a reminder is resolved, the status will be changed to this value.
2275 =head2 Transitions between statuses and UI actions
2277 A B<Transition> is a change of status from A to B. You should define
2278 all possible transitions in each lifecycle using the following format:
2283 '' => [qw(new open resolved)],
2284 new => [qw(open resolved rejected deleted)],
2285 open => [qw(stalled resolved rejected deleted)],
2286 stalled => [qw(open)],
2287 resolved => [qw(open)],
2288 rejected => [qw(open)],
2289 deleted => [qw(open)],
2294 =head3 Statuses available during ticket creation
2296 By default users can create tickets with a status of new,
2297 open, or resolved, but cannot create tickets with a status of
2298 rejected, stalled, or deleted. If you want to change the statuses
2299 available during creation, update the transition from '' (empty
2300 string), like in the example above.
2302 =head3 Protecting status changes with rights
2304 A transition or group of transitions can be protected by a specific
2305 right. Additionally, you can name new right names, which will be added
2306 to the system to control that transition. For example, if you wished to
2307 create a lesser right than ModifyTicket for rejecting tickets, you could
2313 '* -> deleted' => 'DeleteTicket',
2314 '* -> rejected' => 'RejectTicket',
2315 '* -> *' => 'ModifyTicket',
2320 This would create a new C<RejectTicket> right in the system which you
2321 could assign to whatever groups you choose.
2323 On the left hand side you can have the following variants:
2330 Valid transitions are listed in order of priority. If a user attempts
2331 to change a ticket's status from B<new> to B<open> then the lifecycle
2332 is checked for presence of an exact match, then for 'any to B<open>',
2333 'B<new> to any' and finally 'any to any'.
2335 If you don't define any rights, or there is no match for a transition,
2336 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2338 =head3 Labeling and defining actions
2340 For each transition you can define an action that will be shown in the
2341 UI; each action annotated with a label and an update type.
2343 Each action may provide a default update type, which can be
2344 B<Comment>, B<Respond>, or absent. For example, you may want your
2345 staff to write a reply to the end user when they change status from
2346 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2347 B<Comment> nor B<Respond> are mandatory, and user may leave the
2348 message empty, regardless of the update type.
2350 This configuration can be used to accomplish what
2351 $ResolveDefaultUpdateType was used for in RT 3.8.
2353 Use the following format to define labels and actions of transitions:
2358 'new -> open' => { label => 'Open it', update => 'Respond' },
2359 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2360 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2361 'new -> deleted' => { label => 'Delete' },
2363 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2364 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2365 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2367 'stalled -> open' => { label => 'Open it' },
2368 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2369 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2370 'deleted -> open' => { label => 'Undelete' },
2375 In addition, you may define multiple actions for the same transition.
2376 Alternately, you may use '* -> x' to match more than one transition.
2383 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2384 'new -> rejected' => { label => 'Quick Reject' },
2386 '* -> deleted' => { label => 'Delete' },
2392 =head2 Moving tickets between queues with different lifecycles
2394 Unless there is an explicit mapping between statuses in two different
2395 lifecycles, you can not move tickets between queues with these
2396 lifecycles. This is true even if the different lifecycles use the exact
2397 same set of statuses. Such a mapping is defined as follows:
2400 'from lifecycle -> to lifecycle' => {
2401 'status in left lifecycle' => 'status in right lifecycle',
2411 initial => [ 'new' ],
2412 active => [ 'open', 'stalled' ],
2413 inactive => [ 'resolved', 'rejected', 'deleted' ],
2417 on_merge => 'resolved',
2419 denied => 'rejected',
2420 reminder_on_open => 'open',
2421 reminder_on_resolve => 'resolved',
2425 '' => [qw(new open resolved)],
2427 # from => [ to list ],
2428 new => [qw(open stalled resolved rejected deleted)],
2429 open => [qw(new stalled resolved rejected deleted)],
2430 stalled => [qw(new open rejected resolved deleted)],
2431 resolved => [qw(new open stalled rejected deleted)],
2432 rejected => [qw(new open stalled resolved deleted)],
2433 deleted => [qw(new open stalled rejected resolved)],
2436 '* -> deleted' => 'DeleteTicket',
2437 '* -> *' => 'ModifyTicket',
2441 label => 'Open It', # loc
2442 update => 'Respond',
2444 'new -> resolved' => {
2445 label => 'Resolve', # loc
2446 update => 'Comment',
2448 'new -> rejected' => {
2449 label => 'Reject', # loc
2450 update => 'Respond',
2452 'new -> deleted' => {
2453 label => 'Delete', # loc
2456 'open -> stalled' => {
2457 label => 'Stall', # loc
2458 update => 'Comment',
2460 'open -> resolved' => {
2461 label => 'Resolve', # loc
2462 update => 'Comment',
2464 'open -> rejected' => {
2465 label => 'Reject', # loc
2466 update => 'Respond',
2469 'stalled -> open' => {
2470 label => 'Open It', # loc
2472 'resolved -> open' => {
2473 label => 'Re-open', # loc
2474 update => 'Comment',
2476 'rejected -> open' => {
2477 label => 'Re-open', # loc
2478 update => 'Comment',
2480 'deleted -> open' => {
2481 label => 'Undelete', # loc
2485 # don't change lifecyle of the approvals, they are not capable to deal with
2488 initial => [ 'new' ],
2489 active => [ 'open', 'stalled' ],
2490 inactive => [ 'resolved', 'rejected', 'deleted' ],
2494 on_merge => 'resolved',
2495 reminder_on_open => 'open',
2496 reminder_on_resolve => 'resolved',
2500 '' => [qw(new open resolved)],
2502 # from => [ to list ],
2503 new => [qw(open stalled resolved rejected deleted)],
2504 open => [qw(new stalled resolved rejected deleted)],
2505 stalled => [qw(new open rejected resolved deleted)],
2506 resolved => [qw(new open stalled rejected deleted)],
2507 rejected => [qw(new open stalled resolved deleted)],
2508 deleted => [qw(new open stalled rejected resolved)],
2511 '* -> deleted' => 'DeleteTicket',
2512 '* -> rejected' => 'ModifyTicket',
2513 '* -> *' => 'ModifyTicket',
2517 label => 'Open It', # loc
2518 update => 'Respond',
2520 'new -> resolved' => {
2521 label => 'Resolve', # loc
2522 update => 'Comment',
2524 'new -> rejected' => {
2525 label => 'Reject', # loc
2526 update => 'Respond',
2528 'new -> deleted' => {
2529 label => 'Delete', # loc
2532 'open -> stalled' => {
2533 label => 'Stall', # loc
2534 update => 'Comment',
2536 'open -> resolved' => {
2537 label => 'Resolve', # loc
2538 update => 'Comment',
2540 'open -> rejected' => {
2541 label => 'Reject', # loc
2542 update => 'Respond',
2545 'stalled -> open' => {
2546 label => 'Open It', # loc
2548 'resolved -> open' => {
2549 label => 'Re-open', # loc
2550 update => 'Comment',
2552 'rejected -> open' => {
2553 label => 'Re-open', # loc
2554 update => 'Comment',
2556 'deleted -> open' => {
2557 label => 'Undelete', # loc
2567 =head1 Administrative interface
2571 =item C<$ShowRTPortal>
2573 RT can show administrators a feed of recent RT releases and other
2574 related announcements and information from Best Practical on the top
2575 level Configuration page. This feature helps you stay up to date on
2576 RT security announcements and version updates.
2578 RT provides this feature using an "iframe" on C</Admin/index.html>
2579 which asks the administrator's browser to show an inline page from
2580 Best Practical's website.
2582 If you'd rather not make this feature available to your
2583 administrators, set C<$ShowRTPortal> to a false value.
2587 Set($ShowRTPortal, 1);
2589 =item C<%AdminSearchResultFormat>
2591 In the admin interface, format strings similar to tickets result
2592 formats are used. Use C<%AdminSearchResultFormat> to define the format
2593 strings used in the admin interface on a per-RT-class basis.
2597 Set(%AdminSearchResultFormat,
2599 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2600 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2601 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__,__Lifecycle__},
2604 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2605 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2606 .q{,'__Description__'},
2609 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2610 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2611 .q{,__RealName__, __EmailAddress__},
2614 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2615 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2616 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2619 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2620 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2621 .q{,__Stage__, __Condition__, __Action__, __Template__},
2624 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2625 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2626 .q{,__Stage__, __Condition__, __Action__, __Template__},
2629 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2630 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2631 .q{,'__Description__'},
2633 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2634 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2635 .q{,__Description__},
2643 =head1 Development options
2649 RT comes with a "Development mode" setting. This setting, as a
2650 convenience for developers, turns on several of development options
2651 that you most likely don't want in production:
2657 Disables CSS and JS minification and concatenation. Both CSS and JS
2658 will be instead be served as a number of individual smaller files,
2659 unchanged from how they are stored on disk.
2663 Uses L<Module::Refresh> to reload changed Perl modules on each
2668 Turns off Mason's C<static_source> directive; this causes Mason to
2669 reload template files which have been modified on disk.
2673 Turns on Mason's HTML C<error_format>; this renders compilation errors
2674 to the browser, along with a full stack trace. It is possible for
2675 stack traces to reveal sensitive information such as passwords or
2680 Turns off caching of callbacks; this enables additional callbacks to
2681 be added while the server is running.
2687 Set($DevelMode, "@RT_DEVEL_MODE@");
2690 =item C<$RecordBaseClass>
2692 What abstract base class should RT use for its records. You should
2693 probably never change this.
2695 Valid values are C<DBIx::SearchBuilder::Record> or
2696 C<DBIx::SearchBuilder::Record::Cachable>
2700 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2703 =item C<@MasonParameters>
2705 C<@MasonParameters> is the list of parameters for the constructor of
2706 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2707 debugging, e.g. profiling individual components with:
2709 use MasonX::Profiler; # available on CPAN
2710 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2714 Set(@MasonParameters, ());
2716 =item C<$StatementLog>
2718 RT has rudimentary SQL statement logging support; simply set
2719 C<$StatementLog> to be the level that you wish SQL statements to be
2722 Enabling this option will also expose the SQL Queries page in the
2723 Configuration -> Tools menu for SuperUsers.
2727 Set($StatementLog, undef);
2734 =head1 Deprecated options
2738 =item C<$LinkTransactionsRun1Scrip>
2740 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2741 one transaction and run one scrip. Set this value to 1 if you want
2742 only one of the link transactions to have scrips run.
2746 Set($LinkTransactionsRun1Scrip, 0);
2748 =item C<$ResolveDefaultUpdateType>
2750 This option has been deprecated. You can configure this site-wide
2751 with L</Lifecycles> (see L</Labeling and defining actions>).