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+\]/));
487 =item C<$CheckMoreMSMailHeaders>
489 Some email clients create a plain text version of HTML-formatted
490 email to help other clients that read only plain text.
491 Unfortunately, the plain text parts sometimes end up with
492 doubled newlines and these can then end up in RT. This
493 is most often seen in MS Outlook.
495 Enable this option to have RT check for additional mail headers
496 and attempt to identify email from MS Outlook. When detected,
497 RT will then clean up double newlines. Note that it may
498 clean up intentional double newlines as well.
502 Set( $CheckMoreMSMailHeaders, 0);
512 =item C<$MailCommand>
514 C<$MailCommand> defines which method RT will use to try to send mail.
515 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
516 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
519 Note that you should remove the '-t' from C<$SendmailArguments> if you
520 use 'sendmail' rather than 'sendmailpipe'
522 For testing purposes, or to simply disable sending mail out into the
523 world, you can set C<$MailCommand> to 'testfile' which writes all mail
524 to a temporary file. RT will log the location of the temporary file
525 so you can extract mail from it afterward.
529 #Set($MailCommand, "sendmailpipe");
530 Set($MailCommand, "sendmail");
532 =item C<$SetOutgoingMailFrom>
534 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
535 Correspond mail address of the ticket's queue.
537 Warning: If you use this setting, bounced mails will appear to be
538 incoming mail to the system, thus creating new tickets.
540 This option only works if C<$MailCommand> is set to 'sendmailpipe'.
544 Set($SetOutgoingMailFrom, 0);
546 =item C<$OverrideOutgoingMailFrom>
548 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
549 address of the queue as it is handed to sendmail -f. This helps force
550 the From_ header away from www-data or other email addresses that show
551 up in the "Sent by" line in Outlook.
553 The option is a hash reference of queue name to email address. If
554 there is no ticket involved, then the value of the C<Default> key will
557 This option only works if C<$SetOutgoingMailFrom> is enabled and
558 C<$MailCommand> is set to 'sendmailpipe'.
562 Set($OverrideOutgoingMailFrom, {
563 # 'Default' => 'admin@rt.example.com',
564 # 'General' => 'general@rt.example.com',
567 =item C<$DefaultMailPrecedence>
569 C<$DefaultMailPrecedence> is used to control the default Precedence
570 level of outgoing mail where none is specified. By default it is
571 C<bulk>, but if you only send mail to your staff, you may wish to
574 Note that you can set the precedence of individual templates by
575 including an explicit Precedence header.
577 If you set this value to C<undef> then we do not set a default
578 Precedence header to outgoing mail. However, if there already is a
579 Precedence header, it will be preserved.
583 Set($DefaultMailPrecedence, "bulk");
585 =item C<$DefaultErrorMailPrecedence>
587 C<$DefaultErrorMailPrecedence> is used to control the default
588 Precedence level of outgoing mail that indicates some kind of error
589 condition. By default it is C<bulk>, but if you only send mail to your
590 staff, you may wish to change it.
592 If you set this value to C<undef> then we do not add a Precedence
593 header to error mail.
597 Set($DefaultErrorMailPrecedence, "bulk");
599 =item C<$UseOriginatorHeader>
601 C<$UseOriginatorHeader> is used to control the insertion of an
602 RT-Originator Header in every outgoing mail, containing the mail
603 address of the transaction creator.
607 Set($UseOriginatorHeader, 1);
609 =item C<$UseFriendlyFromLine>
611 By default, RT sets the outgoing mail's "From:" header to "SenderName
612 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
616 Set($UseFriendlyFromLine, 1);
618 =item C<$FriendlyFromLineFormat>
620 C<sprintf()> format of the friendly 'From:' header; its arguments are
621 SenderName and SenderEmailAddress.
625 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
627 =item C<$UseFriendlyToLine>
629 RT can optionally set a "Friendly" 'To:' header when sending messages
630 to Ccs or AdminCcs (rather than having a blank 'To:' header.
632 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
633 are using sendmail, rather than postfix, qmail, exim or some other
634 MTA, you _must_ disable this option.
638 Set($UseFriendlyToLine, 0);
640 =item C<$FriendlyToLineFormat>
642 C<sprintf()> format of the friendly 'To:' header; its arguments are
643 WatcherType and TicketId.
647 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
649 =item C<$NotifyActor>
651 By default, RT doesn't notify the person who performs an update, as
652 they already know what they've done. If you'd like to change this
653 behavior, Set C<$NotifyActor> to 1
657 Set($NotifyActor, 0);
659 =item C<$RecordOutgoingEmail>
661 By default, RT records each message it sends out to its own internal
662 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
664 If this is disabled, users' digest mail delivery preferences
665 (i.e. EmailFrequency) will also be ignored.
669 Set($RecordOutgoingEmail, 1);
671 =item C<$VERPPrefix>, C<$VERPDomain>
673 Setting these options enables VERP support
674 L<http://cr.yp.to/proto/verp.txt>.
676 Uncomment the following two directives to generate envelope senders
677 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
678 (i.e. rt-jesse=fsck.com@rt.example.com ).
680 This currently only works with sendmail and sendmailpipe.
684 # Set($VERPPrefix, "rt-");
685 # Set($VERPDomain, $RT::Organization);
688 =item C<$ForwardFromUser>
690 By default, RT forwards a message using queue's address and adds RT's
691 tag into subject of the outgoing message, so recipients' replies go
692 into RT as correspondents.
694 To change this behavior, set C<$ForwardFromUser> to 1 and RT
695 will use the address of the current user and remove RT's subject tag.
699 Set($ForwardFromUser, 0);
703 =head2 Email dashboards
707 =item C<$DashboardAddress>
709 The email address from which RT will send dashboards. If none is set,
710 then C<$OwnerEmail> will be used.
714 Set($DashboardAddress, '');
716 =item C<$DashboardSubject>
718 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
719 Weekly, Monthly) of the dashboard and the dashboard's name.
723 Set($DashboardSubject, "%s Dashboard: %s");
725 =item C<@EmailDashboardRemove>
727 A list of regular expressions that will be used to remove content from
732 Set(@EmailDashboardRemove, ());
738 =head2 Sendmail configuration
740 These options only take effect if C<$MailCommand> is 'sendmail' or
745 =item C<$SendmailArguments>
747 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
748 If you picked 'sendmailpipe', you MUST add a -t flag to
749 C<$SendmailArguments> These options are good for most sendmail
750 wrappers and work-a-likes.
752 These arguments are good for sendmail brand sendmail 8 and newer:
753 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
757 #Set($SendmailArguments, "-oi -t");
758 Set($SendmailArguments, "-oi");
761 =item C<$SendmailBounceArguments>
763 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
764 assuming RT needs to send an error (i.e. bounce).
768 Set($SendmailBounceArguments, '-f "<>"');
770 =item C<$SendmailPath>
772 If you selected 'sendmailpipe' above, you MUST specify the path to
773 your sendmail binary in C<$SendmailPath>.
777 Set($SendmailPath, "/usr/sbin/sendmail");
782 =head2 SMTP configuration
784 These options only take effect if C<$MailCommand> is 'smtp'
790 C<$SMTPServer> should be set to the hostname of the SMTP server to use
794 Set($SMTPServer, undef);
798 C<$SMTPFrom> should be set to the 'From' address to use, if not the
803 Set($SMTPFrom, undef);
807 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
821 C<@MailParams> defines a list of options passed to $MailCommand if it
822 is not 'sendmailpipe', 'sendmail', or 'smtp'
826 Set(@MailParams, ());
835 =item C<$WebDefaultStylesheet>
837 This determines the default stylesheet the RT web interface will use.
838 RT ships with several themes by default:
840 web2 The default layout for RT 3.8
841 aileron The default layout for RT 4.0
842 ballard Theme which doesn't rely on JavaScript for menuing
844 This bundled distibution of RT also includes:
845 freeside3 Integration with Freeside (enabled by default)
846 freeside2.1 Previous Freeside theme
848 This value actually specifies a directory in F<share/html/NoAuth/css/>
849 from which RT will try to load the file main.css (which should @import
850 any other files the stylesheet needs). This allows you to easily and
851 cleanly create your own stylesheets to apply to RT. This option can
852 be overridden by users in their preferences.
856 Set($WebDefaultStylesheet, "freeside3");
858 =item C<$DefaultQueue>
860 Use this to select the default queue name that will be used for
861 creating new tickets. You may use either the queue's name or its
862 ID. This only affects the queue selection boxes on the web interface.
866 # Set($DefaultQueue, "General");
868 =item C<$RememberDefaultQueue>
870 When a queue is selected in the new ticket dropdown, make it the new
871 default for the new ticket dropdown.
875 # Set($RememberDefaultQueue, 1);
877 =item C<$EnableReminders>
879 Hide all links and portlets related to Reminders by setting this to 0
883 Set($EnableReminders, 1);
885 =item C<@CustomFieldValuesSources>
887 Set C<@CustomFieldValuesSources> to a list of class names which extend
888 L<RT::CustomFieldValues::External>. This can be used to pull lists of
889 custom field values from external sources at runtime.
893 Set(@CustomFieldValuesSources, ('RT::CustomFieldValues::Queues'));
895 =item C<$CanonicalizeRedirectURLs>
897 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
898 redirecting rather than the one we get from C<%ENV>.
900 Apache's UseCanonicalName directive changes the hostname that RT
901 finds in C<%ENV>. You can read more about what turning it On or Off
902 means in the documentation for your version of Apache.
904 If you use RT behind a reverse proxy, you almost certainly want to
909 Set($CanonicalizeRedirectURLs, 0);
913 A list of JavaScript files to be included in head. Removing any of
914 the default entries is not suggested.
916 If you're a plugin author, refer to RT->AddJavaScript.
923 jquery-ui-1.8.4.custom.min.js
924 jquery-ui-timepicker-addon.js
925 jquery-ui-patch-datepicker.js
930 jquery.event.hover-1.0.js
933 jquery.supposition.js
940 Path to the jsmin binary; if specified, it will be used to minify
941 C<JSFiles>. The default, and the fallback if the binary cannot be
942 found, is to simply concatenate the files.
944 jsmin can be installed by running 'make jsmin' from the RT install
945 directory, or from http://www.crockford.com/javascript/jsmin.html
949 # Set($JSMinPath, "/path/to/jsmin");
953 A list of additional CSS files to be included in head.
955 If you're a plugin author, refer to RT->AddStyleSheets.
959 Set(@CSSFiles, qw//);
961 =item C<$UsernameFormat>
963 This determines how user info is displayed. 'concise' will show one of
964 either NickName, RealName, Name or EmailAddress, depending on what
965 exists and whether the user is privileged or not. 'verbose' will show
966 RealName and EmailAddress.
970 Set($UsernameFormat, "verbose");
972 =item C<$WebBaseURL>, C<$WebURL>
974 Usually you don't want to set these options. The only obvious reason
975 is if RT is accessible via https protocol on a non standard port, e.g.
976 'https://rt.example.com:9999'. In all other cases these options are
977 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
979 C<$WebBaseURL> is the scheme, server and port
980 (e.g. 'http://rt.example.com') for constructing URLs to the web
981 UI. C<$WebBaseURL> doesn't need a trailing /.
983 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
984 example: 'http://www.example.com/rt/'.
988 my $port = RT->Config->Get('WebPort');
990 ($port == 443? 'https': 'http') .'://'
991 . RT->Config->Get('WebDomain')
992 . ($port != 80 && $port != 443? ":$port" : '')
995 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
997 =item C<$WebImagesURL>
999 C<$WebImagesURL> points to the base URL where RT can find its images.
1000 Define the directory name to be used for images in RT web documents.
1004 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
1008 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
1009 This can also be configured via the web UI.
1013 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
1015 =item C<$LogoLinkURL>
1017 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
1021 Set($LogoLinkURL, "http://bestpractical.com");
1023 =item C<$LogoAltText>
1025 C<$LogoAltText> is a string of text for the alt-text of the logo. It
1026 will be passed through C<loc> for localization.
1030 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1032 =item C<$LogoImageHeight>
1034 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1039 Set($LogoImageHeight, 38);
1041 =item C<$LogoImageWidth>
1043 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1048 Set($LogoImageWidth, 181);
1050 =item C<$WebNoAuthRegex>
1052 What portion of RT's URL space should not require authentication. The
1053 default is almost certainly correct, and should only be changed if you
1058 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1060 =item C<$SelfServiceRegex>
1062 What portion of RT's URLspace should be accessible to Unprivileged
1063 users This does not override the redirect from F</Ticket/Display.html>
1064 to F</SelfService/Display.html> when Unprivileged users attempt to
1065 access ticked displays.
1069 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1071 =item C<$WebFlushDbCacheEveryRequest>
1073 By default, RT clears its database cache after every page view. This
1074 ensures that you've always got the most current information when
1075 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1076 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1077 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1081 Set($WebFlushDbCacheEveryRequest, 1);
1085 The L<GD> module (which RT uses for graphs) ships with a built-in font
1086 that doesn't have full Unicode support. You can use a given TrueType
1087 font for a specific language by setting %ChartFont to (language =E<gt>
1088 the absolute path of a font) pairs. Your GD library must have support
1089 for TrueType fonts to use this option. If there is no entry for a
1090 language in the hash then font with 'others' key is used.
1092 RT comes with two TrueType fonts covering most available languages.
1098 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1099 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1100 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1101 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1104 =item C<$ChartsTimezonesInDB>
1106 RT stores dates using the UTC timezone in the DB, so charts grouped by
1107 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1108 to enable timezone conversions using your DB's capabilities. You may
1109 need to do some work on the DB side to use this feature, read more in
1110 F<docs/customizing/timezones_in_charts.pod>.
1112 At this time, this feature only applies to MySQL and PostgreSQL.
1116 Set($ChartsTimezonesInDB, 0);
1126 =item C<$DefaultSummaryRows>
1128 C<$DefaultSummaryRows> is default number of rows displayed in for
1129 search results on the front page.
1133 Set($DefaultSummaryRows, 10);
1135 =item C<$HomePageRefreshInterval>
1137 C<$HomePageRefreshInterval> is default number of seconds to refresh
1138 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1142 Set($HomePageRefreshInterval, 0);
1144 =item C<$HomepageComponents>
1146 C<$HomepageComponents> is an arrayref of allowed components on a
1147 user's customized homepage ("RT at a glance").
1152 $HomepageComponents,
1154 qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches ) # loc_qw
1163 =head2 Ticket search
1167 =item C<$UseSQLForACLChecks>
1169 Historically, ACLs were checked on display, which could lead to empty
1170 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1171 to limit search results in SQL instead, which eliminates these
1174 This option is still relatively new; it may result in performance
1175 problems in some cases, or significant speedups in others.
1179 Set($UseSQLForACLChecks, undef);
1181 =item C<$TicketsItemMapSize>
1183 On the display page of a ticket from search results, RT provides links
1184 to the first, next, previous and last ticket from the results. In
1185 order to build these links, RT needs to fetch the full result set from
1186 the database, which can be resource-intensive.
1188 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1189 to build these links. If the full result set is larger than this
1190 number, RT will omit the "last" link in the menu. Set this to zero to
1191 always examine all results.
1195 Set($TicketsItemMapSize, 1000);
1197 =item C<$SearchResultsRefreshInterval>
1199 C<$SearchResultsRefreshInterval> is default number of seconds to
1200 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1205 Set($SearchResultsRefreshInterval, 0);
1207 =item C<$DefaultSearchResultFormat>
1209 C<$DefaultSearchResultFormat> is the default format for RT search
1214 Set ($DefaultSearchResultFormat, qq{
1215 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1216 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1224 '<small>__Requestors__</small>',
1225 '<small>__CustomerTags__</small>',
1226 '<small>__CreatedRelative__</small>',
1227 '<small>__ToldRelative__</small>',
1228 '<small>__LastUpdatedRelative__</small>',
1229 '<small>__TimeLeft__</small>'});
1231 =item C<$DefaultSelfServiceSearchResultFormat>
1233 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1234 searches displayed in the SelfService interface.
1238 Set($DefaultSelfServiceSearchResultFormat, qq{
1239 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1240 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1245 =item C<%FullTextSearch>
1247 Full text search (FTS) without database indexing is a very slow
1248 operation, and is thus disabled by default.
1250 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1251 the full details of FTS on your particular database.
1253 It is possible to enable FTS without database indexing support, simply
1254 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1255 This is not generally suggested, as unindexed full-text searching can
1256 cause severe performance problems.
1260 Set(%FullTextSearch,
1265 =item C<$DontSearchFileAttachments>
1267 If C<$DontSearchFileAttachments> is set to 1, then uploaded files
1268 (attachments with file names) are not searched during content
1271 Note that if you use indexed FTS then named attachments are still
1272 indexed by default regardless of this option.
1276 Set($DontSearchFileAttachments, undef);
1278 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1280 When query in simple search doesn't have status info, use this to only
1285 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1287 =item C<$SearchResultsAutoRedirect>
1289 When only one ticket is found in search, use this to redirect to the
1290 ticket display page automatically.
1294 Set($SearchResultsAutoRedirect, 0);
1300 =head2 Ticket display
1304 =item C<$ShowMoreAboutPrivilegedUsers>
1306 This determines if the 'More about requestor' box on
1307 Ticket/Display.html is shown for Privileged Users.
1311 Set($ShowMoreAboutPrivilegedUsers, 0);
1313 =item C<$MoreAboutRequestorTicketList>
1315 This can be set to Active, Inactive, All or None. It controls what
1316 ticket list will be displayed in the 'More about requestor' box on
1317 Ticket/Display.html. This option can be controlled by users also.
1321 Set($MoreAboutRequestorTicketList, "Active");
1323 =item C<$MoreAboutRequestorExtraInfo>
1325 By default, the 'More about requestor' box on Ticket/Display.html
1326 shows the Requestor's name and ticket list. If you would like to see
1327 extra information about the user, this expects a Format string of user
1328 attributes. Please note that not all the attributes are supported in
1329 this display because we're not building a table.
1332 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1336 Set($MoreAboutRequestorExtraInfo, "");
1338 =item C<$MoreAboutRequestorGroupsLimit>
1340 By default, the 'More about requestor' box on Ticket/Display.html
1341 shows all the groups of the Requestor. Use this to limit the number
1342 of groups; a value of undef removes the group display entirely.
1346 Set($MoreAboutRequestorGroupsLimit, 0);
1348 =item C<$UseSideBySideLayout>
1350 Should the ticket create and update forms use a more space efficient
1351 two column layout. This layout may not work in narrow browsers if you
1352 set a MessageBoxWidth (below).
1356 Set($UseSideBySideLayout, 1);
1358 =item C<$EditCustomFieldsSingleColumn>
1360 When displaying a list of Ticket Custom Fields for editing, RT
1361 defaults to a 2 column list. If you set this to 1, it will instead
1362 display the Custom Fields in a single column.
1366 Set($EditCustomFieldsSingleColumn, 0);
1368 =item C<$ShowUnreadMessageNotifications>
1370 If set to 1, RT will prompt users when there are new,
1371 unread messages on tickets they are viewing.
1375 Set($ShowUnreadMessageNotifications, 0);
1377 =item C<$AutocompleteOwners>
1379 If set to 1, the owner drop-downs for ticket update/modify and the query
1380 builder are replaced by text fields that autocomplete. This can
1381 alleviate the sometimes huge owner list for installations where many
1382 users have the OwnTicket right.
1386 Set($AutocompleteOwners, 0);
1388 =item C<$AutocompleteOwnersForSearch>
1390 If set to 1, the owner drop-downs for the query builder are always
1391 replaced by text field that autocomplete and C<$AutocompleteOwners>
1392 is ignored. Helpful when owners list is huge in the query builder.
1396 Set($AutocompleteOwnersForSearch, 0);
1398 =item C<$UserAutocompleteFields>
1400 Specifies which fields of L<RT::User> to match against and how to
1401 match each field when autocompleting users. Valid match methods are
1402 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1406 Set($UserAutocompleteFields, {
1407 EmailAddress => 'STARTSWITH',
1408 Name => 'STARTSWITH',
1412 =item C<$AllowUserAutocompleteForUnprivileged>
1414 Should unprivileged users be allowed to autocomplete users. Setting
1415 this option to 1 means unprivileged users will be able to search all
1420 Set($AllowUserAutocompleteForUnprivileged, 0);
1422 =item C<$DisplayTicketAfterQuickCreate>
1424 Enable this to redirect to the created ticket display page
1425 automatically when using QuickCreate.
1429 Set($DisplayTicketAfterQuickCreate, 0);
1431 =item C<$WikiImplicitLinks>
1433 Support implicit links in WikiText custom fields? Setting this to 1
1434 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1435 become links to searches for those words. If used on Articles, it links
1436 to the Article with that name.
1440 Set($WikiImplicitLinks, 0);
1442 =item C<$PreviewScripMessages>
1444 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1445 reply page should include the content of the messages to be sent.
1449 Set($PreviewScripMessages, 0);
1451 =item C<$SimplifiedRecipients>
1453 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1454 B<any> kind of mail will be shown on the ticket reply page, instead of a
1455 detailed breakdown by scrip.
1459 Set($SimplifiedRecipients, 0);
1461 =item C<$HideResolveActionsWithDependencies>
1463 If set to 1, this option will skip ticket menu actions which can't be
1464 completed successfully because of outstanding active Depends On tickets.
1466 By default, all ticket actions are displayed in the menu even if some of
1467 them can't be successful until all Depends On links are resolved or
1468 transitioned to another inactive status.
1472 Set($HideResolveActionsWithDependencies, 0);
1482 =item C<$ArticleOnTicketCreate>
1484 Set this to 1 to display the Articles interface on the Ticket Create
1485 page in addition to the Reply/Comment page.
1489 Set($ArticleOnTicketCreate, 0);
1491 =item C<$HideArticleSearchOnReplyCreate>
1493 Set this to 1 to hide the search and include boxes from the Article
1494 UI. This assumes you have enabled Article Hotlist feature, otherwise
1495 you will have no access to Articles.
1499 Set($HideArticleSearchOnReplyCreate, 0);
1505 =head2 Message box properties
1509 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1511 For message boxes, set the entry box width, height and what type of
1512 wrapping to use. These options can be overridden by users in their
1515 When the width is set to undef, no column count is specified and the
1516 message box will take up 100% of the available width. Combining this
1517 with HARD messagebox wrapping (below) is not recommended, as it will
1518 lead to inconsistent width in transactions between browsers.
1520 These settings only apply to the non-RichText message box. See below
1521 for Rich Text settings.
1525 Set($MessageBoxWidth, undef);
1526 Set($MessageBoxHeight, 15);
1528 =item C<$MessageBoxWrap>
1530 Wrapping is disabled when using MessageBoxRichText because of a bad
1531 interaction between IE and wrapping with the Rich Text Editor.
1535 Set($MessageBoxWrap, "SOFT");
1537 =item C<$MessageBoxRichText>
1539 Should "rich text" editing be enabled? This option lets your users
1540 send HTML email messages from the web interface.
1544 Set($MessageBoxRichText, 1);
1546 =item C<$MessageBoxRichTextHeight>
1548 Height of rich text JavaScript enabled editing boxes (in pixels)
1552 Set($MessageBoxRichTextHeight, 200);
1554 =item C<$MessageBoxIncludeSignature>
1556 Should your users' signatures (from their Preferences page) be
1557 included in Comments and Replies.
1561 Set($MessageBoxIncludeSignature, 1);
1563 =item C<$MessageBoxIncludeSignatureOnComment>
1565 Should your users' signatures (from their Preferences page) be
1566 included in Comments. Setting this to false overrides
1567 C<$MessageBoxIncludeSignature>.
1571 Set($MessageBoxIncludeSignatureOnComment, 1);
1576 =head2 Transaction display
1580 =item C<$OldestTransactionsFirst>
1582 By default, RT shows newest transactions at the bottom of the ticket
1583 history page, if you want see them at the top set this to 0. This
1584 option can be overridden by users in their preferences.
1588 Set($OldestTransactionsFirst, 1);
1590 =item C<$DeferTransactionLoading>
1592 When set, defers loading ticket history until the user clicks a link.
1593 This should end up serving pages to users quicker, since generating
1594 all the HTML for transaction history can be slow for long tickets.
1598 # Set($DeferTransactionLoading, 1);
1600 =item C<$ShowBccHeader>
1602 By default, RT hides from the web UI information about blind copies
1603 user sent on reply or comment.
1607 Set($ShowBccHeader, 0);
1609 =item C<$TrustHTMLAttachments>
1611 If C<TrustHTMLAttachments> is not defined, we will display them as
1612 text. This prevents malicious HTML and JavaScript from being sent in a
1613 request (although there is probably more to it than that)
1617 Set($TrustHTMLAttachments, undef);
1619 =item C<$AlwaysDownloadAttachments>
1621 Always download attachments, regardless of content type. If set, this
1622 overrides C<TrustHTMLAttachments>.
1626 Set($AlwaysDownloadAttachments, undef);
1628 =item C<$AttachmentUnits>
1630 Controls the units (kilobytes or bytes) that attachment sizes use for
1631 display. The default is to display kilobytes if the attachment is
1632 larger than 1024 bytes, bytes otherwise. If you set
1633 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1634 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1638 Set($AttachmentUnits, undef);
1640 =item C<$PreferRichText>
1642 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1643 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1644 show only a minimal subset of HTML to avoid possible contamination by
1645 cross-site-scripting attacks.
1649 Set($PreferRichText, undef);
1651 =item C<$MaxInlineBody>
1653 C<$MaxInlineBody> is the maximum attachment size that we want to see
1654 inline when viewing a transaction. RT will inline any text if the
1655 value is undefined or 0. This option can be overridden by users in
1660 Set($MaxInlineBody, 12000);
1662 =item C<$ShowTransactionImages>
1664 By default, RT shows images attached to incoming (and outgoing) ticket
1665 updates inline. Set this variable to 0 if you'd like to disable that
1670 Set($ShowTransactionImages, 1);
1672 =item C<$PlainTextPre>
1674 Normally plaintext attachments are displayed as HTML with line breaks
1675 preserved. This causes space- and tab-based formatting not to be
1676 displayed correctly. By setting $PlainTextPre messages will be
1677 displayed using <pre>.
1681 Set($PlainTextPre, 0);
1684 =item C<$PlainTextMono>
1686 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1687 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1688 of the browser window; this option overrides C<$PlainTextPre>.
1692 Set($PlainTextMono, 0);
1694 =item C<$SuppressInlineTextFiles>
1696 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1697 (text-type attachments with file names) are prevented from being
1698 displayed in-line when viewing a ticket's history.
1702 Set($SuppressInlineTextFiles, undef);
1705 =item C<@Active_MakeClicky>
1707 MakeClicky detects various formats of data in headers and email
1708 messages, and extends them with supporting links. By default, RT
1709 provides two formats:
1711 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1714 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1715 replaces the URL with a link.
1717 See F<share/html/Elements/MakeClicky> for documentation on how to add
1718 your own styles of link detection.
1722 Set(@Active_MakeClicky, qw());
1728 =head1 Application logic
1732 =item C<$ParseNewMessageForTicketCcs>
1734 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1735 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1736 messages. Be forewarned that if you have I<any> addresses which forward
1737 mail to RT automatically and you enable this option without modifying
1738 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1742 Set($ParseNewMessageForTicketCcs, undef);
1744 =item C<$UseTransactionBatch>
1746 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1747 such that a resolve and comment (for example) would happen
1748 simultaneously, instead of as two transactions, unaware of each
1753 Set($UseTransactionBatch, 1);
1755 =item C<$StrictLinkACL>
1757 When this feature is enabled a user needs I<ModifyTicket> rights on
1758 both tickets to link them together; otherwise, I<ModifyTicket> rights
1759 on either of them is sufficient.
1763 Set($StrictLinkACL, 1);
1765 =item C<$RedistributeAutoGeneratedMessages>
1767 Should RT redistribute correspondence that it identifies as machine
1768 generated? A 1 will do so; setting this to 0 will cause no
1769 such messages to be redistributed. You can also use 'privileged' (the
1770 default), which will redistribute only to privileged users. This helps
1771 to protect against malformed bounces and loops caused by auto-created
1772 requestors with bogus addresses.
1776 Set($RedistributeAutoGeneratedMessages, "privileged");
1778 =item C<$ApprovalRejectionNotes>
1780 Should rejection notes from approvals be sent to the requestors?
1784 Set($ApprovalRejectionNotes, 1);
1786 =item C<$ForceApprovalsView>
1788 Should approval tickets only be viewed and modified through the standard
1789 approval interface? Changing this setting to 1 will redirect any attempt to
1790 use the normal ticket display and modify page for approval tickets.
1792 For example, with this option set to 1 and an approval ticket #123:
1794 /Ticket/Display.html?id=123
1798 /Approval/Display.html?id=123
1804 Set($ForceApprovalsView, 0);
1806 =head1 Extra security
1808 This is a list of extra security measures to enable that help keep your RT
1809 safe. If you don't know what these mean, you should almost certainly leave the
1814 =item C<$DisallowExecuteCode>
1816 If set to a true value, the C<ExecuteCode> right will be removed from
1817 all users, B<including> the superuser. This is intended for when RT is
1818 installed into a shared environment where even the superuser should not
1819 be allowed to run arbitrary Perl code on the server via scrips.
1823 Set($DisallowExecuteCode, 0);
1825 =item C<$Framebusting>
1827 If set to a false value, framekiller javascript will be disabled and the
1828 X-Frame-Options: DENY header will be suppressed from all responses.
1829 This disables RT's clickjacking protection.
1833 Set($Framebusting, 1);
1835 =item C<$RestrictReferrer>
1837 If set to a false value, the HTTP C<Referer> (sic) header will not be
1838 checked to ensure that requests come from RT's own domain. As RT allows
1839 for GET requests to alter state, disabling this opens RT up to
1840 cross-site request forgery (CSRF) attacks.
1844 Set($RestrictReferrer, 1);
1846 =item C<$RestrictLoginReferrer>
1848 If set to a false value, RT will allow the user to log in from any link
1849 or request, merely by passing in C<user> and C<pass> parameters; setting
1850 it to a true value forces all logins to come from the login box, so the
1851 user is aware that they are being logged in. The default is off, for
1852 backwards compatability.
1856 Set($RestrictLoginReferrer, 0);
1858 =item C<@ReferrerWhitelist>
1860 This is a list of hostname:port combinations that RT will treat as being
1861 part of RT's domain. This is particularly useful if you access RT as
1862 multiple hostnames or have an external auth system that needs to
1863 redirect back to RT once authentication is complete.
1865 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1867 If the "RT has detected a possible cross-site request forgery" error is triggered
1868 by a host:port sent by your browser that you believe should be valid, you can copy
1869 the host:port from the error message into this list.
1871 Simple wildcards, similar to SSL certificates, are allowed. For example:
1873 *.example.com:80 # matches foo.example.com
1874 # but not example.com
1875 # or foo.bar.example.com
1877 www*.example.com:80 # matches www3.example.com
1878 # and www-test.example.com
1879 # and www.example.com
1883 Set(@ReferrerWhitelist, qw());
1889 =head1 Authorization and user configuration
1893 =item C<$WebExternalAuth>
1895 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1896 REMOTE_USER variable.
1900 Set($WebExternalAuth, undef);
1902 =item C<$WebExternalAuthContinuous>
1904 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1905 REMOTE_USER on each access. If you would prefer this to only happen
1906 once (at initial login) set this to a false value. The default
1907 setting will help ensure that if your external authentication system
1908 deauthenticates a user, RT notices as soon as possible.
1912 Set($WebExternalAuthContinuous, 1);
1914 =item C<$WebFallbackToInternalAuth>
1916 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1917 chance of fallback to the login screen, even if REMOTE_USER failed.
1921 Set($WebFallbackToInternalAuth, undef);
1923 =item C<$WebExternalGecos>
1925 C<$WebExternalGecos> means to match 'gecos' field as the user
1926 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1931 Set($WebExternalGecos, undef);
1933 =item C<$WebExternalAuto>
1935 C<$WebExternalAuto> will create users under the same name as
1936 REMOTE_USER upon login, if it's missing in the Users table.
1940 Set($WebExternalAuto, undef);
1942 =item C<$AutoCreate>
1944 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1945 User's Create method. Use it to set defaults, such as creating
1946 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1950 Set($AutoCreate, undef);
1952 =item C<$WebSessionClass>
1954 C<$WebSessionClass> is the class you wish to use for managing sessions.
1955 It defaults to use your SQL database, except on Oracle, where it
1956 defaults to files on disk.
1960 # Set($WebSessionClass, "Apache::Session::File");
1962 =item C<$AutoLogoff>
1964 By default, RT's user sessions persist until a user closes his or her
1965 browser. With the C<$AutoLogoff> option you can setup session lifetime
1966 in minutes. A user will be logged out if he or she doesn't send any
1967 requests to RT for the defined time.
1971 Set($AutoLogoff, 0);
1973 =item C<$LogoutRefresh>
1975 The number of seconds to wait after logout before sending the user to
1976 the login page. By default, 1 second, though you may want to increase
1977 this if you display additional information on the logout page.
1981 Set($LogoutRefresh, 1);
1983 =item C<$WebSecureCookies>
1985 By default, RT's session cookie isn't marked as "secure". Some web
1986 browsers will treat secure cookies more carefully than non-secure
1987 ones, being careful not to write them to disk, only sending them over
1988 an SSL secured connection, and so on. To enable this behavior, set
1989 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1990 on I<unless> users are only connecting via SSL encrypted HTTPS
1995 Set($WebSecureCookies, 0);
1997 =item C<$WebHttpOnlyCookies>
1999 Default RT's session cookie to not being directly accessible to
2000 javascript. The content is still sent during regular and AJAX requests,
2001 and other cookies are unaffected, but the session-id is less
2002 programmatically accessible to javascript. Turning this off should only
2003 be necessary in situations with odd client-side authentication
2008 Set($WebHttpOnlyCookies, 1);
2010 =item C<$MinimumPasswordLength>
2012 C<$MinimumPasswordLength> defines the minimum length for user
2013 passwords. Setting it to 0 disables this check.
2017 Set($MinimumPasswordLength, 5);
2022 =head1 Internationalization
2026 =item C<@LexiconLanguages>
2028 An array that contains languages supported by RT's
2029 internationalization interface. Defaults to all *.po lexicons;
2030 setting it to C<qw(en ja)> will make RT bilingual instead of
2031 multilingual, but will save some memory.
2035 Set(@LexiconLanguages, qw(*));
2037 =item C<@EmailInputEncodings>
2039 An array that contains default encodings used to guess which charset
2040 an attachment uses, if it does not specify one explicitly. All
2041 options must be recognized by L<Encode::Guess>. The first element may
2042 also be '*', which enables encoding detection using
2043 L<Encode::Detect::Detector>, if installed.
2047 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
2049 =item C<$EmailOutputEncoding>
2051 The charset for localized email. Must be recognized by Encode.
2055 Set($EmailOutputEncoding, "utf-8");
2065 =head1 Date and time handling
2069 =item C<$DateTimeFormat>
2071 You can choose date and time format. See the "Output formatters"
2072 section in perldoc F<lib/RT/Date.pm> for more options. This option
2073 can be overridden by users in their preferences.
2077 C<Set($DateTimeFormat, "LocalizedDateTime");>
2078 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2079 C<Set($DateTimeFormat, "RFC2822");>
2080 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2084 Set($DateTimeFormat, "DefaultFormat");
2086 # Next two options are for Time::ParseDate
2088 =item C<$DateDayBeforeMonth>
2090 Set this to 1 if your local date convention looks like "dd/mm/yy"
2091 instead of "mm/dd/yy". Used only for parsing, not for displaying
2096 Set($DateDayBeforeMonth, 1);
2098 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2100 Should an unspecified day or year in a date refer to a future or a
2101 past value? For example, should a date of "Tuesday" default to mean
2102 the date for next Tuesday or last Tuesday? Should the date "March 1"
2103 default to the date for next March or last March?
2105 Set C<$AmbiguousDayInPast> for the last date, or
2106 C<$AmbiguousDayInFuture> for the next date; the default is usually
2107 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2111 Set($AmbiguousDayInPast, 0);
2112 Set($AmbiguousDayInFuture, 0);
2114 =item C<$DefaultTimeUnitsToHours>
2116 Use this to set the default units for time entry to hours instead of
2117 minutes. Note that this only effects entry, not display.
2121 Set($DefaultTimeUnitsToHours, 0);
2123 =item C<$SimpleSearchIncludeResolved>
2125 By default, the simple ticket search in the top bar excludes "resolved" tickets
2126 unless a status argument is specified. Set this to a true value to include
2131 Set($SimpleSearchIncludeResolved, 0);
2138 =head1 GnuPG integration
2140 A full description of the (somewhat extensive) GnuPG integration can
2141 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2142 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2148 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2149 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2151 If you want to allow people to encrypt attachments inside the DB then
2152 set C<AllowEncryptDataInDB> to 1.
2154 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2155 emails encrypted for key RT doesn't have and can not decrypt.
2157 Set C<RejectOnBadData> to false if you don't want to reject letters
2158 with incorrect GnuPG data.
2164 OutgoingMessagesFormat => "RFC", # Inline
2165 AllowEncryptDataInDB => 0,
2167 RejectOnMissingPrivateKey => 1,
2168 RejectOnBadData => 1,
2171 =item C<%GnuPGOptions>
2173 Options to pass to the GnuPG program.
2175 If you override this in your RT_SiteConfig, you should be sure to
2176 include a homedir setting.
2178 Note that options with '-' character MUST be quoted.
2183 homedir => q{@RT_VAR_PATH@/data/gpg},
2185 # URL of a keyserver
2186 # keyserver => 'hkp://subkeys.pgp.net',
2188 # enables the automatic retrieving of keys when encrypting
2189 # 'auto-key-locate' => 'keyserver',
2191 # enables the automatic retrieving of keys when verifying signatures
2192 # 'auto-key-retrieve' => undef,
2201 =head2 Lifecycle definitions
2203 Each lifecycle is a list of possible statuses split into three logic
2204 sets: B<initial>, B<active> and B<inactive>. Each status in a
2205 lifecycle must be unique. (Statuses may not be repeated across sets.)
2206 Each set may have any number of statuses.
2212 active => ['open', 'stalled'],
2213 inactive => ['resolved', 'rejected', 'deleted'],
2217 Status names can be from 1 to 64 ASCII characters. Statuses are
2218 localized using RT's standard internationalization and localization
2225 You can define multiple B<initial> statuses for tickets in a given
2228 RT will automatically set its B<Started> date when you change a
2229 ticket's status from an B<initial> state to an B<active> or
2234 B<Active> tickets are "currently in play" - they're things that are
2235 being worked on and not yet complete.
2239 B<Inactive> tickets are typically in their "final resting state".
2241 While you're free to implement a workflow that ignores that
2242 description, typically once a ticket enters an inactive state, it will
2243 never again enter an active state.
2245 RT will automatically set the B<Resolved> date when a ticket's status
2246 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2249 B<deleted> is still a special status and protected by the
2250 B<DeleteTicket> right, unless you re-defined rights (read below). If
2251 you don't want to allow ticket deletion at any time simply don't
2252 include it in your lifecycle.
2256 Statuses in each set are ordered and listed in the UI in the defined
2259 Changes between statuses are constrained by transition rules, as
2262 =head2 Default values
2264 In some cases a default value is used to display in UI or in API when
2265 value is not provided. You can configure defaults using the following
2272 on_resolve => 'resolved',
2277 The following defaults are used.
2283 If you (or your code) doesn't specify a status when creating a ticket,
2284 RT will use the this status. See also L</Statuses available during
2289 When tickets are merged, the status of the ticket that was merged
2290 away is forced to this value. It should be one of inactive statuses;
2291 'resolved' or its equivalent is most probably the best candidate.
2295 When an approval is accepted, the status of depending tickets will
2296 be changed to this value.
2300 When an approval is denied, the status of depending tickets will
2301 be changed to this value.
2303 =item reminder_on_open
2305 When a reminder is opened, the status will be changed to this value.
2307 =item reminder_on_resolve
2309 When a reminder is resolved, the status will be changed to this value.
2313 =head2 Transitions between statuses and UI actions
2315 A B<Transition> is a change of status from A to B. You should define
2316 all possible transitions in each lifecycle using the following format:
2321 '' => [qw(new open resolved)],
2322 new => [qw(open resolved rejected deleted)],
2323 open => [qw(stalled resolved rejected deleted)],
2324 stalled => [qw(open)],
2325 resolved => [qw(open)],
2326 rejected => [qw(open)],
2327 deleted => [qw(open)],
2332 =head3 Statuses available during ticket creation
2334 By default users can create tickets with a status of new,
2335 open, or resolved, but cannot create tickets with a status of
2336 rejected, stalled, or deleted. If you want to change the statuses
2337 available during creation, update the transition from '' (empty
2338 string), like in the example above.
2340 =head3 Protecting status changes with rights
2342 A transition or group of transitions can be protected by a specific
2343 right. Additionally, you can name new right names, which will be added
2344 to the system to control that transition. For example, if you wished to
2345 create a lesser right than ModifyTicket for rejecting tickets, you could
2351 '* -> deleted' => 'DeleteTicket',
2352 '* -> rejected' => 'RejectTicket',
2353 '* -> *' => 'ModifyTicket',
2358 This would create a new C<RejectTicket> right in the system which you
2359 could assign to whatever groups you choose.
2361 On the left hand side you can have the following variants:
2368 Valid transitions are listed in order of priority. If a user attempts
2369 to change a ticket's status from B<new> to B<open> then the lifecycle
2370 is checked for presence of an exact match, then for 'any to B<open>',
2371 'B<new> to any' and finally 'any to any'.
2373 If you don't define any rights, or there is no match for a transition,
2374 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2376 =head3 Labeling and defining actions
2378 For each transition you can define an action that will be shown in the
2379 UI; each action annotated with a label and an update type.
2381 Each action may provide a default update type, which can be
2382 B<Comment>, B<Respond>, or absent. For example, you may want your
2383 staff to write a reply to the end user when they change status from
2384 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2385 B<Comment> nor B<Respond> are mandatory, and user may leave the
2386 message empty, regardless of the update type.
2388 This configuration can be used to accomplish what
2389 $ResolveDefaultUpdateType was used for in RT 3.8.
2391 Use the following format to define labels and actions of transitions:
2396 'new -> open' => { label => 'Open it', update => 'Respond' },
2397 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2398 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2399 'new -> deleted' => { label => 'Delete' },
2401 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2402 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2403 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2405 'stalled -> open' => { label => 'Open it' },
2406 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2407 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2408 'deleted -> open' => { label => 'Undelete' },
2413 In addition, you may define multiple actions for the same transition.
2414 Alternately, you may use '* -> x' to match more than one transition.
2421 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2422 'new -> rejected' => { label => 'Quick Reject' },
2424 '* -> deleted' => { label => 'Delete' },
2430 =head2 Moving tickets between queues with different lifecycles
2432 Unless there is an explicit mapping between statuses in two different
2433 lifecycles, you can not move tickets between queues with these
2434 lifecycles. This is true even if the different lifecycles use the exact
2435 same set of statuses. Such a mapping is defined as follows:
2438 'from lifecycle -> to lifecycle' => {
2439 'status in left lifecycle' => 'status in right lifecycle',
2449 initial => [ 'new' ],
2450 active => [ 'open', 'stalled' ],
2451 inactive => [ 'resolved', 'rejected', 'deleted' ],
2455 on_merge => 'resolved',
2457 denied => 'rejected',
2458 reminder_on_open => 'open',
2459 reminder_on_resolve => 'resolved',
2463 '' => [qw(new open resolved)],
2465 # from => [ to list ],
2466 new => [qw(open stalled resolved rejected deleted)],
2467 open => [qw(new stalled resolved rejected deleted)],
2468 stalled => [qw(new open rejected resolved deleted)],
2469 resolved => [qw(new open stalled rejected deleted)],
2470 rejected => [qw(new open stalled resolved deleted)],
2471 deleted => [qw(new open stalled rejected resolved)],
2474 '* -> deleted' => 'DeleteTicket',
2475 '* -> *' => 'ModifyTicket',
2479 label => 'Open It', # loc
2480 update => 'Respond',
2482 'new -> resolved' => {
2483 label => 'Resolve', # loc
2484 update => 'Comment',
2486 'new -> rejected' => {
2487 label => 'Reject', # loc
2488 update => 'Respond',
2490 'new -> deleted' => {
2491 label => 'Delete', # loc
2494 'open -> stalled' => {
2495 label => 'Stall', # loc
2496 update => 'Comment',
2498 'open -> resolved' => {
2499 label => 'Resolve', # loc
2500 update => 'Comment',
2502 'open -> rejected' => {
2503 label => 'Reject', # loc
2504 update => 'Respond',
2507 'stalled -> open' => {
2508 label => 'Open It', # loc
2510 'resolved -> open' => {
2511 label => 'Re-open', # loc
2512 update => 'Comment',
2514 'rejected -> open' => {
2515 label => 'Re-open', # loc
2516 update => 'Comment',
2518 'deleted -> open' => {
2519 label => 'Undelete', # loc
2523 # don't change lifecyle of the approvals, they are not capable to deal with
2526 initial => [ 'new' ],
2527 active => [ 'open', 'stalled' ],
2528 inactive => [ 'resolved', 'rejected', 'deleted' ],
2532 on_merge => 'resolved',
2533 reminder_on_open => 'open',
2534 reminder_on_resolve => 'resolved',
2538 '' => [qw(new open resolved)],
2540 # from => [ to list ],
2541 new => [qw(open stalled resolved rejected deleted)],
2542 open => [qw(new stalled resolved rejected deleted)],
2543 stalled => [qw(new open rejected resolved deleted)],
2544 resolved => [qw(new open stalled rejected deleted)],
2545 rejected => [qw(new open stalled resolved deleted)],
2546 deleted => [qw(new open stalled rejected resolved)],
2549 '* -> deleted' => 'DeleteTicket',
2550 '* -> rejected' => 'ModifyTicket',
2551 '* -> *' => 'ModifyTicket',
2555 label => 'Open It', # loc
2556 update => 'Respond',
2558 'new -> resolved' => {
2559 label => 'Resolve', # loc
2560 update => 'Comment',
2562 'new -> rejected' => {
2563 label => 'Reject', # loc
2564 update => 'Respond',
2566 'new -> deleted' => {
2567 label => 'Delete', # loc
2570 'open -> stalled' => {
2571 label => 'Stall', # loc
2572 update => 'Comment',
2574 'open -> resolved' => {
2575 label => 'Resolve', # loc
2576 update => 'Comment',
2578 'open -> rejected' => {
2579 label => 'Reject', # loc
2580 update => 'Respond',
2583 'stalled -> open' => {
2584 label => 'Open It', # loc
2586 'resolved -> open' => {
2587 label => 'Re-open', # loc
2588 update => 'Comment',
2590 'rejected -> open' => {
2591 label => 'Re-open', # loc
2592 update => 'Comment',
2594 'deleted -> open' => {
2595 label => 'Undelete', # loc
2605 =head1 Administrative interface
2609 =item C<$ShowRTPortal>
2611 RT can show administrators a feed of recent RT releases and other
2612 related announcements and information from Best Practical on the top
2613 level Configuration page. This feature helps you stay up to date on
2614 RT security announcements and version updates.
2616 RT provides this feature using an "iframe" on C</Admin/index.html>
2617 which asks the administrator's browser to show an inline page from
2618 Best Practical's website.
2620 If you'd rather not make this feature available to your
2621 administrators, set C<$ShowRTPortal> to a false value.
2625 Set($ShowRTPortal, 1);
2627 =item C<%AdminSearchResultFormat>
2629 In the admin interface, format strings similar to tickets result
2630 formats are used. Use C<%AdminSearchResultFormat> to define the format
2631 strings used in the admin interface on a per-RT-class basis.
2635 Set(%AdminSearchResultFormat,
2637 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2638 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2639 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__,__Lifecycle__},
2642 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2643 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2644 .q{,'__Description__'},
2647 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2648 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2649 .q{,__RealName__, __EmailAddress__},
2652 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2653 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2654 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2657 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2658 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2659 .q{,__Stage__, __Condition__, __Action__, __Template__},
2662 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2663 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2664 .q{,__Stage__, __Condition__, __Action__, __Template__},
2667 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2668 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2669 .q{,'__Description__'},
2671 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2672 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2673 .q{,__Description__},
2681 =head1 Development options
2687 RT comes with a "Development mode" setting. This setting, as a
2688 convenience for developers, turns on several of development options
2689 that you most likely don't want in production:
2695 Disables CSS and JS minification and concatenation. Both CSS and JS
2696 will be instead be served as a number of individual smaller files,
2697 unchanged from how they are stored on disk.
2701 Uses L<Module::Refresh> to reload changed Perl modules on each
2706 Turns off Mason's C<static_source> directive; this causes Mason to
2707 reload template files which have been modified on disk.
2711 Turns on Mason's HTML C<error_format>; this renders compilation errors
2712 to the browser, along with a full stack trace. It is possible for
2713 stack traces to reveal sensitive information such as passwords or
2718 Turns off caching of callbacks; this enables additional callbacks to
2719 be added while the server is running.
2725 Set($DevelMode, "@RT_DEVEL_MODE@");
2728 =item C<$RecordBaseClass>
2730 What abstract base class should RT use for its records. You should
2731 probably never change this.
2733 Valid values are C<DBIx::SearchBuilder::Record> or
2734 C<DBIx::SearchBuilder::Record::Cachable>
2738 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2741 =item C<@MasonParameters>
2743 C<@MasonParameters> is the list of parameters for the constructor of
2744 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2745 debugging, e.g. profiling individual components with:
2747 use MasonX::Profiler; # available on CPAN
2748 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2752 Set(@MasonParameters, ());
2754 =item C<$StatementLog>
2756 RT has rudimentary SQL statement logging support; simply set
2757 C<$StatementLog> to be the level that you wish SQL statements to be
2760 Enabling this option will also expose the SQL Queries page in the
2761 Configuration -> Tools menu for SuperUsers.
2765 Set($StatementLog, undef);
2772 =head1 Deprecated options
2776 =item C<$LinkTransactionsRun1Scrip>
2778 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2779 one transaction and run one scrip. Set this value to 1 if you want
2780 only one of the link transactions to have scrips run.
2784 Set($LinkTransactionsRun1Scrip, 0);
2786 =item C<$ResolveDefaultUpdateType>
2788 This option has been deprecated. You can configure this site-wide
2789 with L</Lifecycles> (see L</Labeling and defining actions>).