2 # RT was configured with:
4 # $ ./configure --enable-layout=Freeside --with-db-type=Pg --with-db-dba=freeside --with-db-database=freeside --with-db-rt-user=freeside --with-db-rt-pass= --with-web-user=freeside --with-web-group=freeside --with-rt-group=freeside --with-web-handler=modperl2
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, "Pg");
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, "localhost");
160 Set($DatabaseRTHost, "localhost");
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, "");
172 =item C<$DatabaseUser>
174 The name of the user to connect to the database as.
178 Set($DatabaseUser, "freeside");
180 =item C<$DatabasePassword>
182 The password the C<$DatabaseUser> should use to access the database.
186 Set($DatabasePassword, q{});
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{freeside});
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{/opt/rt3/var/log});
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.
353 For MySQL and Oracle, we set this size to 10 megabytes. If you're
354 running a PostgreSQL version earlier than 7.1, you will need to drop
360 Set($MaxAttachmentSize, 10_000_000);
362 =item C<$TruncateLongAttachments>
364 If this is set to a non-undef value, RT will truncate attachments
365 longer than C<$MaxAttachmentSize>.
369 Set($TruncateLongAttachments, undef);
371 =item C<$DropLongAttachments>
373 If this is set to a non-undef value, RT will silently drop attachments
374 longer than C<MaxAttachmentSize>. C<$TruncateLongAttachments>, above,
375 takes priority over this.
379 Set($DropLongAttachments, undef);
381 =item C<$RTAddressRegexp>
383 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a
384 ticket CC if C<$ParseNewMessageForTicketCcs>, above, is enabled. It
385 is important that you set this to a regular expression that matches
386 all addresses used by your RT. This lets RT avoid sending mail to
387 itself. It will also hide RT addresses from the list of "One-time Cc"
388 and Bcc lists on ticket reply.
390 If you have a number of addresses configured in your RT database
391 already, you can generate a naive first pass regexp by using:
393 perl etc/upgrade/generate-rtaddressregexp
395 If left blank, RT will generate a regexp for you, based on your
396 comment and correspond address settings on your queues; this comes at
397 a small cost in start-up speed.
401 Set($RTAddressRegexp, undef);
403 =item C<$IgnoreCcRegexp>
405 C<$IgnoreCcRegexp> is a regexp to exclude addresses from automatic addition
406 to the Cc list. Use this for addresses that are I<not> received by RT but
407 are sometimes added to Cc lists by mistake. Unlike C<$RTAddressRegexp>,
408 these addresses can still receive email from RT otherwise.
412 Set($IgnoreCcRegexp, undef);
414 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
416 RT provides functionality which allows the system to rewrite incoming
417 email addresses. In its simplest form, you can substitute the value
418 in C<CanonicalizeEmailAddressReplace> for the value in
419 C<CanonicalizeEmailAddressMatch> (These values are passed to the
420 C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>)
422 By default, that routine performs a C<s/$Match/$Replace/gi> on any
423 address passed to it.
427 # Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$');
428 # Set($CanonicalizeEmailAddressReplace, '@example.com');
430 =item C<$CanonicalizeOnCreate>
432 Set this to 1 and the create new user page will use the values that
433 you enter in the form but use the function CanonicalizeUserInfo in
438 Set($CanonicalizeOnCreate, 0);
440 =item C<$ValidateUserEmailAddresses>
442 If C<$ValidateUserEmailAddresses> is 1, RT will refuse to create
443 users with an invalid email address (as specified in RFC 2822) or with
444 an email address made of multiple email addresses.
448 Set($ValidateUserEmailAddresses, undef);
450 =item C<$NonCustomerEmailRegexp>
452 Normally, when a ticket is linked to a customer, any requestors on that
453 ticket that didn't previously have customer memberships are linked to
454 the customer also. C<$NonCustomerEmailRegexp> is a regexp for email
455 addresses that should I<not> automatically be linked to a customer in
460 Set($NonCustomerEmailRegexp, undef);
462 =item C<@MailPlugins>
464 C<@MailPlugins> is a list of authentication plugins for
465 L<RT::Interface::Email> to use; see L<rt-mailgate>
469 =item C<$UnsafeEmailCommands>
471 C<$UnsafeEmailCommands>, if set to 1, enables 'take' and 'resolve'
472 as possible actions via the mail gateway. As its name implies, this
473 is very unsafe, as it allows email with a forged sender to possibly
474 resolve arbitrary tickets!
478 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
480 The default "extract remote tracking tags" scrip settings; these
481 detect when your RT is talking to another RT, and adjust the subject
486 Set($ExtractSubjectTagMatch, qr/\[.+? #\d+\]/);
487 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
488 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
489 : qr/\[\Q$RT::rtname\E #\d+\]/));
499 =item C<$MailCommand>
501 C<$MailCommand> defines which method RT will use to try to send mail.
502 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
503 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
506 Note that you should remove the '-t' from C<$SendmailArguments> if you
507 use 'sendmail' rather than 'sendmailpipe'
509 For testing purposes, or to simply disable sending mail out into the
510 world, you can set C<$MailCommand> to 'testfile' which writes all mail
511 to a temporary file. RT will log the location of the temporary file
512 so you can extract mail from it afterward.
516 Set($MailCommand, "sendmailpipe");
518 =item C<$SetOutgoingMailFrom>
520 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
521 Correspond mail address of the ticket's queue.
523 Warning: If you use this setting, bounced mails will appear to be
524 incoming mail to the system, thus creating new tickets.
528 Set($SetOutgoingMailFrom, 0);
530 =item C<$OverrideOutgoingMailFrom>
532 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
533 address of the queue as it is handed to sendmail -f. This helps force
534 the From_ header away from www-data or other email addresses that show
535 up in the "Sent by" line in Outlook.
537 The option is a hash reference of queue name to email address. If
538 there is no ticket involved, then the value of the C<Default> key will
541 This option is irrelevant unless C<$SetOutgoingMailFrom> is set.
545 Set($OverrideOutgoingMailFrom, {
546 # 'Default' => 'admin@rt.example.com',
547 # 'General' => 'general@rt.example.com',
550 =item C<$DefaultMailPrecedence>
552 C<$DefaultMailPrecedence> is used to control the default Precedence
553 level of outgoing mail where none is specified. By default it is
554 C<bulk>, but if you only send mail to your staff, you may wish to
557 Note that you can set the precedence of individual templates by
558 including an explicit Precedence header.
560 If you set this value to C<undef> then we do not set a default
561 Precedence header to outgoing mail. However, if there already is a
562 Precedence header, it will be preserved.
566 Set($DefaultMailPrecedence, "bulk");
568 =item C<$DefaultErrorMailPrecedence>
570 C<$DefaultErrorMailPrecedence> is used to control the default
571 Precedence level of outgoing mail that indicates some kind of error
572 condition. By default it is C<bulk>, but if you only send mail to your
573 staff, you may wish to change it.
575 If you set this value to C<undef> then we do not add a Precedence
576 header to error mail.
580 Set($DefaultErrorMailPrecedence, "bulk");
582 =item C<$UseOriginatorHeader>
584 C<$UseOriginatorHeader> is used to control the insertion of an
585 RT-Originator Header in every outgoing mail, containing the mail
586 address of the transaction creator.
590 Set($UseOriginatorHeader, 1);
592 =item C<$UseFriendlyFromLine>
594 By default, RT sets the outgoing mail's "From:" header to "SenderName
595 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
599 Set($UseFriendlyFromLine, 1);
601 =item C<$FriendlyFromLineFormat>
603 C<sprintf()> format of the friendly 'From:' header; its arguments are
604 SenderName and SenderEmailAddress.
608 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
610 =item C<$UseFriendlyToLine>
612 RT can optionally set a "Friendly" 'To:' header when sending messages
613 to Ccs or AdminCcs (rather than having a blank 'To:' header.
615 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
616 are using sendmail, rather than postfix, qmail, exim or some other
617 MTA, you _must_ disable this option.
621 Set($UseFriendlyToLine, 0);
623 =item C<$FriendlyToLineFormat>
625 C<sprintf()> format of the friendly 'To:' header; its arguments are
626 WatcherType and TicketId.
630 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
632 =item C<$NotifyActor>
634 By default, RT doesn't notify the person who performs an update, as
635 they already know what they've done. If you'd like to change this
636 behavior, Set C<$NotifyActor> to 1
640 Set($NotifyActor, 0);
642 =item C<$RecordOutgoingEmail>
644 By default, RT records each message it sends out to its own internal
645 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
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");
740 =item C<$SendmailBounceArguments>
742 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
743 assuming RT needs to send an error (i.e. bounce).
747 Set($SendmailBounceArguments, '-f "<>"');
749 =item C<$SendmailPath>
751 If you selected 'sendmailpipe' above, you MUST specify the path to
752 your sendmail binary in C<$SendmailPath>.
756 Set($SendmailPath, "/usr/sbin/sendmail");
761 =head2 SMTP configuration
763 These options only take effect if C<$MailCommand> is 'smtp'
769 C<$SMTPServer> should be set to the hostname of the SMTP server to use
773 Set($SMTPServer, undef);
777 C<$SMTPFrom> should be set to the 'From' address to use, if not the
782 Set($SMTPFrom, undef);
786 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
800 C<@MailParams> defines a list of options passed to $MailCommand if it
801 is not 'sendmailpipe', 'sendmail', or 'smtp'
805 Set(@MailParams, ());
814 =item C<$WebDefaultStylesheet>
816 This determines the default stylesheet the RT web interface will use.
817 RT ships with several themes by default:
819 web2 The default layout for RT 3.8
820 aileron The default layout for RT 4.0
821 ballard Theme which doesn't rely on JavaScript for menuing
823 This bundled distibution of RT also includes:
824 freeside3 Integration with Freeside (enabled by default)
825 freeside2.1 Previous Freeside theme
827 This value actually specifies a directory in F<share/html/NoAuth/css/>
828 from which RT will try to load the file main.css (which should @import
829 any other files the stylesheet needs). This allows you to easily and
830 cleanly create your own stylesheets to apply to RT. This option can
831 be overridden by users in their preferences.
835 Set($WebDefaultStylesheet, "freeside3");
837 =item C<$DefaultQueue>
839 Use this to select the default queue name that will be used for
840 creating new tickets. You may use either the queue's name or its
841 ID. This only affects the queue selection boxes on the web interface.
845 # Set($DefaultQueue, "General");
847 =item C<$RememberDefaultQueue>
849 When a queue is selected in the new ticket dropdown, make it the new
850 default for the new ticket dropdown.
854 # Set($RememberDefaultQueue, 1);
856 =item C<$EnableReminders>
858 Hide all links and portlets related to Reminders by setting this to 0
862 Set($EnableReminders, 1);
864 =item C<@CustomFieldValuesSources>
866 Set C<@CustomFieldValuesSources> to a list of class names which extend
867 L<RT::CustomFieldValues::External>. This can be used to pull lists of
868 custom field values from external sources at runtime.
872 Set(@CustomFieldValuesSources, ('RT::CustomFieldValues::Queues'));
874 =item C<$CanonicalizeRedirectURLs>
876 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
877 redirecting rather than the one we get from C<%ENV>.
879 Apache's UseCanonicalName directive changes the hostname that RT
880 finds in C<%ENV>. You can read more about what turning it On or Off
881 means in the documentation for your version of Apache.
883 If you use RT behind a reverse proxy, you almost certainly want to
888 Set($CanonicalizeRedirectURLs, 0);
892 A list of JavaScript files to be included in head. Removing any of
893 the default entries is not suggested.
900 jquery-ui-1.8.4.custom.min.js
901 jquery-ui-patch-datepicker.js
906 jquery.event.hover-1.0.js
909 jquery.supposition.js
916 Path to the jsmin binary; if specified, it will be used to minify
917 C<JSFiles>. The default, and the fallback if the binary cannot be
918 found, is to simply concatenate the files.
920 jsmin can be installed by running 'make jsmin' from the RT install
921 directory, or from http://www.crockford.com/javascript/jsmin.html
925 # Set($JSMinPath, "/path/to/jsmin");
929 A list of additional CSS files to be included in head.
933 Set(@CSSFiles, qw//);
935 =item C<$UsernameFormat>
937 This determines how user info is displayed. 'concise' will show one of
938 either NickName, RealName, Name or EmailAddress, depending on what
939 exists and whether the user is privileged or not. 'verbose' will show
940 RealName and EmailAddress.
944 Set($UsernameFormat, "verbose");
946 =item C<$WebBaseURL>, C<$WebURL>
948 Usually you don't want to set these options. The only obvious reason
949 is if RT is accessible via https protocol on a non standard port, e.g.
950 'https://rt.example.com:9999'. In all other cases these options are
951 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
953 C<$WebBaseURL> is the scheme, server and port
954 (e.g. 'http://rt.example.com') for constructing URLs to the web
955 UI. C<$WebBaseURL> doesn't need a trailing /.
957 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
958 example: 'http://www.example.com/rt/'.
962 my $port = RT->Config->Get('WebPort');
964 ($port == 443? 'https': 'http') .'://'
965 . RT->Config->Get('WebDomain')
966 . ($port != 80 && $port != 443? ":$port" : '')
969 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
971 =item C<$WebImagesURL>
973 C<$WebImagesURL> points to the base URL where RT can find its images.
974 Define the directory name to be used for images in RT web documents.
978 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
982 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
983 This can also be configured via the web UI.
987 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
989 =item C<$LogoLinkURL>
991 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
995 Set($LogoLinkURL, "http://bestpractical.com");
997 =item C<$LogoAltText>
999 C<$LogoAltText> is a string of text for the alt-text of the logo. It
1000 will be passed through C<loc> for localization.
1004 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1006 =item C<$LogoImageHeight>
1008 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1013 Set($LogoImageHeight, 38);
1015 =item C<$LogoImageWidth>
1017 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1022 Set($LogoImageWidth, 181);
1024 =item C<$WebNoAuthRegex>
1026 What portion of RT's URL space should not require authentication. The
1027 default is almost certainly correct, and should only be changed if you
1032 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1034 =item C<$SelfServiceRegex>
1036 What portion of RT's URLspace should be accessible to Unprivileged
1037 users This does not override the redirect from F</Ticket/Display.html>
1038 to F</SelfService/Display.html> when Unprivileged users attempt to
1039 access ticked displays.
1043 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1045 =item C<$WebFlushDbCacheEveryRequest>
1047 By default, RT clears its database cache after every page view. This
1048 ensures that you've always got the most current information when
1049 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1050 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1051 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1055 Set($WebFlushDbCacheEveryRequest, 1);
1059 The L<GD> module (which RT uses for graphs) ships with a built-in font
1060 that doesn't have full Unicode support. You can use a given TrueType
1061 font for a specific language by setting %ChartFont to (language =E<gt>
1062 the absolute path of a font) pairs. Your GD library must have support
1063 for TrueType fonts to use this option. If there is no entry for a
1064 language in the hash then font with 'others' key is used.
1066 RT comes with two TrueType fonts covering most available languages.
1072 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1073 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1074 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1075 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1078 =item C<$ChartsTimezonesInDB>
1080 RT stores dates using the UTC timezone in the DB, so charts grouped by
1081 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1082 to enable timezone conversions using your DB's capabilities. You may
1083 need to do some work on the DB side to use this feature, read more in
1084 F<docs/customizing/timezones_in_charts.pod>.
1086 At this time, this feature only applies to MySQL and PostgreSQL.
1090 Set($ChartsTimezonesInDB, 0);
1100 =item C<$DefaultSummaryRows>
1102 C<$DefaultSummaryRows> is default number of rows displayed in for
1103 search results on the front page.
1107 Set($DefaultSummaryRows, 10);
1109 =item C<$HomePageRefreshInterval>
1111 C<$HomePageRefreshInterval> is default number of seconds to refresh
1112 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1116 Set($HomePageRefreshInterval, 0);
1118 =item C<$HomepageComponents>
1120 C<$HomepageComponents> is an arrayref of allowed components on a
1121 user's customized homepage ("RT at a glance").
1125 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
1132 =head2 Ticket search
1136 =item C<$UseSQLForACLChecks>
1138 Historically, ACLs were checked on display, which could lead to empty
1139 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1140 to limit search results in SQL instead, which eliminates these
1143 This option is still relatively new; it may result in performance
1144 problems in some cases, or significant speedups in others.
1148 Set($UseSQLForACLChecks, undef);
1150 =item C<$TicketsItemMapSize>
1152 On the display page of a ticket from search results, RT provides links
1153 to the first, next, previous and last ticket from the results. In
1154 order to build these links, RT needs to fetch the full result set from
1155 the database, which can be resource-intensive.
1157 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1158 to build these links. If the full result set is larger than this
1159 number, RT will omit the "last" link in the menu. Set this to zero to
1160 always examine all results.
1164 Set($TicketsItemMapSize, 1000);
1166 =item C<$SearchResultsRefreshInterval>
1168 C<$SearchResultsRefreshInterval> is default number of seconds to
1169 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1174 Set($SearchResultsRefreshInterval, 0);
1176 =item C<$DefaultSearchResultFormat>
1178 C<$DefaultSearchResultFormat> is the default format for RT search
1183 Set ($DefaultSearchResultFormat, qq{
1184 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1185 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1193 '<small>__Requestors__</small>',
1194 '<small>__CustomerTags__</small>',
1195 '<small>__CreatedRelative__</small>',
1196 '<small>__ToldRelative__</small>',
1197 '<small>__LastUpdatedRelative__</small>',
1198 '<small>__TimeLeft__</small>'});
1200 =item C<$DefaultSelfServiceSearchResultFormat>
1202 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1203 searches displayed in the SelfService interface.
1207 Set($DefaultSelfServiceSearchResultFormat, qq{
1208 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1209 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1214 =item C<%FullTextSearch>
1216 Full text search (FTS) without database indexing is a very slow
1217 operation, and is thus disabled by default.
1219 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1220 the full details of FTS on your particular database.
1222 It is possible to enable FTS without database indexing support, simply
1223 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1224 This is not generally suggested, as unindexed full-text searching can
1225 cause severe performance problems.
1229 Set(%FullTextSearch,
1235 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1237 When query in simple search doesn't have status info, use this to only
1242 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1244 =item C<$SearchResultsAutoRedirect>
1246 When only one ticket is found in search, use this to redirect to the
1247 ticket display page automatically.
1251 Set($SearchResultsAutoRedirect, 0);
1257 =head2 Ticket display
1261 =item C<$ShowMoreAboutPrivilegedUsers>
1263 This determines if the 'More about requestor' box on
1264 Ticket/Display.html is shown for Privileged Users.
1268 Set($ShowMoreAboutPrivilegedUsers, 0);
1270 =item C<$MoreAboutRequestorTicketList>
1272 This can be set to Active, Inactive, All or None. It controls what
1273 ticket list will be displayed in the 'More about requestor' box on
1274 Ticket/Display.html. This option can be controlled by users also.
1278 Set($MoreAboutRequestorTicketList, "Active");
1280 =item C<$MoreAboutRequestorExtraInfo>
1282 By default, the 'More about requestor' box on Ticket/Display.html
1283 shows the Requestor's name and ticket list. If you would like to see
1284 extra information about the user, this expects a Format string of user
1285 attributes. Please note that not all the attributes are supported in
1286 this display because we're not building a table.
1289 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1293 Set($MoreAboutRequestorExtraInfo, "");
1295 =item C<$MoreAboutRequestorGroupsLimit>
1297 By default, the 'More about requestor' box on Ticket/Display.html
1298 shows all the groups of the Requestor. Use this to limit the number
1299 of groups; a value of undef removes the group display entirely.
1303 Set($MoreAboutRequestorGroupsLimit, 0);
1305 =item C<$UseSideBySideLayout>
1307 Should the ticket create and update forms use a more space efficient
1308 two column layout. This layout may not work in narrow browsers if you
1309 set a MessageBoxWidth (below).
1313 Set($UseSideBySideLayout, 1);
1315 =item C<$EditCustomFieldsSingleColumn>
1317 When displaying a list of Ticket Custom Fields for editing, RT
1318 defaults to a 2 column list. If you set this to 1, it will instead
1319 display the Custom Fields in a single column.
1323 Set($EditCustomFieldsSingleColumn, 0);
1325 =item C<$ShowUnreadMessageNotifications>
1327 If set to 1, RT will prompt users when there are new,
1328 unread messages on tickets they are viewing.
1332 Set($ShowUnreadMessageNotifications, 0);
1334 =item C<$AutocompleteOwners>
1336 If set to 1, the owner drop-downs for ticket update/modify and the query
1337 builder are replaced by text fields that autocomplete. This can
1338 alleviate the sometimes huge owner list for installations where many
1339 users have the OwnTicket right.
1343 Set($AutocompleteOwners, 0);
1345 =item C<$AutocompleteOwnersForSearch>
1347 If set to 1, the owner drop-downs for the query builder are always
1348 replaced by text field that autocomplete and C<$AutocompleteOwners>
1349 is ignored. Helpful when owners list is huge in the query builder.
1353 Set($AutocompleteOwnersForSearch, 0);
1355 =item C<$UserAutocompleteFields>
1357 Specifies which fields of L<RT::User> to match against and how to
1358 match each field when autocompleting users. Valid match methods are
1359 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1363 Set($UserAutocompleteFields, {
1364 EmailAddress => 'STARTSWITH',
1365 Name => 'STARTSWITH',
1369 =item C<$AllowUserAutocompleteForUnprivileged>
1371 Should unprivileged users be allowed to autocomplete users. Setting
1372 this option to 1 means unprivileged users will be able to search all
1377 Set($AllowUserAutocompleteForUnprivileged, 0);
1379 =item C<$DisplayTicketAfterQuickCreate>
1381 Enable this to redirect to the created ticket display page
1382 automatically when using QuickCreate.
1386 Set($DisplayTicketAfterQuickCreate, 0);
1388 =item C<$WikiImplicitLinks>
1390 Support implicit links in WikiText custom fields? Setting this to 1
1391 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1392 become links to searches for those words. If used on Articles, it links
1393 to the Article with that name.
1397 Set($WikiImplicitLinks, 0);
1399 =item C<$PreviewScripMessages>
1401 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1402 reply page should include the content of the messages to be sent.
1406 Set($PreviewScripMessages, 0);
1408 =item C<$SimplifiedRecipients>
1410 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1411 B<any> kind of mail will be shown on the ticket reply page, instead of a
1412 detailed breakdown by scrip.
1416 Set($SimplifiedRecipients, 0);
1418 =item C<$HideResolveActionsWithDependencies>
1420 If set to 1, this option will skip ticket menu actions which can't be
1421 completed successfully because of outstanding active Depends On tickets.
1423 By default, all ticket actions are displayed in the menu even if some of
1424 them can't be successful until all Depends On links are resolved or
1425 transitioned to another inactive status.
1429 Set($HideResolveActionsWithDependencies, 0);
1439 =item C<$ArticleOnTicketCreate>
1441 Set this to 1 to display the Articles interface on the Ticket Create
1442 page in addition to the Reply/Comment page.
1446 Set($ArticleOnTicketCreate, 0);
1448 =item C<$HideArticleSearchOnReplyCreate>
1450 Set this to 1 to hide the search and include boxes from the Article
1451 UI. This assumes you have enabled Article Hotlist feature, otherwise
1452 you will have no access to Articles.
1456 Set($HideArticleSearchOnReplyCreate, 0);
1462 =head2 Message box properties
1466 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1468 For message boxes, set the entry box width, height and what type of
1469 wrapping to use. These options can be overridden by users in their
1472 When the width is set to undef, no column count is specified and the
1473 message box will take up 100% of the available width. Combining this
1474 with HARD messagebox wrapping (below) is not recommended, as it will
1475 lead to inconsistent width in transactions between browsers.
1477 These settings only apply to the non-RichText message box. See below
1478 for Rich Text settings.
1482 Set($MessageBoxWidth, undef);
1483 Set($MessageBoxHeight, 15);
1485 =item C<$MessageBoxWrap>
1487 Wrapping is disabled when using MessageBoxRichText because of a bad
1488 interaction between IE and wrapping with the Rich Text Editor.
1492 Set($MessageBoxWrap, "SOFT");
1494 =item C<$MessageBoxRichText>
1496 Should "rich text" editing be enabled? This option lets your users
1497 send HTML email messages from the web interface.
1501 Set($MessageBoxRichText, 1);
1503 =item C<$MessageBoxRichTextHeight>
1505 Height of rich text JavaScript enabled editing boxes (in pixels)
1509 Set($MessageBoxRichTextHeight, 200);
1511 =item C<$MessageBoxIncludeSignature>
1513 Should your users' signatures (from their Preferences page) be
1514 included in Comments and Replies.
1518 Set($MessageBoxIncludeSignature, 1);
1520 =item C<$MessageBoxIncludeSignatureOnComment>
1522 Should your users' signatures (from their Preferences page) be
1523 included in Comments. Setting this to false overrides
1524 C<$MessageBoxIncludeSignature>.
1528 Set($MessageBoxIncludeSignatureOnComment, 1);
1533 =head2 Transaction display
1537 =item C<$OldestTransactionsFirst>
1539 By default, RT shows newest transactions at the bottom of the ticket
1540 history page, if you want see them at the top set this to 0. This
1541 option can be overridden by users in their preferences.
1545 Set($OldestTransactionsFirst, 1);
1547 =item C<$DeferTransactionLoading>
1549 When set, defers loading ticket history until the user clicks a link.
1550 This should end up serving pages to users quicker, since generating
1551 all the HTML for transaction history can be slow for long tickets.
1555 # Set($DeferTransactionLoading, 1);
1557 =item C<$ShowBccHeader>
1559 By default, RT hides from the web UI information about blind copies
1560 user sent on reply or comment.
1564 Set($ShowBccHeader, 0);
1566 =item C<$TrustHTMLAttachments>
1568 If C<TrustHTMLAttachments> is not defined, we will display them as
1569 text. This prevents malicious HTML and JavaScript from being sent in a
1570 request (although there is probably more to it than that)
1574 Set($TrustHTMLAttachments, undef);
1576 =item C<$AlwaysDownloadAttachments>
1578 Always download attachments, regardless of content type. If set, this
1579 overrides C<TrustHTMLAttachments>.
1583 Set($AlwaysDownloadAttachments, undef);
1585 =item C<$AttachmentUnits>
1587 Controls the units (kilobytes or bytes) that attachment sizes use for
1588 display. The default is to display kilobytes if the attachment is
1589 larger than 1024 bytes, bytes otherwise. If you set
1590 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1591 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1595 Set($AttachmentUnits, undef);
1597 =item C<$PreferRichText>
1599 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1600 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1601 show only a minimal subset of HTML to avoid possible contamination by
1602 cross-site-scripting attacks.
1606 Set($PreferRichText, undef);
1608 =item C<$MaxInlineBody>
1610 C<$MaxInlineBody> is the maximum attachment size that we want to see
1611 inline when viewing a transaction. RT will inline any text if the
1612 value is undefined or 0. This option can be overridden by users in
1617 Set($MaxInlineBody, 12000);
1619 =item C<$ShowTransactionImages>
1621 By default, RT shows images attached to incoming (and outgoing) ticket
1622 updates inline. Set this variable to 0 if you'd like to disable that
1627 Set($ShowTransactionImages, 1);
1629 =item C<$PlainTextPre>
1631 Normally plaintext attachments are displayed as HTML with line breaks
1632 preserved. This causes space- and tab-based formatting not to be
1633 displayed correctly. By setting $PlainTextPre messages will be
1634 displayed using <pre>.
1638 Set($PlainTextPre, 0);
1641 =item C<$PlainTextMono>
1643 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1644 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1645 of the browser window; this option overrides C<$PlainTextPre>.
1649 Set($PlainTextMono, 0);
1651 =item C<$SuppressInlineTextFiles>
1653 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1654 (text-type attachments with file names) are prevented from being
1655 displayed in-line when viewing a ticket's history.
1659 Set($SuppressInlineTextFiles, undef);
1662 =item C<@Active_MakeClicky>
1664 MakeClicky detects various formats of data in headers and email
1665 messages, and extends them with supporting links. By default, RT
1666 provides two formats:
1668 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1671 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1672 replaces the URL with a link.
1674 See F<share/html/Elements/MakeClicky> for documentation on how to add
1675 your own styles of link detection.
1679 Set(@Active_MakeClicky, qw());
1685 =head1 Application logic
1689 =item C<$ParseNewMessageForTicketCcs>
1691 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1692 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1693 messages. Be forewarned that if you have I<any> addresses which forward
1694 mail to RT automatically and you enable this option without modifying
1695 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1699 Set($ParseNewMessageForTicketCcs, undef);
1701 =item C<$UseTransactionBatch>
1703 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1704 such that a resolve and comment (for example) would happen
1705 simultaneously, instead of as two transactions, unaware of each
1710 Set($UseTransactionBatch, 1);
1712 =item C<$StrictLinkACL>
1714 When this feature is enabled a user needs I<ModifyTicket> rights on
1715 both tickets to link them together; otherwise, I<ModifyTicket> rights
1716 on either of them is sufficient.
1720 Set($StrictLinkACL, 1);
1722 =item C<$RedistributeAutoGeneratedMessages>
1724 Should RT redistribute correspondence that it identifies as machine
1725 generated? A 1 will do so; setting this to 0 will cause no
1726 such messages to be redistributed. You can also use 'privileged' (the
1727 default), which will redistribute only to privileged users. This helps
1728 to protect against malformed bounces and loops caused by auto-created
1729 requestors with bogus addresses.
1733 Set($RedistributeAutoGeneratedMessages, "privileged");
1735 =item C<$ApprovalRejectionNotes>
1737 Should rejection notes from approvals be sent to the requestors?
1741 Set($ApprovalRejectionNotes, 1);
1743 =item C<$ForceApprovalsView>
1745 Should approval tickets only be viewed and modified through the standard
1746 approval interface? Changing this setting to 1 will redirect any attempt to
1747 use the normal ticket display and modify page for approval tickets.
1749 For example, with this option set to 1 and an approval ticket #123:
1751 /Ticket/Display.html?id=123
1755 /Approval/Display.html?id=123
1761 Set($ForceApprovalsView, 0);
1763 =head1 Extra security
1767 This is a list of extra security measures to enable that help keep your RT
1768 safe. If you don't know what these mean, you should almost certainly leave the
1771 =item C<$DisallowExecuteCode>
1773 If set to a true value, the C<ExecuteCode> right will be removed from
1774 all users, B<including> the superuser. This is intended for when RT is
1775 installed into a shared environment where even the superuser should not
1776 be allowed to run arbitrary Perl code on the server via scrips.
1780 Set($DisallowExecuteCode, 0);
1782 =item C<$Framebusting>
1784 If set to a false value, framekiller javascript will be disabled and the
1785 X-Frame-Options: DENY header will be suppressed from all responses.
1786 This disables RT's clickjacking protection.
1790 Set($Framebusting, 1);
1794 =head1 Authorization and user configuration
1798 =item C<$WebExternalAuth>
1800 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1801 REMOTE_USER variable.
1805 Set($WebExternalAuth, undef);
1807 =item C<$WebExternalAuthContinuous>
1809 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1810 REMOTE_USER on each access. If you would prefer this to only happen
1811 once (at initial login) set this to a false value. The default
1812 setting will help ensure that if your external authentication system
1813 deauthenticates a user, RT notices as soon as possible.
1817 Set($WebExternalAuthContinuous, 1);
1819 =item C<$WebFallbackToInternalAuth>
1821 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1822 chance of fallback to the login screen, even if REMOTE_USER failed.
1826 Set($WebFallbackToInternalAuth, undef);
1828 =item C<$WebExternalGecos>
1830 C<$WebExternalGecos> means to match 'gecos' field as the user
1831 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1836 Set($WebExternalGecos, undef);
1838 =item C<$WebExternalAuto>
1840 C<$WebExternalAuto> will create users under the same name as
1841 REMOTE_USER upon login, if it's missing in the Users table.
1845 Set($WebExternalAuto, undef);
1847 =item C<$AutoCreate>
1849 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1850 User's Create method. Use it to set defaults, such as creating
1851 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1855 Set($AutoCreate, undef);
1857 =item C<$WebSessionClass>
1859 C<$WebSessionClass> is the class you wish to use for managing
1860 Sessions. It defaults to use your SQL database, but if you are using
1861 MySQL 3.x and plans to use non-ascii Queue names, uncomment and add
1862 this line to F<RT_SiteConfig.pm> to prevent session corruption.
1866 # Set($WebSessionClass, "Apache::Session::File");
1868 =item C<$AutoLogoff>
1870 By default, RT's user sessions persist until a user closes his or her
1871 browser. With the C<$AutoLogoff> option you can setup session lifetime
1872 in minutes. A user will be logged out if he or she doesn't send any
1873 requests to RT for the defined time.
1877 Set($AutoLogoff, 0);
1879 =item C<$LogoutRefresh>
1881 The number of seconds to wait after logout before sending the user to
1882 the login page. By default, 1 second, though you may want to increase
1883 this if you display additional information on the logout page.
1887 Set($LogoutRefresh, 1);
1889 =item C<$WebSecureCookies>
1891 By default, RT's session cookie isn't marked as "secure". Some web
1892 browsers will treat secure cookies more carefully than non-secure
1893 ones, being careful not to write them to disk, only sending them over
1894 an SSL secured connection, and so on. To enable this behavior, set
1895 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1896 on I<unless> users are only connecting via SSL encrypted HTTPS
1901 Set($WebSecureCookies, 0);
1903 =item C<$WebHttpOnlyCookies>
1905 Default RT's session cookie to not being directly accessible to
1906 javascript. The content is still sent during regular and AJAX requests,
1907 and other cookies are unaffected, but the session-id is less
1908 programmatically accessible to javascript. Turning this off should only
1909 be necessary in situations with odd client-side authentication
1914 Set($WebHttpOnlyCookies, 1);
1916 =item C<$MinimumPasswordLength>
1918 C<$MinimumPasswordLength> defines the minimum length for user
1919 passwords. Setting it to 0 disables this check.
1923 Set($MinimumPasswordLength, 5);
1928 =head1 Internationalization
1932 =item C<@LexiconLanguages>
1934 An array that contains languages supported by RT's
1935 internationalization interface. Defaults to all *.po lexicons;
1936 setting it to C<qw(en ja)> will make RT bilingual instead of
1937 multilingual, but will save some memory.
1941 Set(@LexiconLanguages, qw(*));
1943 =item C<@EmailInputEncodings>
1945 An array that contains default encodings used to guess which charset
1946 an attachment uses, if it does not specify one explicitly. All
1947 options must be recognized by L<Encode::Guess>. The first element may
1948 also be '*', which enables encoding detection using
1949 L<Encode::Detect::Detector>, if installed.
1953 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1955 =item C<$EmailOutputEncoding>
1957 The charset for localized email. Must be recognized by Encode.
1961 Set($EmailOutputEncoding, "utf-8");
1971 =head1 Date and time handling
1975 =item C<$DateTimeFormat>
1977 You can choose date and time format. See the "Output formatters"
1978 section in perldoc F<lib/RT/Date.pm> for more options. This option
1979 can be overridden by users in their preferences.
1983 C<Set($DateTimeFormat, "LocalizedDateTime");>
1984 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
1985 C<Set($DateTimeFormat, "RFC2822");>
1986 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
1990 Set($DateTimeFormat, "DefaultFormat");
1992 # Next two options are for Time::ParseDate
1994 =item C<$DateDayBeforeMonth>
1996 Set this to 1 if your local date convention looks like "dd/mm/yy"
1997 instead of "mm/dd/yy". Used only for parsing, not for displaying
2002 Set($DateDayBeforeMonth, 1);
2004 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2006 Should an unspecified day or year in a date refer to a future or a
2007 past value? For example, should a date of "Tuesday" default to mean
2008 the date for next Tuesday or last Tuesday? Should the date "March 1"
2009 default to the date for next March or last March?
2011 Set C<$AmbiguousDayInPast> for the last date, or
2012 C<$AmbiguousDayInFuture> for the next date; the default is usually
2013 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2017 Set($AmbiguousDayInPast, 0);
2018 Set($AmbiguousDayInFuture, 0);
2020 =item C<$DefaultTimeUnitsToHours>
2022 Use this to set the default units for time entry to hours instead of
2023 minutes. Note that this only effects entry, not display.
2027 Set($DefaultTimeUnitsToHours, 0);
2029 =item C<$SimpleSearchIncludeResolved>
2031 By default, the simple ticket search in the top bar excludes "resolved" tickets
2032 unless a status argument is specified. Set this to a true value to include
2037 Set($SimpleSearchIncludeResolved, 0);
2044 =head1 GnuPG integration
2046 A full description of the (somewhat extensive) GnuPG integration can
2047 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2048 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2054 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2055 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2057 If you want to allow people to encrypt attachments inside the DB then
2058 set C<AllowEncryptDataInDB> to 1.
2060 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2061 emails encrypted for key RT doesn't have and can not decrypt.
2063 Set C<RejectOnBadData> to false if you don't want to reject letters
2064 with incorrect GnuPG data.
2070 OutgoingMessagesFormat => "RFC", # Inline
2071 AllowEncryptDataInDB => 0,
2073 RejectOnMissingPrivateKey => 1,
2074 RejectOnBadData => 1,
2077 =item C<%GnuPGOptions>
2079 Options to pass to the GnuPG program.
2081 If you override this in your RT_SiteConfig, you should be sure to
2082 include a homedir setting.
2084 Note that options with '-' character MUST be quoted.
2089 homedir => q{/opt/rt3/var/data/gpg},
2091 # URL of a keyserver
2092 # keyserver => 'hkp://subkeys.pgp.net',
2094 # enables the automatic retrieving of keys when encrypting
2095 # 'auto-key-locate' => 'keyserver',
2097 # enables the automatic retrieving of keys when verifying signatures
2098 # 'auto-key-retrieve' => undef,
2107 =head2 Lifecycle definitions
2109 Each lifecycle is a list of possible statuses split into three logic
2110 sets: B<initial>, B<active> and B<inactive>. Each status in a
2111 lifecycle must be unique. (Statuses may not be repeated across sets.)
2112 Each set may have any number of statuses.
2118 active => ['open', 'stalled'],
2119 inactive => ['resolved', 'rejected', 'deleted'],
2123 Status names can be from 1 to 64 ASCII characters. Statuses are
2124 localized using RT's standard internationalization and localization
2131 You can define multiple B<initial> statuses for tickets in a given
2134 RT will automatically set its B<Started> date when you change a
2135 ticket's status from an B<initial> state to an B<active> or
2140 B<Active> tickets are "currently in play" - they're things that are
2141 being worked on and not yet complete.
2145 B<Inactive> tickets are typically in their "final resting state".
2147 While you're free to implement a workflow that ignores that
2148 description, typically once a ticket enters an inactive state, it will
2149 never again enter an active state.
2151 RT will automatically set the B<Resolved> date when a ticket's status
2152 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2155 B<deleted> is still a special status and protected by the
2156 B<DeleteTicket> right, unless you re-defined rights (read below). If
2157 you don't want to allow ticket deletion at any time simply don't
2158 include it in your lifecycle.
2162 Statuses in each set are ordered and listed in the UI in the defined
2165 Changes between statuses are constrained by transition rules, as
2168 =head2 Default values
2170 In some cases a default value is used to display in UI or in API when
2171 value is not provided. You can configure defaults using the following
2178 on_resolve => 'resolved',
2183 The following defaults are used.
2189 If you (or your code) doesn't specify a status when creating a ticket,
2190 RT will use the this status. See also L</Statuses available during
2195 When tickets are merged, the status of the ticket that was merged
2196 away is forced to this value. It should be one of inactive statuses;
2197 'resolved' or its equivalent is most probably the best candidate.
2201 When an approval is accepted, the status of depending tickets will
2202 be changed to this value.
2206 When an approval is denied, the status of depending tickets will
2207 be changed to this value.
2211 =head2 Transitions between statuses and UI actions
2213 A B<Transition> is a change of status from A to B. You should define
2214 all possible transitions in each lifecycle using the following format:
2219 '' => [qw(new open resolved)],
2220 new => [qw(open resolved rejected deleted)],
2221 open => [qw(stalled resolved rejected deleted)],
2222 stalled => [qw(open)],
2223 resolved => [qw(open)],
2224 rejected => [qw(open)],
2225 deleted => [qw(open)],
2230 =head3 Statuses available during ticket creation
2232 By default users can create tickets with any status, except
2233 deleted. If you want to restrict statuses available during creation
2234 then describe transition from '' (empty string), like in the example
2237 =head3 Protecting status changes with rights
2239 A transition or group of transitions can be protected by a specific
2240 right. Additionally, you can name new right names, which will be added
2241 to the system to control that transition. For example, if you wished to
2242 create a lesser right than ModifyTicket for rejecting tickets, you could
2248 '* -> deleted' => 'DeleteTicket',
2249 '* -> rejected' => 'RejectTicket',
2250 '* -> *' => 'ModifyTicket',
2255 This would create a new C<RejectTicket> right in the system which you
2256 could assign to whatever groups you choose.
2258 On the left hand side you can have the following variants:
2265 Valid transitions are listed in order of priority. If a user attempts
2266 to change a ticket's status from B<new> to B<open> then the lifecycle
2267 is checked for presence of an exact match, then for 'any to B<open>',
2268 'B<new> to any' and finally 'any to any'.
2270 If you don't define any rights, or there is no match for a transition,
2271 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2273 =head3 Labeling and defining actions
2275 For each transition you can define an action that will be shown in the
2276 UI; each action annotated with a label and an update type.
2278 Each action may provide a default update type, which can be
2279 B<Comment>, B<Respond>, or absent. For example, you may want your
2280 staff to write a reply to the end user when they change status from
2281 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2282 B<Comment> nor B<Respond> are mandatory, and user may leave the
2283 message empty, regardless of the update type.
2285 This configuration can be used to accomplish what
2286 $ResolveDefaultUpdateType was used for in RT 3.8.
2288 Use the following format to define labels and actions of transitions:
2293 'new -> open' => { label => 'Open it', update => 'Respond' },
2294 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2295 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2296 'new -> deleted' => { label => 'Delete' },
2298 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2299 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2300 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2302 'stalled -> open' => { label => 'Open it' },
2303 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2304 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2305 'deleted -> open' => { label => 'Undelete' },
2310 In addition, you may define multiple actions for the same transition.
2311 Alternately, you may use '* -> x' to match more than one transition.
2318 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2319 'new -> rejected' => { label => 'Quick Reject' },
2321 '* -> deleted' => { label => 'Delete' },
2327 =head2 Moving tickets between queues with different lifecycles
2329 Unless there is an explicit mapping between statuses in two different
2330 lifecycles, you can not move tickets between queues with these
2331 lifecycles. This is true even if the different lifecycles use the exact
2332 same set of statuses. Such a mapping is defined as follows:
2335 'from lifecycle -> to lifecycle' => {
2336 'status in left lifecycle' => 'status in right lifecycle',
2346 initial => [ 'new' ],
2347 active => [ 'open', 'stalled' ],
2348 inactive => [ 'resolved', 'rejected', 'deleted' ],
2352 on_merge => 'resolved',
2354 denied => 'rejected',
2358 '' => [qw(new open resolved)],
2360 # from => [ to list ],
2361 new => [qw(open stalled resolved rejected deleted)],
2362 open => [qw(new stalled resolved rejected deleted)],
2363 stalled => [qw(new open rejected resolved deleted)],
2364 resolved => [qw(new open stalled rejected deleted)],
2365 rejected => [qw(new open stalled resolved deleted)],
2366 deleted => [qw(new open stalled rejected resolved)],
2369 '* -> deleted' => 'DeleteTicket',
2370 '* -> *' => 'ModifyTicket',
2374 label => 'Open It', # loc
2375 update => 'Respond',
2377 'new -> resolved' => {
2378 label => 'Resolve', # loc
2379 update => 'Comment',
2381 'new -> rejected' => {
2382 label => 'Reject', # loc
2383 update => 'Respond',
2385 'new -> deleted' => {
2386 label => 'Delete', # loc
2389 'open -> stalled' => {
2390 label => 'Stall', # loc
2391 update => 'Comment',
2393 'open -> resolved' => {
2394 label => 'Resolve', # loc
2395 update => 'Comment',
2397 'open -> rejected' => {
2398 label => 'Reject', # loc
2399 update => 'Respond',
2402 'stalled -> open' => {
2403 label => 'Open It', # loc
2405 'resolved -> open' => {
2406 label => 'Re-open', # loc
2407 update => 'Comment',
2409 'rejected -> open' => {
2410 label => 'Re-open', # loc
2411 update => 'Comment',
2413 'deleted -> open' => {
2414 label => 'Undelete', # loc
2418 # don't change lifecyle of the approvals, they are not capable to deal with
2421 initial => [ 'new' ],
2422 active => [ 'open', 'stalled' ],
2423 inactive => [ 'resolved', 'rejected', 'deleted' ],
2427 on_merge => 'resolved',
2431 '' => [qw(new open resolved)],
2433 # from => [ to list ],
2434 new => [qw(open stalled resolved rejected deleted)],
2435 open => [qw(new stalled resolved rejected deleted)],
2436 stalled => [qw(new open rejected resolved deleted)],
2437 resolved => [qw(new open stalled rejected deleted)],
2438 rejected => [qw(new open stalled resolved deleted)],
2439 deleted => [qw(new open stalled rejected resolved)],
2442 '* -> deleted' => 'DeleteTicket',
2443 '* -> rejected' => 'ModifyTicket',
2444 '* -> *' => 'ModifyTicket',
2448 label => 'Open It', # loc
2449 update => 'Respond',
2451 'new -> resolved' => {
2452 label => 'Resolve', # loc
2453 update => 'Comment',
2455 'new -> rejected' => {
2456 label => 'Reject', # loc
2457 update => 'Respond',
2459 'new -> deleted' => {
2460 label => 'Delete', # loc
2463 'open -> stalled' => {
2464 label => 'Stall', # loc
2465 update => 'Comment',
2467 'open -> resolved' => {
2468 label => 'Resolve', # loc
2469 update => 'Comment',
2471 'open -> rejected' => {
2472 label => 'Reject', # loc
2473 update => 'Respond',
2476 'stalled -> open' => {
2477 label => 'Open It', # loc
2479 'resolved -> open' => {
2480 label => 'Re-open', # loc
2481 update => 'Comment',
2483 'rejected -> open' => {
2484 label => 'Re-open', # loc
2485 update => 'Comment',
2487 'deleted -> open' => {
2488 label => 'Undelete', # loc
2498 =head1 Administrative interface
2502 =item C<$ShowRTPortal>
2504 RT can show administrators a feed of recent RT releases and other
2505 related announcements and information from Best Practical on the top
2506 level Configuration page. This feature helps you stay up to date on
2507 RT security announcements and version updates.
2509 RT provides this feature using an "iframe" on C</Admin/index.html>
2510 which asks the administrator's browser to show an inline page from
2511 Best Practical's website.
2513 If you'd rather not make this feature available to your
2514 administrators, set C<$ShowRTPortal> to a false value.
2518 Set($ShowRTPortal, 1);
2520 =item C<%AdminSearchResultFormat>
2522 In the admin interface, format strings similar to tickets result
2523 formats are used. Use C<%AdminSearchResultFormat> to define the format
2524 strings used in the admin interface on a per-RT-class basis.
2528 Set(%AdminSearchResultFormat,
2530 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2531 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2532 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__},
2535 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2536 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2537 .q{,'__Description__'},
2540 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2541 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2542 .q{,__RealName__, __EmailAddress__},
2545 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2546 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2547 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2550 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2551 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2552 .q{,__Stage__, __Condition__, __Action__, __Template__},
2555 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2556 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2557 .q{,__Stage__, __Condition__, __Action__, __Template__},
2560 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2561 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2562 .q{,'__Description__'},
2564 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2565 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2566 .q{,__Description__},
2574 =head1 Development options
2580 RT comes with a "Development mode" setting. This setting, as a
2581 convenience for developers, turns on several of development options
2582 that you most likely don't want in production:
2588 Disables CSS and JS minification and concatenation. Both CSS and JS
2589 will be instead be served as a number of individual smaller files,
2590 unchanged from how they are stored on disk.
2594 Uses L<Module::Refresh> to reload changed Perl modules on each
2599 Turns off Mason's C<static_source> directive; this causes Mason to
2600 reload template files which have been modified on disk.
2604 Turns on Mason's HTML C<error_format>; this renders compilation errors
2605 to the browser, along with a full stack trace. It is possible for
2606 stack traces to reveal sensitive information such as passwords or
2611 Turns off caching of callbacks; this enables additional callbacks to
2612 be added while the server is running.
2618 Set($DevelMode, "0");
2621 =item C<$RecordBaseClass>
2623 What abstract base class should RT use for its records. You should
2624 probably never change this.
2626 Valid values are C<DBIx::SearchBuilder::Record> or
2627 C<DBIx::SearchBuilder::Record::Cachable>
2631 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2634 =item C<@MasonParameters>
2636 C<@MasonParameters> is the list of parameters for the constructor of
2637 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2638 debugging, e.g. profiling individual components with:
2640 use MasonX::Profiler; # available on CPAN
2641 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2645 Set(@MasonParameters, ());
2647 =item C<$StatementLog>
2649 RT has rudimentary SQL statement logging support; simply set
2650 C<$StatementLog> to be the level that you wish SQL statements to be
2653 Enabling this option will also expose the SQL Queries page in the
2654 Configuration -> Tools menu for SuperUsers.
2658 Set($StatementLog, undef);
2665 =head1 Deprecated options
2669 =item C<$LinkTransactionsRun1Scrip>
2671 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2672 one transaction and run one scrip. Set this value to 1 if you want
2673 only one of the link transactions to have scrips run.
2677 Set($LinkTransactionsRun1Scrip, 0);
2679 =item C<$ResolveDefaultUpdateType>
2681 This option has been deprecated. You can configure this site-wide
2682 with L</Lifecycles> (see L</Labeling and defining actions>).