2 # RT was configured with:
4 # $ ./configure --prefix=/www/var/rt/ --with-web-user=httpd --with-web-group=httpd --with-rt-group=uio-rt --with-apachectl=/www/sbin/apachectl --with-db-type=Pg --with-db-dba=postgres --disable-gpg
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)));>
135 =head1 Database connection
139 =item C<$DatabaseType>
141 Database driver being used; case matters. Valid types are "mysql",
146 Set($DatabaseType, "Pg");
148 =item C<$DatabaseHost>, C<$DatabaseRTHost>
150 The domain name of your database server. If you're running MySQL and
151 on localhost, leave it blank for enhanced performance.
153 C<DatabaseRTHost> is the fully-qualified hostname of your RT server,
154 for use in granting ACL rights on MySQL.
158 Set($DatabaseHost, "localhost");
159 Set($DatabaseRTHost, "localhost");
161 =item C<$DatabasePort>
163 The port that your database server is running on. Ignored unless it's
164 a positive integer. It's usually safe to leave this blank; RT will
165 choose the correct default.
169 Set($DatabasePort, "");
171 =item C<$DatabaseUser>
173 The name of the user to connect to the database as.
177 Set($DatabaseUser, "rt_user");
179 =item C<$DatabasePassword>
181 The password the C<$DatabaseUser> should use to access the database.
185 Set($DatabasePassword, q{rt_pass});
187 =item C<$DatabaseName>
189 The name of the RT database on your database server. For Oracle, the
190 SID and database objects are created in C<$DatabaseUser>'s schema.
194 Set($DatabaseName, q{rt4});
196 =item C<$DatabaseRequireSSL>
198 If you're using PostgreSQL and have compiled in SSL support, set
199 C<$DatabaseRequireSSL> to 1 to turn on SSL communication with the
204 Set($DatabaseRequireSSL, undef);
213 The default is to log anything except debugging information to syslog.
214 Check the L<Log::Dispatch> POD for information about how to get things
215 by syslog, mail or anything else, get debugging info in the log, etc.
217 It might generally make sense to send error and higher by email to
218 some administrator. If you do this, be careful that this email isn't
219 sent to this RT instance. Mail loops will generate a critical log
224 =item C<$LogToSyslog>, C<$LogToScreen>
226 The minimum level error that will be logged to the specific device.
227 From lowest to highest priority, the levels are:
229 debug info notice warning error critical alert emergency
231 Many syslogds are configured to discard or file debug messages away, so
232 if you're attempting to debug RT you may need to reconfigure your
233 syslogd or use one of the other logging options.
235 Logging to your screen affects scripts run from the command line as well
236 as the STDERR sent to your webserver (so these logs will usually show up
237 in your web server's error logs).
241 Set($LogToSyslog, "info");
242 Set($LogToScreen, "info");
244 =item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
246 Logging to a standalone file is also possible. The file needs to both
247 exist and be writable by all direct users of the RT API. This generally
248 includes the web server and whoever rt-crontool runs as. Note that
249 rt-mailgate and the RT CLI go through the webserver, so their users do
250 not need to have write permissions to this file. If you expect to have
251 multiple users of the direct API, Best Practical recommends using syslog
252 instead of direct file logging.
254 You should set C<$LogToFile> to one of the levels documented above.
258 Set($LogToFile, undef);
259 Set($LogDir, q{var/log});
260 Set($LogToFileNamed, "rt.log"); #log to rt.log
262 =item C<$LogStackTraces>
264 If set to a log level then logging will include stack traces for
265 messages with level equal to or greater than specified.
267 NOTICE: Stack traces include parameters supplied to functions or
268 methods. It is possible for stack trace logging to reveal sensitive
269 information such as passwords or ticket content in your logs.
273 Set($LogStackTraces, "");
275 =item C<@LogToSyslogConf>
277 On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
278 override any other options RT passes to L<Log::Dispatch::Syslog>.
279 Other interesting flags include facility and logopt. (See the
280 L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
281 ident too, if you have multiple RT installations.)
285 Set(@LogToSyslogConf, ());
291 =head1 Incoming mail gateway
295 =item C<$EmailSubjectTagRegex>
297 This regexp controls what subject tags RT recognizes as its own. If
298 you're not dealing with historical C<$rtname> values, you'll likely
299 never have to change this configuration.
301 Be B<very careful> with it. Note that it overrides C<$rtname> for
302 subject token matching and that you should use only "non-capturing"
303 parenthesis grouping. For example:
305 C<Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );>
309 C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
311 The setting below would make RT behave exactly as it does without the
316 # Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
320 C<$OwnerEmail> is the address of a human who manages RT. RT will send
321 errors generated by the mail gateway to this address. This address
322 should I<not> be an address that's managed by your RT instance.
326 Set($OwnerEmail, 'root');
328 =item C<$LoopsToRTOwner>
330 If C<$LoopsToRTOwner> is defined, RT will send mail that it believes
331 might be a loop to C<$OwnerEmail>.
335 Set($LoopsToRTOwner, 1);
339 If C<$StoreLoops> is defined, RT will record messages that it believes
340 to be part of mail loops. As it does this, it will try to be careful
341 not to send mail to the sender of these messages.
345 Set($StoreLoops, undef);
347 =item C<$MaxAttachmentSize>
349 C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments
350 stored in the database. This setting is irrelevant unless one of
351 $TruncateLongAttachments or $DropLongAttachments (below) are set.
355 Set($MaxAttachmentSize, 10_000_000);
357 =item C<$TruncateLongAttachments>
359 If this is set to a non-undef value, RT will truncate attachments
360 longer than C<$MaxAttachmentSize>.
364 Set($TruncateLongAttachments, undef);
366 =item C<$DropLongAttachments>
368 If this is set to a non-undef value, RT will silently drop attachments
369 longer than C<MaxAttachmentSize>. C<$TruncateLongAttachments>, above,
370 takes priority over this.
374 Set($DropLongAttachments, undef);
376 =item C<$RTAddressRegexp>
378 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a
379 ticket CC if C<$ParseNewMessageForTicketCcs>, above, is enabled. It
380 is important that you set this to a regular expression that matches
381 all addresses used by your RT. This lets RT avoid sending mail to
382 itself. It will also hide RT addresses from the list of "One-time Cc"
383 and Bcc lists on ticket reply.
385 If you have a number of addresses configured in your RT database
386 already, you can generate a naive first pass regexp by using:
388 perl etc/upgrade/generate-rtaddressregexp
390 If left blank, RT will generate a regexp for you, based on your
391 comment and correspond address settings on your queues; this comes at
392 a small cost in start-up speed.
396 Set($RTAddressRegexp, undef);
398 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
400 RT provides functionality which allows the system to rewrite incoming
401 email addresses. In its simplest form, you can substitute the value
402 in C<CanonicalizeEmailAddressReplace> for the value in
403 C<CanonicalizeEmailAddressMatch> (These values are passed to the
404 C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>)
406 By default, that routine performs a C<s/$Match/$Replace/gi> on any
407 address passed to it.
411 # Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$');
412 # Set($CanonicalizeEmailAddressReplace, '@example.com');
414 =item C<$CanonicalizeOnCreate>
416 Set this to 1 and the create new user page will use the values that
417 you enter in the form but use the function CanonicalizeUserInfo in
422 Set($CanonicalizeOnCreate, 0);
424 =item C<$ValidateUserEmailAddresses>
426 If C<$ValidateUserEmailAddresses> is 1, RT will refuse to create
427 users with an invalid email address (as specified in RFC 2822) or with
428 an email address made of multiple email addresses.
432 Set($ValidateUserEmailAddresses, undef);
434 =item C<@MailPlugins>
436 C<@MailPlugins> is a list of authentication plugins for
437 L<RT::Interface::Email> to use; see L<rt-mailgate>
441 =item C<$UnsafeEmailCommands>
443 C<$UnsafeEmailCommands>, if set to 1, enables 'take' and 'resolve'
444 as possible actions via the mail gateway. As its name implies, this
445 is very unsafe, as it allows email with a forged sender to possibly
446 resolve arbitrary tickets!
450 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
452 The default "extract remote tracking tags" scrip settings; these
453 detect when your RT is talking to another RT, and adjust the subject
458 Set($ExtractSubjectTagMatch, qr/\[[^\]]+? #\d+\]/);
459 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
460 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
461 : qr/\[\Q$RT::rtname\E #\d+\]/));
463 =item C<$CheckMoreMSMailHeaders>
465 Some email clients create a plain text version of HTML-formatted
466 email to help other clients that read only plain text.
467 Unfortunately, the plain text parts sometimes end up with
468 doubled newlines and these can then end up in RT. This
469 is most often seen in MS Outlook.
471 Enable this option to have RT check for additional mail headers
472 and attempt to identify email from MS Outlook. When detected,
473 RT will then clean up double newlines. Note that it may
474 clean up intentional double newlines as well.
478 Set( $CheckMoreMSMailHeaders, 0);
488 =item C<$MailCommand>
490 C<$MailCommand> defines which method RT will use to try to send mail.
491 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
492 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
495 Note that you should remove the '-t' from C<$SendmailArguments> if you
496 use 'sendmail' rather than 'sendmailpipe'
498 For testing purposes, or to simply disable sending mail out into the
499 world, you can set C<$MailCommand> to 'testfile' which writes all mail
500 to a temporary file. RT will log the location of the temporary file
501 so you can extract mail from it afterward.
505 Set($MailCommand, "sendmailpipe");
507 =item C<$SetOutgoingMailFrom>
509 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
510 Correspond mail address of the ticket's queue.
512 Warning: If you use this setting, bounced mails will appear to be
513 incoming mail to the system, thus creating new tickets.
515 This option only works if C<$MailCommand> is set to 'sendmailpipe'.
519 Set($SetOutgoingMailFrom, 0);
521 =item C<$OverrideOutgoingMailFrom>
523 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
524 address of the queue as it is handed to sendmail -f. This helps force
525 the From_ header away from www-data or other email addresses that show
526 up in the "Sent by" line in Outlook.
528 The option is a hash reference of queue name to email address. If
529 there is no ticket involved, then the value of the C<Default> key will
532 This option only works if C<$SetOutgoingMailFrom> is enabled and
533 C<$MailCommand> is set to 'sendmailpipe'.
537 Set($OverrideOutgoingMailFrom, {
538 # 'Default' => 'admin@rt.example.com',
539 # 'General' => 'general@rt.example.com',
542 =item C<$DefaultMailPrecedence>
544 C<$DefaultMailPrecedence> is used to control the default Precedence
545 level of outgoing mail where none is specified. By default it is
546 C<bulk>, but if you only send mail to your staff, you may wish to
549 Note that you can set the precedence of individual templates by
550 including an explicit Precedence header.
552 If you set this value to C<undef> then we do not set a default
553 Precedence header to outgoing mail. However, if there already is a
554 Precedence header, it will be preserved.
558 Set($DefaultMailPrecedence, "bulk");
560 =item C<$DefaultErrorMailPrecedence>
562 C<$DefaultErrorMailPrecedence> is used to control the default
563 Precedence level of outgoing mail that indicates some kind of error
564 condition. By default it is C<bulk>, but if you only send mail to your
565 staff, you may wish to change it.
567 If you set this value to C<undef> then we do not add a Precedence
568 header to error mail.
572 Set($DefaultErrorMailPrecedence, "bulk");
574 =item C<$UseOriginatorHeader>
576 C<$UseOriginatorHeader> is used to control the insertion of an
577 RT-Originator Header in every outgoing mail, containing the mail
578 address of the transaction creator.
582 Set($UseOriginatorHeader, 1);
584 =item C<$UseFriendlyFromLine>
586 By default, RT sets the outgoing mail's "From:" header to "SenderName
587 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
591 Set($UseFriendlyFromLine, 1);
593 =item C<$FriendlyFromLineFormat>
595 C<sprintf()> format of the friendly 'From:' header; its arguments are
596 SenderName and SenderEmailAddress.
600 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
602 =item C<$UseFriendlyToLine>
604 RT can optionally set a "Friendly" 'To:' header when sending messages
605 to Ccs or AdminCcs (rather than having a blank 'To:' header.
607 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
608 are using sendmail, rather than postfix, qmail, exim or some other
609 MTA, you _must_ disable this option.
613 Set($UseFriendlyToLine, 0);
615 =item C<$FriendlyToLineFormat>
617 C<sprintf()> format of the friendly 'To:' header; its arguments are
618 WatcherType and TicketId.
622 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
624 =item C<$NotifyActor>
626 By default, RT doesn't notify the person who performs an update, as
627 they already know what they've done. If you'd like to change this
628 behavior, Set C<$NotifyActor> to 1
632 Set($NotifyActor, 0);
634 =item C<$RecordOutgoingEmail>
636 By default, RT records each message it sends out to its own internal
637 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
639 If this is disabled, users' digest mail delivery preferences
640 (i.e. EmailFrequency) will also be ignored.
644 Set($RecordOutgoingEmail, 1);
646 =item C<$VERPPrefix>, C<$VERPDomain>
648 Setting these options enables VERP support
649 L<http://cr.yp.to/proto/verp.txt>.
651 Uncomment the following two directives to generate envelope senders
652 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
653 (i.e. rt-jesse=fsck.com@rt.example.com ).
655 This currently only works with sendmail and sendmailpipe.
659 # Set($VERPPrefix, "rt-");
660 # Set($VERPDomain, $RT::Organization);
663 =item C<$ForwardFromUser>
665 By default, RT forwards a message using queue's address and adds RT's
666 tag into subject of the outgoing message, so recipients' replies go
667 into RT as correspondents.
669 To change this behavior, set C<$ForwardFromUser> to 1 and RT
670 will use the address of the current user and remove RT's subject tag.
674 Set($ForwardFromUser, 0);
678 =head2 Email dashboards
682 =item C<$DashboardAddress>
684 The email address from which RT will send dashboards. If none is set,
685 then C<$OwnerEmail> will be used.
689 Set($DashboardAddress, '');
691 =item C<$DashboardSubject>
693 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
694 Weekly, Monthly) of the dashboard and the dashboard's name.
698 Set($DashboardSubject, "%s Dashboard: %s");
700 =item C<@EmailDashboardRemove>
702 A list of regular expressions that will be used to remove content from
707 Set(@EmailDashboardRemove, ());
713 =head2 Sendmail configuration
715 These options only take effect if C<$MailCommand> is 'sendmail' or
720 =item C<$SendmailArguments>
722 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
723 If you picked 'sendmailpipe', you MUST add a -t flag to
724 C<$SendmailArguments> These options are good for most sendmail
725 wrappers and work-a-likes.
727 These arguments are good for sendmail brand sendmail 8 and newer:
728 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
732 Set($SendmailArguments, "-oi -t");
735 =item C<$SendmailBounceArguments>
737 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
738 assuming RT needs to send an error (i.e. bounce).
742 Set($SendmailBounceArguments, '-f "<>"');
744 =item C<$SendmailPath>
746 If you selected 'sendmailpipe' above, you MUST specify the path to
747 your sendmail binary in C<$SendmailPath>.
751 Set($SendmailPath, "/usr/sbin/sendmail");
756 =head2 SMTP configuration
758 These options only take effect if C<$MailCommand> is 'smtp'
764 C<$SMTPServer> should be set to the hostname of the SMTP server to use
768 Set($SMTPServer, undef);
772 C<$SMTPFrom> should be set to the 'From' address to use, if not the
777 Set($SMTPFrom, undef);
781 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
795 C<@MailParams> defines a list of options passed to $MailCommand if it
796 is not 'sendmailpipe', 'sendmail', or 'smtp'
800 Set(@MailParams, ());
809 =item C<$WebDefaultStylesheet>
811 This determines the default stylesheet the RT web interface will use.
812 RT ships with several themes by default:
814 web2 The default layout for RT 3.8
815 aileron The default layout for RT 4.0
816 ballard Theme which doesn't rely on JavaScript for menuing
818 This value actually specifies a directory in F<share/html/NoAuth/css/>
819 from which RT will try to load the file main.css (which should @import
820 any other files the stylesheet needs). This allows you to easily and
821 cleanly create your own stylesheets to apply to RT. This option can
822 be overridden by users in their preferences.
826 Set($WebDefaultStylesheet, "aileron");
828 =item C<$DefaultQueue>
830 Use this to select the default queue name that will be used for
831 creating new tickets. You may use either the queue's name or its
832 ID. This only affects the queue selection boxes on the web interface.
836 # Set($DefaultQueue, "General");
838 =item C<$RememberDefaultQueue>
840 When a queue is selected in the new ticket dropdown, make it the new
841 default for the new ticket dropdown.
845 # Set($RememberDefaultQueue, 1);
847 =item C<$EnableReminders>
849 Hide all links and portlets related to Reminders by setting this to 0
853 Set($EnableReminders, 1);
855 =item C<@CustomFieldValuesSources>
857 Set C<@CustomFieldValuesSources> to a list of class names which extend
858 L<RT::CustomFieldValues::External>. This can be used to pull lists of
859 custom field values from external sources at runtime.
863 Set(@CustomFieldValuesSources, ());
865 =item C<$CanonicalizeRedirectURLs>
867 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
868 redirecting rather than the one we get from C<%ENV>.
870 Apache's UseCanonicalName directive changes the hostname that RT
871 finds in C<%ENV>. You can read more about what turning it On or Off
872 means in the documentation for your version of Apache.
874 If you use RT behind a reverse proxy, you almost certainly want to
879 Set($CanonicalizeRedirectURLs, 0);
883 A list of JavaScript files to be included in head. Removing any of
884 the default entries is not suggested.
886 If you're a plugin author, refer to RT->AddJavaScript.
893 jquery-ui-1.8.4.custom.min.js
894 jquery-ui-timepicker-addon.js
895 jquery-ui-patch-datepicker.js
900 jquery.event.hover-1.0.js
903 jquery.supposition.js
910 Path to the jsmin binary; if specified, it will be used to minify
911 C<JSFiles>. The default, and the fallback if the binary cannot be
912 found, is to simply concatenate the files.
914 jsmin can be installed by running 'make jsmin' from the RT install
915 directory, or from http://www.crockford.com/javascript/jsmin.html
919 # Set($JSMinPath, "/path/to/jsmin");
923 A list of additional CSS files to be included in head.
925 If you're a plugin author, refer to RT->AddStyleSheets.
929 Set(@CSSFiles, qw//);
931 =item C<$UsernameFormat>
933 This determines how user info is displayed. 'concise' will show one of
934 either NickName, RealName, Name or EmailAddress, depending on what
935 exists and whether the user is privileged or not. 'verbose' will show
936 RealName and EmailAddress.
940 Set($UsernameFormat, "concise");
942 =item C<$WebBaseURL>, C<$WebURL>
944 Usually you don't want to set these options. The only obvious reason
945 is if RT is accessible via https protocol on a non standard port, e.g.
946 'https://rt.example.com:9999'. In all other cases these options are
947 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
949 C<$WebBaseURL> is the scheme, server and port
950 (e.g. 'http://rt.example.com') for constructing URLs to the web
951 UI. C<$WebBaseURL> doesn't need a trailing /.
953 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
954 example: 'http://www.example.com/rt/'.
958 my $port = RT->Config->Get('WebPort');
960 ($port == 443? 'https': 'http') .'://'
961 . RT->Config->Get('WebDomain')
962 . ($port != 80 && $port != 443? ":$port" : '')
965 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
967 =item C<$WebImagesURL>
969 C<$WebImagesURL> points to the base URL where RT can find its images.
970 Define the directory name to be used for images in RT web documents.
974 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
978 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
979 This can also be configured via the web UI.
983 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
985 =item C<$LogoLinkURL>
987 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
991 Set($LogoLinkURL, "http://bestpractical.com");
993 =item C<$LogoAltText>
995 C<$LogoAltText> is a string of text for the alt-text of the logo. It
996 will be passed through C<loc> for localization.
1000 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1002 =item C<$LogoImageHeight>
1004 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1009 Set($LogoImageHeight, 38);
1011 =item C<$LogoImageWidth>
1013 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1018 Set($LogoImageWidth, 181);
1020 =item C<$WebNoAuthRegex>
1022 What portion of RT's URL space should not require authentication. The
1023 default is almost certainly correct, and should only be changed if you
1028 Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1030 =item C<$SelfServiceRegex>
1032 What portion of RT's URLspace should be accessible to Unprivileged
1033 users This does not override the redirect from F</Ticket/Display.html>
1034 to F</SelfService/Display.html> when Unprivileged users attempt to
1035 access ticked displays.
1039 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1041 =item C<$WebFlushDbCacheEveryRequest>
1043 By default, RT clears its database cache after every page view. This
1044 ensures that you've always got the most current information when
1045 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1046 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1047 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1051 Set($WebFlushDbCacheEveryRequest, 1);
1055 The L<GD> module (which RT uses for graphs) ships with a built-in font
1056 that doesn't have full Unicode support. You can use a given TrueType
1057 font for a specific language by setting %ChartFont to (language =E<gt>
1058 the absolute path of a font) pairs. Your GD library must have support
1059 for TrueType fonts to use this option. If there is no entry for a
1060 language in the hash then font with 'others' key is used.
1062 RT comes with two TrueType fonts covering most available languages.
1068 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1069 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1070 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1071 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1074 =item C<$ChartsTimezonesInDB>
1076 RT stores dates using the UTC timezone in the DB, so charts grouped by
1077 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1078 to enable timezone conversions using your DB's capabilities. You may
1079 need to do some work on the DB side to use this feature, read more in
1080 F<docs/customizing/timezones_in_charts.pod>.
1082 At this time, this feature only applies to MySQL and PostgreSQL.
1086 Set($ChartsTimezonesInDB, 0);
1096 =item C<$DefaultSummaryRows>
1098 C<$DefaultSummaryRows> is default number of rows displayed in for
1099 search results on the front page.
1103 Set($DefaultSummaryRows, 10);
1105 =item C<$HomePageRefreshInterval>
1107 C<$HomePageRefreshInterval> is default number of seconds to refresh
1108 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1112 Set($HomePageRefreshInterval, 0);
1114 =item C<$HomepageComponents>
1116 C<$HomepageComponents> is an arrayref of allowed components on a
1117 user's customized homepage ("RT at a glance").
1122 $HomepageComponents,
1124 qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches) # loc_qw
1133 =head2 Ticket search
1137 =item C<$UseSQLForACLChecks>
1139 Historically, ACLs were checked on display, which could lead to empty
1140 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1141 to limit search results in SQL instead, which eliminates these
1144 This option is still relatively new; it may result in performance
1145 problems in some cases, or significant speedups in others.
1149 Set($UseSQLForACLChecks, undef);
1151 =item C<$TicketsItemMapSize>
1153 On the display page of a ticket from search results, RT provides links
1154 to the first, next, previous and last ticket from the results. In
1155 order to build these links, RT needs to fetch the full result set from
1156 the database, which can be resource-intensive.
1158 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1159 to build these links. If the full result set is larger than this
1160 number, RT will omit the "last" link in the menu. Set this to zero to
1161 always examine all results.
1165 Set($TicketsItemMapSize, 1000);
1167 =item C<$SearchResultsRefreshInterval>
1169 C<$SearchResultsRefreshInterval> is default number of seconds to
1170 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1175 Set($SearchResultsRefreshInterval, 0);
1177 =item C<$DefaultSearchResultFormat>
1179 C<$DefaultSearchResultFormat> is the default format for RT search
1184 Set ($DefaultSearchResultFormat, qq{
1185 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1186 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1193 '<small>__Requestors__</small>',
1194 '<small>__CreatedRelative__</small>',
1195 '<small>__ToldRelative__</small>',
1196 '<small>__LastUpdatedRelative__</small>',
1197 '<small>__TimeLeft__</small>'});
1199 =item C<$DefaultSelfServiceSearchResultFormat>
1201 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1202 searches displayed in the SelfService interface.
1206 Set($DefaultSelfServiceSearchResultFormat, qq{
1207 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1208 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1213 =item C<%FullTextSearch>
1215 Full text search (FTS) without database indexing is a very slow
1216 operation, and is thus disabled by default.
1218 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1219 the full details of FTS on your particular database.
1221 It is possible to enable FTS without database indexing support, simply
1222 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1223 This is not generally suggested, as unindexed full-text searching can
1224 cause severe performance problems.
1228 Set(%FullTextSearch,
1233 =item C<$DontSearchFileAttachments>
1235 If C<$DontSearchFileAttachments> is set to 1, then uploaded files
1236 (attachments with file names) are not searched during content
1239 Note that if you use indexed FTS then named attachments are still
1240 indexed by default regardless of this option.
1244 Set($DontSearchFileAttachments, undef);
1246 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1248 When query in simple search doesn't have status info, use this to only
1253 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1255 =item C<$SearchResultsAutoRedirect>
1257 When only one ticket is found in search, use this to redirect to the
1258 ticket display page automatically.
1262 Set($SearchResultsAutoRedirect, 0);
1268 =head2 Ticket display
1272 =item C<$ShowMoreAboutPrivilegedUsers>
1274 This determines if the 'More about requestor' box on
1275 Ticket/Display.html is shown for Privileged Users.
1279 Set($ShowMoreAboutPrivilegedUsers, 0);
1281 =item C<$MoreAboutRequestorTicketList>
1283 This can be set to Active, Inactive, All or None. It controls what
1284 ticket list will be displayed in the 'More about requestor' box on
1285 Ticket/Display.html. This option can be controlled by users also.
1289 Set($MoreAboutRequestorTicketList, "Active");
1291 =item C<$MoreAboutRequestorExtraInfo>
1293 By default, the 'More about requestor' box on Ticket/Display.html
1294 shows the Requestor's name and ticket list. If you would like to see
1295 extra information about the user, this expects a Format string of user
1296 attributes. Please note that not all the attributes are supported in
1297 this display because we're not building a table.
1300 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1304 Set($MoreAboutRequestorExtraInfo, "");
1306 =item C<$MoreAboutRequestorGroupsLimit>
1308 By default, the 'More about requestor' box on Ticket/Display.html
1309 shows all the groups of the Requestor. Use this to limit the number
1310 of groups; a value of undef removes the group display entirely.
1314 Set($MoreAboutRequestorGroupsLimit, 0);
1316 =item C<$UseSideBySideLayout>
1318 Should the ticket create and update forms use a more space efficient
1319 two column layout. This layout may not work in narrow browsers if you
1320 set a MessageBoxWidth (below).
1324 Set($UseSideBySideLayout, 1);
1326 =item C<$EditCustomFieldsSingleColumn>
1328 When displaying a list of Ticket Custom Fields for editing, RT
1329 defaults to a 2 column list. If you set this to 1, it will instead
1330 display the Custom Fields in a single column.
1334 Set($EditCustomFieldsSingleColumn, 0);
1336 =item C<$ShowUnreadMessageNotifications>
1338 If set to 1, RT will prompt users when there are new,
1339 unread messages on tickets they are viewing.
1343 Set($ShowUnreadMessageNotifications, 0);
1345 =item C<$AutocompleteOwners>
1347 If set to 1, the owner drop-downs for ticket update/modify and the query
1348 builder are replaced by text fields that autocomplete. This can
1349 alleviate the sometimes huge owner list for installations where many
1350 users have the OwnTicket right.
1354 Set($AutocompleteOwners, 0);
1356 =item C<$AutocompleteOwnersForSearch>
1358 If set to 1, the owner drop-downs for the query builder are always
1359 replaced by text field that autocomplete and C<$AutocompleteOwners>
1360 is ignored. Helpful when owners list is huge in the query builder.
1364 Set($AutocompleteOwnersForSearch, 0);
1366 =item C<$UserAutocompleteFields>
1368 Specifies which fields of L<RT::User> to match against and how to
1369 match each field when autocompleting users. Valid match methods are
1370 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1374 Set($UserAutocompleteFields, {
1375 EmailAddress => 'STARTSWITH',
1376 Name => 'STARTSWITH',
1380 =item C<$AllowUserAutocompleteForUnprivileged>
1382 Should unprivileged users be allowed to autocomplete users. Setting
1383 this option to 1 means unprivileged users will be able to search all
1388 Set($AllowUserAutocompleteForUnprivileged, 0);
1390 =item C<$DisplayTicketAfterQuickCreate>
1392 Enable this to redirect to the created ticket display page
1393 automatically when using QuickCreate.
1397 Set($DisplayTicketAfterQuickCreate, 0);
1399 =item C<$WikiImplicitLinks>
1401 Support implicit links in WikiText custom fields? Setting this to 1
1402 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1403 become links to searches for those words. If used on Articles, it links
1404 to the Article with that name.
1408 Set($WikiImplicitLinks, 0);
1410 =item C<$PreviewScripMessages>
1412 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1413 reply page should include the content of the messages to be sent.
1417 Set($PreviewScripMessages, 0);
1419 =item C<$SimplifiedRecipients>
1421 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1422 B<any> kind of mail will be shown on the ticket reply page, instead of a
1423 detailed breakdown by scrip.
1427 Set($SimplifiedRecipients, 0);
1429 =item C<$HideResolveActionsWithDependencies>
1431 If set to 1, this option will skip ticket menu actions which can't be
1432 completed successfully because of outstanding active Depends On tickets.
1434 By default, all ticket actions are displayed in the menu even if some of
1435 them can't be successful until all Depends On links are resolved or
1436 transitioned to another inactive status.
1440 Set($HideResolveActionsWithDependencies, 0);
1450 =item C<$ArticleOnTicketCreate>
1452 Set this to 1 to display the Articles interface on the Ticket Create
1453 page in addition to the Reply/Comment page.
1457 Set($ArticleOnTicketCreate, 0);
1459 =item C<$HideArticleSearchOnReplyCreate>
1461 Set this to 1 to hide the search and include boxes from the Article
1462 UI. This assumes you have enabled Article Hotlist feature, otherwise
1463 you will have no access to Articles.
1467 Set($HideArticleSearchOnReplyCreate, 0);
1473 =head2 Message box properties
1477 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1479 For message boxes, set the entry box width, height and what type of
1480 wrapping to use. These options can be overridden by users in their
1483 When the width is set to undef, no column count is specified and the
1484 message box will take up 100% of the available width. Combining this
1485 with HARD messagebox wrapping (below) is not recommended, as it will
1486 lead to inconsistent width in transactions between browsers.
1488 These settings only apply to the non-RichText message box. See below
1489 for Rich Text settings.
1493 Set($MessageBoxWidth, undef);
1494 Set($MessageBoxHeight, 15);
1496 =item C<$MessageBoxWrap>
1498 Wrapping is disabled when using MessageBoxRichText because of a bad
1499 interaction between IE and wrapping with the Rich Text Editor.
1503 Set($MessageBoxWrap, "SOFT");
1505 =item C<$MessageBoxRichText>
1507 Should "rich text" editing be enabled? This option lets your users
1508 send HTML email messages from the web interface.
1512 Set($MessageBoxRichText, 1);
1514 =item C<$MessageBoxRichTextHeight>
1516 Height of rich text JavaScript enabled editing boxes (in pixels)
1520 Set($MessageBoxRichTextHeight, 200);
1522 =item C<$MessageBoxIncludeSignature>
1524 Should your users' signatures (from their Preferences page) be
1525 included in Comments and Replies.
1529 Set($MessageBoxIncludeSignature, 1);
1531 =item C<$MessageBoxIncludeSignatureOnComment>
1533 Should your users' signatures (from their Preferences page) be
1534 included in Comments. Setting this to false overrides
1535 C<$MessageBoxIncludeSignature>.
1539 Set($MessageBoxIncludeSignatureOnComment, 1);
1544 =head2 Transaction display
1548 =item C<$OldestTransactionsFirst>
1550 By default, RT shows newest transactions at the bottom of the ticket
1551 history page, if you want see them at the top set this to 0. This
1552 option can be overridden by users in their preferences.
1556 Set($OldestTransactionsFirst, 1);
1558 =item C<$DeferTransactionLoading>
1560 When set, defers loading ticket history until the user clicks a link.
1561 This should end up serving pages to users quicker, since generating
1562 all the HTML for transaction history can be slow for long tickets.
1566 # Set($DeferTransactionLoading, 1);
1568 =item C<$ShowBccHeader>
1570 By default, RT hides from the web UI information about blind copies
1571 user sent on reply or comment.
1575 Set($ShowBccHeader, 0);
1577 =item C<$TrustHTMLAttachments>
1579 If C<TrustHTMLAttachments> is not defined, we will display them as
1580 text. This prevents malicious HTML and JavaScript from being sent in a
1581 request (although there is probably more to it than that)
1585 Set($TrustHTMLAttachments, undef);
1587 =item C<$AlwaysDownloadAttachments>
1589 Always download attachments, regardless of content type. If set, this
1590 overrides C<TrustHTMLAttachments>.
1594 Set($AlwaysDownloadAttachments, undef);
1596 =item C<$AttachmentUnits>
1598 Controls the units (kilobytes or bytes) that attachment sizes use for
1599 display. The default is to display kilobytes if the attachment is
1600 larger than 1024 bytes, bytes otherwise. If you set
1601 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1602 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1606 Set($AttachmentUnits, undef);
1608 =item C<$PreferRichText>
1610 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1611 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1612 show only a minimal subset of HTML to avoid possible contamination by
1613 cross-site-scripting attacks.
1617 Set($PreferRichText, undef);
1619 =item C<$MaxInlineBody>
1621 C<$MaxInlineBody> is the maximum attachment size that we want to see
1622 inline when viewing a transaction. RT will inline any text if the
1623 value is undefined or 0. This option can be overridden by users in
1628 Set($MaxInlineBody, 12000);
1630 =item C<$ShowTransactionImages>
1632 By default, RT shows images attached to incoming (and outgoing) ticket
1633 updates inline. Set this variable to 0 if you'd like to disable that
1638 Set($ShowTransactionImages, 1);
1640 =item C<$PlainTextPre>
1642 Normally plaintext attachments are displayed as HTML with line breaks
1643 preserved. This causes space- and tab-based formatting not to be
1644 displayed correctly. By setting $PlainTextPre messages will be
1645 displayed using <pre>.
1649 Set($PlainTextPre, 0);
1652 =item C<$PlainTextMono>
1654 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1655 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1656 of the browser window; this option overrides C<$PlainTextPre>.
1660 Set($PlainTextMono, 0);
1662 =item C<$SuppressInlineTextFiles>
1664 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1665 (text-type attachments with file names) are prevented from being
1666 displayed in-line when viewing a ticket's history.
1670 Set($SuppressInlineTextFiles, undef);
1673 =item C<@Active_MakeClicky>
1675 MakeClicky detects various formats of data in headers and email
1676 messages, and extends them with supporting links. By default, RT
1677 provides two formats:
1679 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1682 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1683 replaces the URL with a link.
1685 See F<share/html/Elements/MakeClicky> for documentation on how to add
1686 your own styles of link detection.
1690 Set(@Active_MakeClicky, qw());
1696 =head1 Application logic
1700 =item C<$ParseNewMessageForTicketCcs>
1702 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1703 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1704 messages. Be forewarned that if you have I<any> addresses which forward
1705 mail to RT automatically and you enable this option without modifying
1706 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1710 Set($ParseNewMessageForTicketCcs, undef);
1712 =item C<$UseTransactionBatch>
1714 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1715 such that a resolve and comment (for example) would happen
1716 simultaneously, instead of as two transactions, unaware of each
1721 Set($UseTransactionBatch, 1);
1723 =item C<$StrictLinkACL>
1725 When this feature is enabled a user needs I<ModifyTicket> rights on
1726 both tickets to link them together; otherwise, I<ModifyTicket> rights
1727 on either of them is sufficient.
1731 Set($StrictLinkACL, 1);
1733 =item C<$RedistributeAutoGeneratedMessages>
1735 Should RT redistribute correspondence that it identifies as machine
1736 generated? A 1 will do so; setting this to 0 will cause no
1737 such messages to be redistributed. You can also use 'privileged' (the
1738 default), which will redistribute only to privileged users. This helps
1739 to protect against malformed bounces and loops caused by auto-created
1740 requestors with bogus addresses.
1744 Set($RedistributeAutoGeneratedMessages, "privileged");
1746 =item C<$ApprovalRejectionNotes>
1748 Should rejection notes from approvals be sent to the requestors?
1752 Set($ApprovalRejectionNotes, 1);
1754 =item C<$ForceApprovalsView>
1756 Should approval tickets only be viewed and modified through the standard
1757 approval interface? Changing this setting to 1 will redirect any attempt to
1758 use the normal ticket display and modify page for approval tickets.
1760 For example, with this option set to 1 and an approval ticket #123:
1762 /Ticket/Display.html?id=123
1766 /Approval/Display.html?id=123
1772 Set($ForceApprovalsView, 0);
1774 =head1 Extra security
1776 This is a list of extra security measures to enable that help keep your RT
1777 safe. If you don't know what these mean, you should almost certainly leave the
1782 =item C<$DisallowExecuteCode>
1784 If set to a true value, the C<ExecuteCode> right will be removed from
1785 all users, B<including> the superuser. This is intended for when RT is
1786 installed into a shared environment where even the superuser should not
1787 be allowed to run arbitrary Perl code on the server via scrips.
1791 Set($DisallowExecuteCode, 0);
1793 =item C<$Framebusting>
1795 If set to a false value, framekiller javascript will be disabled and the
1796 X-Frame-Options: DENY header will be suppressed from all responses.
1797 This disables RT's clickjacking protection.
1801 Set($Framebusting, 1);
1803 =item C<$RestrictReferrer>
1805 If set to a false value, the HTTP C<Referer> (sic) header will not be
1806 checked to ensure that requests come from RT's own domain. As RT allows
1807 for GET requests to alter state, disabling this opens RT up to
1808 cross-site request forgery (CSRF) attacks.
1812 Set($RestrictReferrer, 1);
1814 =item C<$RestrictLoginReferrer>
1816 If set to a false value, RT will allow the user to log in from any link
1817 or request, merely by passing in C<user> and C<pass> parameters; setting
1818 it to a true value forces all logins to come from the login box, so the
1819 user is aware that they are being logged in. The default is off, for
1820 backwards compatability.
1824 Set($RestrictLoginReferrer, 0);
1826 =item C<@ReferrerWhitelist>
1828 This is a list of hostname:port combinations that RT will treat as being
1829 part of RT's domain. This is particularly useful if you access RT as
1830 multiple hostnames or have an external auth system that needs to
1831 redirect back to RT once authentication is complete.
1833 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1835 If the "RT has detected a possible cross-site request forgery" error is triggered
1836 by a host:port sent by your browser that you believe should be valid, you can copy
1837 the host:port from the error message into this list.
1839 Simple wildcards, similar to SSL certificates, are allowed. For example:
1841 *.example.com:80 # matches foo.example.com
1842 # but not example.com
1843 # or foo.bar.example.com
1845 www*.example.com:80 # matches www3.example.com
1846 # and www-test.example.com
1847 # and www.example.com
1851 Set(@ReferrerWhitelist, qw());
1857 =head1 Authorization and user configuration
1861 =item C<$WebExternalAuth>
1863 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1864 REMOTE_USER variable.
1868 Set($WebExternalAuth, undef);
1870 =item C<$WebExternalAuthContinuous>
1872 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1873 REMOTE_USER on each access. If you would prefer this to only happen
1874 once (at initial login) set this to a false value. The default
1875 setting will help ensure that if your external authentication system
1876 deauthenticates a user, RT notices as soon as possible.
1880 Set($WebExternalAuthContinuous, 1);
1882 =item C<$WebFallbackToInternalAuth>
1884 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1885 chance of fallback to the login screen, even if REMOTE_USER failed.
1889 Set($WebFallbackToInternalAuth, undef);
1891 =item C<$WebExternalGecos>
1893 C<$WebExternalGecos> means to match 'gecos' field as the user
1894 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1899 Set($WebExternalGecos, undef);
1901 =item C<$WebExternalAuto>
1903 C<$WebExternalAuto> will create users under the same name as
1904 REMOTE_USER upon login, if it's missing in the Users table.
1908 Set($WebExternalAuto, undef);
1910 =item C<$AutoCreate>
1912 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1913 User's Create method. Use it to set defaults, such as creating
1914 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1918 Set($AutoCreate, undef);
1920 =item C<$WebSessionClass>
1922 C<$WebSessionClass> is the class you wish to use for managing sessions.
1923 It defaults to use your SQL database, except on Oracle, where it
1924 defaults to files on disk.
1928 # Set($WebSessionClass, "Apache::Session::File");
1930 =item C<$AutoLogoff>
1932 By default, RT's user sessions persist until a user closes his or her
1933 browser. With the C<$AutoLogoff> option you can setup session lifetime
1934 in minutes. A user will be logged out if he or she doesn't send any
1935 requests to RT for the defined time.
1939 Set($AutoLogoff, 0);
1941 =item C<$LogoutRefresh>
1943 The number of seconds to wait after logout before sending the user to
1944 the login page. By default, 1 second, though you may want to increase
1945 this if you display additional information on the logout page.
1949 Set($LogoutRefresh, 1);
1951 =item C<$WebSecureCookies>
1953 By default, RT's session cookie isn't marked as "secure". Some web
1954 browsers will treat secure cookies more carefully than non-secure
1955 ones, being careful not to write them to disk, only sending them over
1956 an SSL secured connection, and so on. To enable this behavior, set
1957 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1958 on I<unless> users are only connecting via SSL encrypted HTTPS
1963 Set($WebSecureCookies, 0);
1965 =item C<$WebHttpOnlyCookies>
1967 Default RT's session cookie to not being directly accessible to
1968 javascript. The content is still sent during regular and AJAX requests,
1969 and other cookies are unaffected, but the session-id is less
1970 programmatically accessible to javascript. Turning this off should only
1971 be necessary in situations with odd client-side authentication
1976 Set($WebHttpOnlyCookies, 1);
1978 =item C<$MinimumPasswordLength>
1980 C<$MinimumPasswordLength> defines the minimum length for user
1981 passwords. Setting it to 0 disables this check.
1985 Set($MinimumPasswordLength, 5);
1990 =head1 Internationalization
1994 =item C<@LexiconLanguages>
1996 An array that contains languages supported by RT's
1997 internationalization interface. Defaults to all *.po lexicons;
1998 setting it to C<qw(en ja)> will make RT bilingual instead of
1999 multilingual, but will save some memory.
2003 Set(@LexiconLanguages, qw(*));
2005 =item C<@EmailInputEncodings>
2007 An array that contains default encodings used to guess which charset
2008 an attachment uses, if it does not specify one explicitly. All
2009 options must be recognized by L<Encode::Guess>. The first element may
2010 also be '*', which enables encoding detection using
2011 L<Encode::Detect::Detector>, if installed.
2015 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
2017 =item C<$EmailOutputEncoding>
2019 The charset for localized email. Must be recognized by Encode.
2023 Set($EmailOutputEncoding, "utf-8");
2033 =head1 Date and time handling
2037 =item C<$DateTimeFormat>
2039 You can choose date and time format. See the "Output formatters"
2040 section in perldoc F<lib/RT/Date.pm> for more options. This option
2041 can be overridden by users in their preferences.
2045 C<Set($DateTimeFormat, "LocalizedDateTime");>
2046 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2047 C<Set($DateTimeFormat, "RFC2822");>
2048 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2052 Set($DateTimeFormat, "DefaultFormat");
2054 # Next two options are for Time::ParseDate
2056 =item C<$DateDayBeforeMonth>
2058 Set this to 1 if your local date convention looks like "dd/mm/yy"
2059 instead of "mm/dd/yy". Used only for parsing, not for displaying
2064 Set($DateDayBeforeMonth, 1);
2066 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2068 Should an unspecified day or year in a date refer to a future or a
2069 past value? For example, should a date of "Tuesday" default to mean
2070 the date for next Tuesday or last Tuesday? Should the date "March 1"
2071 default to the date for next March or last March?
2073 Set C<$AmbiguousDayInPast> for the last date, or
2074 C<$AmbiguousDayInFuture> for the next date; the default is usually
2075 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2079 Set($AmbiguousDayInPast, 0);
2080 Set($AmbiguousDayInFuture, 0);
2082 =item C<$DefaultTimeUnitsToHours>
2084 Use this to set the default units for time entry to hours instead of
2085 minutes. Note that this only effects entry, not display.
2089 Set($DefaultTimeUnitsToHours, 0);
2096 =head1 GnuPG integration
2098 A full description of the (somewhat extensive) GnuPG integration can
2099 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2100 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2106 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2107 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2109 If you want to allow people to encrypt attachments inside the DB then
2110 set C<AllowEncryptDataInDB> to 1.
2112 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2113 emails encrypted for key RT doesn't have and can not decrypt.
2115 Set C<RejectOnBadData> to false if you don't want to reject letters
2116 with incorrect GnuPG data.
2122 OutgoingMessagesFormat => "RFC", # Inline
2123 AllowEncryptDataInDB => 0,
2125 RejectOnMissingPrivateKey => 1,
2126 RejectOnBadData => 1,
2129 =item C<%GnuPGOptions>
2131 Options to pass to the GnuPG program.
2133 If you override this in your RT_SiteConfig, you should be sure to
2134 include a homedir setting.
2136 Note that options with '-' character MUST be quoted.
2141 homedir => q{var/data/gpg},
2143 # URL of a keyserver
2144 # keyserver => 'hkp://subkeys.pgp.net',
2146 # enables the automatic retrieving of keys when encrypting
2147 # 'auto-key-locate' => 'keyserver',
2149 # enables the automatic retrieving of keys when verifying signatures
2150 # 'auto-key-retrieve' => undef,
2159 =head2 Lifecycle definitions
2161 Each lifecycle is a list of possible statuses split into three logic
2162 sets: B<initial>, B<active> and B<inactive>. Each status in a
2163 lifecycle must be unique. (Statuses may not be repeated across sets.)
2164 Each set may have any number of statuses.
2170 active => ['open', 'stalled'],
2171 inactive => ['resolved', 'rejected', 'deleted'],
2175 Status names can be from 1 to 64 ASCII characters. Statuses are
2176 localized using RT's standard internationalization and localization
2183 You can define multiple B<initial> statuses for tickets in a given
2186 RT will automatically set its B<Started> date when you change a
2187 ticket's status from an B<initial> state to an B<active> or
2192 B<Active> tickets are "currently in play" - they're things that are
2193 being worked on and not yet complete.
2197 B<Inactive> tickets are typically in their "final resting state".
2199 While you're free to implement a workflow that ignores that
2200 description, typically once a ticket enters an inactive state, it will
2201 never again enter an active state.
2203 RT will automatically set the B<Resolved> date when a ticket's status
2204 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2207 B<deleted> is still a special status and protected by the
2208 B<DeleteTicket> right, unless you re-defined rights (read below). If
2209 you don't want to allow ticket deletion at any time simply don't
2210 include it in your lifecycle.
2214 Statuses in each set are ordered and listed in the UI in the defined
2217 Changes between statuses are constrained by transition rules, as
2220 =head2 Default values
2222 In some cases a default value is used to display in UI or in API when
2223 value is not provided. You can configure defaults using the following
2230 on_resolve => 'resolved',
2235 The following defaults are used.
2241 If you (or your code) doesn't specify a status when creating a ticket,
2242 RT will use the this status. See also L</Statuses available during
2247 When tickets are merged, the status of the ticket that was merged
2248 away is forced to this value. It should be one of inactive statuses;
2249 'resolved' or its equivalent is most probably the best candidate.
2253 When an approval is accepted, the status of depending tickets will
2254 be changed to this value.
2258 When an approval is denied, the status of depending tickets will
2259 be changed to this value.
2261 =item reminder_on_open
2263 When a reminder is opened, the status will be changed to this value.
2265 =item reminder_on_resolve
2267 When a reminder is resolved, the status will be changed to this value.
2271 =head2 Transitions between statuses and UI actions
2273 A B<Transition> is a change of status from A to B. You should define
2274 all possible transitions in each lifecycle using the following format:
2279 '' => [qw(new open resolved)],
2280 new => [qw(open resolved rejected deleted)],
2281 open => [qw(stalled resolved rejected deleted)],
2282 stalled => [qw(open)],
2283 resolved => [qw(open)],
2284 rejected => [qw(open)],
2285 deleted => [qw(open)],
2290 =head3 Statuses available during ticket creation
2292 By default users can create tickets with a status of new,
2293 open, or resolved, but cannot create tickets with a status of
2294 rejected, stalled, or deleted. If you want to change the statuses
2295 available during creation, update the transition from '' (empty
2296 string), like in the example above.
2298 =head3 Protecting status changes with rights
2300 A transition or group of transitions can be protected by a specific
2301 right. Additionally, you can name new right names, which will be added
2302 to the system to control that transition. For example, if you wished to
2303 create a lesser right than ModifyTicket for rejecting tickets, you could
2309 '* -> deleted' => 'DeleteTicket',
2310 '* -> rejected' => 'RejectTicket',
2311 '* -> *' => 'ModifyTicket',
2316 This would create a new C<RejectTicket> right in the system which you
2317 could assign to whatever groups you choose.
2319 On the left hand side you can have the following variants:
2326 Valid transitions are listed in order of priority. If a user attempts
2327 to change a ticket's status from B<new> to B<open> then the lifecycle
2328 is checked for presence of an exact match, then for 'any to B<open>',
2329 'B<new> to any' and finally 'any to any'.
2331 If you don't define any rights, or there is no match for a transition,
2332 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2334 =head3 Labeling and defining actions
2336 For each transition you can define an action that will be shown in the
2337 UI; each action annotated with a label and an update type.
2339 Each action may provide a default update type, which can be
2340 B<Comment>, B<Respond>, or absent. For example, you may want your
2341 staff to write a reply to the end user when they change status from
2342 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2343 B<Comment> nor B<Respond> are mandatory, and user may leave the
2344 message empty, regardless of the update type.
2346 This configuration can be used to accomplish what
2347 $ResolveDefaultUpdateType was used for in RT 3.8.
2349 Use the following format to define labels and actions of transitions:
2354 'new -> open' => { label => 'Open it', update => 'Respond' },
2355 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2356 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2357 'new -> deleted' => { label => 'Delete' },
2359 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2360 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2361 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2363 'stalled -> open' => { label => 'Open it' },
2364 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2365 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2366 'deleted -> open' => { label => 'Undelete' },
2371 In addition, you may define multiple actions for the same transition.
2372 Alternately, you may use '* -> x' to match more than one transition.
2379 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2380 'new -> rejected' => { label => 'Quick Reject' },
2382 '* -> deleted' => { label => 'Delete' },
2388 =head2 Moving tickets between queues with different lifecycles
2390 Unless there is an explicit mapping between statuses in two different
2391 lifecycles, you can not move tickets between queues with these
2392 lifecycles. This is true even if the different lifecycles use the exact
2393 same set of statuses. Such a mapping is defined as follows:
2396 'from lifecycle -> to lifecycle' => {
2397 'status in left lifecycle' => 'status in right lifecycle',
2407 initial => [ 'new' ],
2408 active => [ 'open', 'stalled' ],
2409 inactive => [ 'resolved', 'rejected', 'deleted' ],
2413 on_merge => 'resolved',
2415 denied => 'rejected',
2416 reminder_on_open => 'open',
2417 reminder_on_resolve => 'resolved',
2421 '' => [qw(new open resolved)],
2423 # from => [ to list ],
2424 new => [qw(open stalled resolved rejected deleted)],
2425 open => [qw(new stalled resolved rejected deleted)],
2426 stalled => [qw(new open rejected resolved deleted)],
2427 resolved => [qw(new open stalled rejected deleted)],
2428 rejected => [qw(new open stalled resolved deleted)],
2429 deleted => [qw(new open stalled rejected resolved)],
2432 '* -> deleted' => 'DeleteTicket',
2433 '* -> *' => 'ModifyTicket',
2437 label => 'Open It', # loc
2438 update => 'Respond',
2440 'new -> resolved' => {
2441 label => 'Resolve', # loc
2442 update => 'Comment',
2444 'new -> rejected' => {
2445 label => 'Reject', # loc
2446 update => 'Respond',
2448 'new -> deleted' => {
2449 label => 'Delete', # loc
2452 'open -> stalled' => {
2453 label => 'Stall', # loc
2454 update => 'Comment',
2456 'open -> resolved' => {
2457 label => 'Resolve', # loc
2458 update => 'Comment',
2460 'open -> rejected' => {
2461 label => 'Reject', # loc
2462 update => 'Respond',
2465 'stalled -> open' => {
2466 label => 'Open It', # loc
2468 'resolved -> open' => {
2469 label => 'Re-open', # loc
2470 update => 'Comment',
2472 'rejected -> open' => {
2473 label => 'Re-open', # loc
2474 update => 'Comment',
2476 'deleted -> open' => {
2477 label => 'Undelete', # loc
2481 # don't change lifecyle of the approvals, they are not capable to deal with
2484 initial => [ 'new' ],
2485 active => [ 'open', 'stalled' ],
2486 inactive => [ 'resolved', 'rejected', 'deleted' ],
2490 on_merge => 'resolved',
2491 reminder_on_open => 'open',
2492 reminder_on_resolve => 'resolved',
2496 '' => [qw(new open resolved)],
2498 # from => [ to list ],
2499 new => [qw(open stalled resolved rejected deleted)],
2500 open => [qw(new stalled resolved rejected deleted)],
2501 stalled => [qw(new open rejected resolved deleted)],
2502 resolved => [qw(new open stalled rejected deleted)],
2503 rejected => [qw(new open stalled resolved deleted)],
2504 deleted => [qw(new open stalled rejected resolved)],
2507 '* -> deleted' => 'DeleteTicket',
2508 '* -> rejected' => 'ModifyTicket',
2509 '* -> *' => 'ModifyTicket',
2513 label => 'Open It', # loc
2514 update => 'Respond',
2516 'new -> resolved' => {
2517 label => 'Resolve', # loc
2518 update => 'Comment',
2520 'new -> rejected' => {
2521 label => 'Reject', # loc
2522 update => 'Respond',
2524 'new -> deleted' => {
2525 label => 'Delete', # loc
2528 'open -> stalled' => {
2529 label => 'Stall', # loc
2530 update => 'Comment',
2532 'open -> resolved' => {
2533 label => 'Resolve', # loc
2534 update => 'Comment',
2536 'open -> rejected' => {
2537 label => 'Reject', # loc
2538 update => 'Respond',
2541 'stalled -> open' => {
2542 label => 'Open It', # loc
2544 'resolved -> open' => {
2545 label => 'Re-open', # loc
2546 update => 'Comment',
2548 'rejected -> open' => {
2549 label => 'Re-open', # loc
2550 update => 'Comment',
2552 'deleted -> open' => {
2553 label => 'Undelete', # loc
2563 =head1 Administrative interface
2567 =item C<$ShowRTPortal>
2569 RT can show administrators a feed of recent RT releases and other
2570 related announcements and information from Best Practical on the top
2571 level Configuration page. This feature helps you stay up to date on
2572 RT security announcements and version updates.
2574 RT provides this feature using an "iframe" on C</Admin/index.html>
2575 which asks the administrator's browser to show an inline page from
2576 Best Practical's website.
2578 If you'd rather not make this feature available to your
2579 administrators, set C<$ShowRTPortal> to a false value.
2583 Set($ShowRTPortal, 1);
2585 =item C<%AdminSearchResultFormat>
2587 In the admin interface, format strings similar to tickets result
2588 formats are used. Use C<%AdminSearchResultFormat> to define the format
2589 strings used in the admin interface on a per-RT-class basis.
2593 Set(%AdminSearchResultFormat,
2595 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2596 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2597 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__,__Lifecycle__},
2600 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2601 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2602 .q{,'__Description__'},
2605 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2606 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2607 .q{,__RealName__, __EmailAddress__},
2610 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2611 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2612 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2615 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2616 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2617 .q{,__Stage__, __Condition__, __Action__, __Template__},
2620 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2621 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2622 .q{,__Stage__, __Condition__, __Action__, __Template__},
2625 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2626 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2627 .q{,'__Description__'},
2629 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2630 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2631 .q{,__Description__},
2639 =head1 Development options
2645 RT comes with a "Development mode" setting. This setting, as a
2646 convenience for developers, turns on several of development options
2647 that you most likely don't want in production:
2653 Disables CSS and JS minification and concatenation. Both CSS and JS
2654 will be instead be served as a number of individual smaller files,
2655 unchanged from how they are stored on disk.
2659 Uses L<Module::Refresh> to reload changed Perl modules on each
2664 Turns off Mason's C<static_source> directive; this causes Mason to
2665 reload template files which have been modified on disk.
2669 Turns on Mason's HTML C<error_format>; this renders compilation errors
2670 to the browser, along with a full stack trace. It is possible for
2671 stack traces to reveal sensitive information such as passwords or
2676 Turns off caching of callbacks; this enables additional callbacks to
2677 be added while the server is running.
2683 Set($DevelMode, "0");
2686 =item C<$RecordBaseClass>
2688 What abstract base class should RT use for its records. You should
2689 probably never change this.
2691 Valid values are C<DBIx::SearchBuilder::Record> or
2692 C<DBIx::SearchBuilder::Record::Cachable>
2696 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2699 =item C<@MasonParameters>
2701 C<@MasonParameters> is the list of parameters for the constructor of
2702 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2703 debugging, e.g. profiling individual components with:
2705 use MasonX::Profiler; # available on CPAN
2706 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2710 Set(@MasonParameters, ());
2712 =item C<$StatementLog>
2714 RT has rudimentary SQL statement logging support; simply set
2715 C<$StatementLog> to be the level that you wish SQL statements to be
2718 Enabling this option will also expose the SQL Queries page in the
2719 Configuration -> Tools menu for SuperUsers.
2723 Set($StatementLog, undef);
2730 =head1 Deprecated options
2734 =item C<$LinkTransactionsRun1Scrip>
2736 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2737 one transaction and run one scrip. Set this value to 1 if you want
2738 only one of the link transactions to have scrips run.
2742 Set($LinkTransactionsRun1Scrip, 0);
2744 =item C<$ResolveDefaultUpdateType>
2746 This option has been deprecated. You can configure this site-wide
2747 with L</Lifecycles> (see L</Labeling and defining actions>).