2 # RT was configured with:
4 # $ ./configure --prefix=/www/data/rt/4.0.5/ --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.
352 For MySQL and Oracle, we set this size to 10 megabytes. If you're
353 running a PostgreSQL version earlier than 7.1, you will need to drop
359 Set($MaxAttachmentSize, 10_000_000);
361 =item C<$TruncateLongAttachments>
363 If this is set to a non-undef value, RT will truncate attachments
364 longer than C<$MaxAttachmentSize>.
368 Set($TruncateLongAttachments, undef);
370 =item C<$DropLongAttachments>
372 If this is set to a non-undef value, RT will silently drop attachments
373 longer than C<MaxAttachmentSize>. C<$TruncateLongAttachments>, above,
374 takes priority over this.
378 Set($DropLongAttachments, undef);
380 =item C<$RTAddressRegexp>
382 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a
383 ticket CC if C<$ParseNewMessageForTicketCcs>, above, is enabled. It
384 is important that you set this to a regular expression that matches
385 all addresses used by your RT. This lets RT avoid sending mail to
386 itself. It will also hide RT addresses from the list of "One-time Cc"
387 and Bcc lists on ticket reply.
389 If you have a number of addresses configured in your RT database
390 already, you can generate a naive first pass regexp by using:
392 perl etc/upgrade/generate-rtaddressregexp
394 If left blank, RT will generate a regexp for you, based on your
395 comment and correspond address settings on your queues; this comes at
396 a small cost in start-up speed.
400 Set($RTAddressRegexp, undef);
402 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
404 RT provides functionality which allows the system to rewrite incoming
405 email addresses. In its simplest form, you can substitute the value
406 in C<CanonicalizeEmailAddressReplace> for the value in
407 C<CanonicalizeEmailAddressMatch> (These values are passed to the
408 C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>)
410 By default, that routine performs a C<s/$Match/$Replace/gi> on any
411 address passed to it.
415 # Set($CanonicalizeEmailAddressMatch, '@subdomain\.example\.com$');
416 # Set($CanonicalizeEmailAddressReplace, '@example.com');
418 =item C<$CanonicalizeOnCreate>
420 Set this to 1 and the create new user page will use the values that
421 you enter in the form but use the function CanonicalizeUserInfo in
426 Set($CanonicalizeOnCreate, 0);
428 =item C<$ValidateUserEmailAddresses>
430 If C<$ValidateUserEmailAddresses> is 1, RT will refuse to create
431 users with an invalid email address (as specified in RFC 2822) or with
432 an email address made of multiple email addresses.
436 Set($ValidateUserEmailAddresses, undef);
438 =item C<@MailPlugins>
440 C<@MailPlugins> is a list of authentication plugins for
441 L<RT::Interface::Email> to use; see L<rt-mailgate>
445 =item C<$UnsafeEmailCommands>
447 C<$UnsafeEmailCommands>, if set to 1, enables 'take' and 'resolve'
448 as possible actions via the mail gateway. As its name implies, this
449 is very unsafe, as it allows email with a forged sender to possibly
450 resolve arbitrary tickets!
454 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
456 The default "extract remote tracking tags" scrip settings; these
457 detect when your RT is talking to another RT, and adjust the subject
462 Set($ExtractSubjectTagMatch, qr/\[.+? #\d+\]/);
463 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
464 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
465 : qr/\[\Q$RT::rtname\E #\d+\]/));
475 =item C<$MailCommand>
477 C<$MailCommand> defines which method RT will use to try to send mail.
478 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
479 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
482 Note that you should remove the '-t' from C<$SendmailArguments> if you
483 use 'sendmail' rather than 'sendmailpipe'
485 For testing purposes, or to simply disable sending mail out into the
486 world, you can set C<$MailCommand> to 'testfile' which writes all mail
487 to a temporary file. RT will log the location of the temporary file
488 so you can extract mail from it afterward.
492 Set($MailCommand, "sendmailpipe");
494 =item C<$SetOutgoingMailFrom>
496 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
497 Correspond mail address of the ticket's queue.
499 Warning: If you use this setting, bounced mails will appear to be
500 incoming mail to the system, thus creating new tickets.
504 Set($SetOutgoingMailFrom, 0);
506 =item C<$OverrideOutgoingMailFrom>
508 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
509 address of the queue as it is handed to sendmail -f. This helps force
510 the From_ header away from www-data or other email addresses that show
511 up in the "Sent by" line in Outlook.
513 The option is a hash reference of queue name to email address. If
514 there is no ticket involved, then the value of the C<Default> key will
517 This option is irrelevant unless C<$SetOutgoingMailFrom> is set.
521 Set($OverrideOutgoingMailFrom, {
522 # 'Default' => 'admin@rt.example.com',
523 # 'General' => 'general@rt.example.com',
526 =item C<$DefaultMailPrecedence>
528 C<$DefaultMailPrecedence> is used to control the default Precedence
529 level of outgoing mail where none is specified. By default it is
530 C<bulk>, but if you only send mail to your staff, you may wish to
533 Note that you can set the precedence of individual templates by
534 including an explicit Precedence header.
536 If you set this value to C<undef> then we do not set a default
537 Precedence header to outgoing mail. However, if there already is a
538 Precedence header, it will be preserved.
542 Set($DefaultMailPrecedence, "bulk");
544 =item C<$DefaultErrorMailPrecedence>
546 C<$DefaultErrorMailPrecedence> is used to control the default
547 Precedence level of outgoing mail that indicates some kind of error
548 condition. By default it is C<bulk>, but if you only send mail to your
549 staff, you may wish to change it.
551 If you set this value to C<undef> then we do not add a Precedence
552 header to error mail.
556 Set($DefaultErrorMailPrecedence, "bulk");
558 =item C<$UseOriginatorHeader>
560 C<$UseOriginatorHeader> is used to control the insertion of an
561 RT-Originator Header in every outgoing mail, containing the mail
562 address of the transaction creator.
566 Set($UseOriginatorHeader, 1);
568 =item C<$UseFriendlyFromLine>
570 By default, RT sets the outgoing mail's "From:" header to "SenderName
571 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
575 Set($UseFriendlyFromLine, 1);
577 =item C<$FriendlyFromLineFormat>
579 C<sprintf()> format of the friendly 'From:' header; its arguments are
580 SenderName and SenderEmailAddress.
584 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
586 =item C<$UseFriendlyToLine>
588 RT can optionally set a "Friendly" 'To:' header when sending messages
589 to Ccs or AdminCcs (rather than having a blank 'To:' header.
591 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
592 are using sendmail, rather than postfix, qmail, exim or some other
593 MTA, you _must_ disable this option.
597 Set($UseFriendlyToLine, 0);
599 =item C<$FriendlyToLineFormat>
601 C<sprintf()> format of the friendly 'To:' header; its arguments are
602 WatcherType and TicketId.
606 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
608 =item C<$NotifyActor>
610 By default, RT doesn't notify the person who performs an update, as
611 they already know what they've done. If you'd like to change this
612 behavior, Set C<$NotifyActor> to 1
616 Set($NotifyActor, 0);
618 =item C<$RecordOutgoingEmail>
620 By default, RT records each message it sends out to its own internal
621 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
625 Set($RecordOutgoingEmail, 1);
627 =item C<$VERPPrefix>, C<$VERPDomain>
629 Setting these options enables VERP support
630 L<http://cr.yp.to/proto/verp.txt>.
632 Uncomment the following two directives to generate envelope senders
633 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
634 (i.e. rt-jesse=fsck.com@rt.example.com ).
636 This currently only works with sendmail and sendmailpipe.
640 # Set($VERPPrefix, "rt-");
641 # Set($VERPDomain, $RT::Organization);
644 =item C<$ForwardFromUser>
646 By default, RT forwards a message using queue's address and adds RT's
647 tag into subject of the outgoing message, so recipients' replies go
648 into RT as correspondents.
650 To change this behavior, set C<$ForwardFromUser> to 1 and RT
651 will use the address of the current user and remove RT's subject tag.
655 Set($ForwardFromUser, 0);
659 =head2 Email dashboards
663 =item C<$DashboardAddress>
665 The email address from which RT will send dashboards. If none is set,
666 then C<$OwnerEmail> will be used.
670 Set($DashboardAddress, '');
672 =item C<$DashboardSubject>
674 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
675 Weekly, Monthly) of the dashboard and the dashboard's name.
679 Set($DashboardSubject, "%s Dashboard: %s");
681 =item C<@EmailDashboardRemove>
683 A list of regular expressions that will be used to remove content from
688 Set(@EmailDashboardRemove, ());
694 =head2 Sendmail configuration
696 These options only take effect if C<$MailCommand> is 'sendmail' or
701 =item C<$SendmailArguments>
703 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
704 If you picked 'sendmailpipe', you MUST add a -t flag to
705 C<$SendmailArguments> These options are good for most sendmail
706 wrappers and work-a-likes.
708 These arguments are good for sendmail brand sendmail 8 and newer:
709 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
713 Set($SendmailArguments, "-oi -t");
716 =item C<$SendmailBounceArguments>
718 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
719 assuming RT needs to send an error (i.e. bounce).
723 Set($SendmailBounceArguments, '-f "<>"');
725 =item C<$SendmailPath>
727 If you selected 'sendmailpipe' above, you MUST specify the path to
728 your sendmail binary in C<$SendmailPath>.
732 Set($SendmailPath, "/usr/sbin/sendmail");
737 =head2 SMTP configuration
739 These options only take effect if C<$MailCommand> is 'smtp'
745 C<$SMTPServer> should be set to the hostname of the SMTP server to use
749 Set($SMTPServer, undef);
753 C<$SMTPFrom> should be set to the 'From' address to use, if not the
758 Set($SMTPFrom, undef);
762 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
776 C<@MailParams> defines a list of options passed to $MailCommand if it
777 is not 'sendmailpipe', 'sendmail', or 'smtp'
781 Set(@MailParams, ());
790 =item C<$WebDefaultStylesheet>
792 This determines the default stylesheet the RT web interface will use.
793 RT ships with several themes by default:
795 web2 The default layout for RT 3.8
796 aileron The default layout for RT 4.0
797 ballard Theme which doesn't rely on JavaScript for menuing
799 This value actually specifies a directory in F<share/html/NoAuth/css/>
800 from which RT will try to load the file main.css (which should @import
801 any other files the stylesheet needs). This allows you to easily and
802 cleanly create your own stylesheets to apply to RT. This option can
803 be overridden by users in their preferences.
807 Set($WebDefaultStylesheet, "aileron");
809 =item C<$DefaultQueue>
811 Use this to select the default queue name that will be used for
812 creating new tickets. You may use either the queue's name or its
813 ID. This only affects the queue selection boxes on the web interface.
817 # Set($DefaultQueue, "General");
819 =item C<$RememberDefaultQueue>
821 When a queue is selected in the new ticket dropdown, make it the new
822 default for the new ticket dropdown.
826 # Set($RememberDefaultQueue, 1);
828 =item C<$EnableReminders>
830 Hide all links and portlets related to Reminders by setting this to 0
834 Set($EnableReminders, 1);
836 =item C<@CustomFieldValuesSources>
838 Set C<@CustomFieldValuesSources> to a list of class names which extend
839 L<RT::CustomFieldValues::External>. This can be used to pull lists of
840 custom field values from external sources at runtime.
844 Set(@CustomFieldValuesSources, ());
846 =item C<$CanonicalizeRedirectURLs>
848 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
849 redirecting rather than the one we get from C<%ENV>.
851 Apache's UseCanonicalName directive changes the hostname that RT
852 finds in C<%ENV>. You can read more about what turning it On or Off
853 means in the documentation for your version of Apache.
855 If you use RT behind a reverse proxy, you almost certainly want to
860 Set($CanonicalizeRedirectURLs, 0);
864 A list of JavaScript files to be included in head. Removing any of
865 the default entries is not suggested.
872 jquery-ui-1.8.4.custom.min.js
873 jquery-ui-patch-datepicker.js
878 jquery.event.hover-1.0.js
881 jquery.supposition.js
888 Path to the jsmin binary; if specified, it will be used to minify
889 C<JSFiles>. The default, and the fallback if the binary cannot be
890 found, is to simply concatenate the files.
892 jsmin can be installed by running 'make jsmin' from the RT install
893 directory, or from http://www.crockford.com/javascript/jsmin.html
897 # Set($JSMinPath, "/path/to/jsmin");
901 A list of additional CSS files to be included in head.
905 Set(@CSSFiles, qw//);
907 =item C<$UsernameFormat>
909 This determines how user info is displayed. 'concise' will show one of
910 either NickName, RealName, Name or EmailAddress, depending on what
911 exists and whether the user is privileged or not. 'verbose' will show
912 RealName and EmailAddress.
916 Set($UsernameFormat, "concise");
918 =item C<$WebBaseURL>, C<$WebURL>
920 Usually you don't want to set these options. The only obvious reason
921 is if RT is accessible via https protocol on a non standard port, e.g.
922 'https://rt.example.com:9999'. In all other cases these options are
923 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
925 C<$WebBaseURL> is the scheme, server and port
926 (e.g. 'http://rt.example.com') for constructing URLs to the web
927 UI. C<$WebBaseURL> doesn't need a trailing /.
929 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
930 example: 'http://www.example.com/rt/'.
934 my $port = RT->Config->Get('WebPort');
936 ($port == 443? 'https': 'http') .'://'
937 . RT->Config->Get('WebDomain')
938 . ($port != 80 && $port != 443? ":$port" : '')
941 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
943 =item C<$WebImagesURL>
945 C<$WebImagesURL> points to the base URL where RT can find its images.
946 Define the directory name to be used for images in RT web documents.
950 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
954 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
955 This can also be configured via the web UI.
959 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
961 =item C<$LogoLinkURL>
963 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
967 Set($LogoLinkURL, "http://bestpractical.com");
969 =item C<$LogoAltText>
971 C<$LogoAltText> is a string of text for the alt-text of the logo. It
972 will be passed through C<loc> for localization.
976 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
978 =item C<$LogoImageHeight>
980 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
985 Set($LogoImageHeight, 38);
987 =item C<$LogoImageWidth>
989 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
994 Set($LogoImageWidth, 181);
996 =item C<$WebNoAuthRegex>
998 What portion of RT's URL space should not require authentication. The
999 default is almost certainly correct, and should only be changed if you
1004 Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1006 =item C<$SelfServiceRegex>
1008 What portion of RT's URLspace should be accessible to Unprivileged
1009 users This does not override the redirect from F</Ticket/Display.html>
1010 to F</SelfService/Display.html> when Unprivileged users attempt to
1011 access ticked displays.
1015 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1017 =item C<$WebFlushDbCacheEveryRequest>
1019 By default, RT clears its database cache after every page view. This
1020 ensures that you've always got the most current information when
1021 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1022 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1023 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1027 Set($WebFlushDbCacheEveryRequest, 1);
1031 The L<GD> module (which RT uses for graphs) ships with a built-in font
1032 that doesn't have full Unicode support. You can use a given TrueType
1033 font for a specific language by setting %ChartFont to (language =E<gt>
1034 the absolute path of a font) pairs. Your GD library must have support
1035 for TrueType fonts to use this option. If there is no entry for a
1036 language in the hash then font with 'others' key is used.
1038 RT comes with two TrueType fonts covering most available languages.
1044 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1045 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1046 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1047 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1050 =item C<$ChartsTimezonesInDB>
1052 RT stores dates using the UTC timezone in the DB, so charts grouped by
1053 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1054 to enable timezone conversions using your DB's capabilities. You may
1055 need to do some work on the DB side to use this feature, read more in
1056 F<docs/customizing/timezones_in_charts.pod>.
1058 At this time, this feature only applies to MySQL and PostgreSQL.
1062 Set($ChartsTimezonesInDB, 0);
1072 =item C<$DefaultSummaryRows>
1074 C<$DefaultSummaryRows> is default number of rows displayed in for
1075 search results on the front page.
1079 Set($DefaultSummaryRows, 10);
1081 =item C<$HomePageRefreshInterval>
1083 C<$HomePageRefreshInterval> is default number of seconds to refresh
1084 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1088 Set($HomePageRefreshInterval, 0);
1090 =item C<$HomepageComponents>
1092 C<$HomepageComponents> is an arrayref of allowed components on a
1093 user's customized homepage ("RT at a glance").
1097 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
1104 =head2 Ticket search
1108 =item C<$UseSQLForACLChecks>
1110 Historically, ACLs were checked on display, which could lead to empty
1111 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1112 to limit search results in SQL instead, which eliminates these
1115 This option is still relatively new; it may result in performance
1116 problems in some cases, or significant speedups in others.
1120 Set($UseSQLForACLChecks, undef);
1122 =item C<$TicketsItemMapSize>
1124 On the display page of a ticket from search results, RT provides links
1125 to the first, next, previous and last ticket from the results. In
1126 order to build these links, RT needs to fetch the full result set from
1127 the database, which can be resource-intensive.
1129 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1130 to build these links. If the full result set is larger than this
1131 number, RT will omit the "last" link in the menu. Set this to zero to
1132 always examine all results.
1136 Set($TicketsItemMapSize, 1000);
1138 =item C<$SearchResultsRefreshInterval>
1140 C<$SearchResultsRefreshInterval> is default number of seconds to
1141 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1146 Set($SearchResultsRefreshInterval, 0);
1148 =item C<$DefaultSearchResultFormat>
1150 C<$DefaultSearchResultFormat> is the default format for RT search
1155 Set ($DefaultSearchResultFormat, qq{
1156 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1157 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1164 '<small>__Requestors__</small>',
1165 '<small>__CreatedRelative__</small>',
1166 '<small>__ToldRelative__</small>',
1167 '<small>__LastUpdatedRelative__</small>',
1168 '<small>__TimeLeft__</small>'});
1170 =item C<$DefaultSelfServiceSearchResultFormat>
1172 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1173 searches displayed in the SelfService interface.
1177 Set($DefaultSelfServiceSearchResultFormat, qq{
1178 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1179 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1184 =item C<%FullTextSearch>
1186 Full text search (FTS) without database indexing is a very slow
1187 operation, and is thus disabled by default.
1189 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1190 the full details of FTS on your particular database.
1192 It is possible to enable FTS without database indexing support, simply
1193 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1194 This is not generally suggested, as unindexed full-text searching can
1195 cause severe performance problems.
1199 Set(%FullTextSearch,
1205 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1207 When query in simple search doesn't have status info, use this to only
1212 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1214 =item C<$SearchResultsAutoRedirect>
1216 When only one ticket is found in search, use this to redirect to the
1217 ticket display page automatically.
1221 Set($SearchResultsAutoRedirect, 0);
1227 =head2 Ticket display
1231 =item C<$ShowMoreAboutPrivilegedUsers>
1233 This determines if the 'More about requestor' box on
1234 Ticket/Display.html is shown for Privileged Users.
1238 Set($ShowMoreAboutPrivilegedUsers, 0);
1240 =item C<$MoreAboutRequestorTicketList>
1242 This can be set to Active, Inactive, All or None. It controls what
1243 ticket list will be displayed in the 'More about requestor' box on
1244 Ticket/Display.html. This option can be controlled by users also.
1248 Set($MoreAboutRequestorTicketList, "Active");
1250 =item C<$MoreAboutRequestorExtraInfo>
1252 By default, the 'More about requestor' box on Ticket/Display.html
1253 shows the Requestor's name and ticket list. If you would like to see
1254 extra information about the user, this expects a Format string of user
1255 attributes. Please note that not all the attributes are supported in
1256 this display because we're not building a table.
1259 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1263 Set($MoreAboutRequestorExtraInfo, "");
1265 =item C<$MoreAboutRequestorGroupsLimit>
1267 By default, the 'More about requestor' box on Ticket/Display.html
1268 shows all the groups of the Requestor. Use this to limit the number
1269 of groups; a value of undef removes the group display entirely.
1273 Set($MoreAboutRequestorGroupsLimit, 0);
1275 =item C<$UseSideBySideLayout>
1277 Should the ticket create and update forms use a more space efficient
1278 two column layout. This layout may not work in narrow browsers if you
1279 set a MessageBoxWidth (below).
1283 Set($UseSideBySideLayout, 1);
1285 =item C<$EditCustomFieldsSingleColumn>
1287 When displaying a list of Ticket Custom Fields for editing, RT
1288 defaults to a 2 column list. If you set this to 1, it will instead
1289 display the Custom Fields in a single column.
1293 Set($EditCustomFieldsSingleColumn, 0);
1295 =item C<$ShowUnreadMessageNotifications>
1297 If set to 1, RT will prompt users when there are new,
1298 unread messages on tickets they are viewing.
1302 Set($ShowUnreadMessageNotifications, 0);
1304 =item C<$AutocompleteOwners>
1306 If set to 1, the owner drop-downs for ticket update/modify and the query
1307 builder are replaced by text fields that autocomplete. This can
1308 alleviate the sometimes huge owner list for installations where many
1309 users have the OwnTicket right.
1313 Set($AutocompleteOwners, 0);
1315 =item C<$AutocompleteOwnersForSearch>
1317 If set to 1, the owner drop-downs for the query builder are always
1318 replaced by text field that autocomplete and C<$AutocompleteOwners>
1319 is ignored. Helpful when owners list is huge in the query builder.
1323 Set($AutocompleteOwnersForSearch, 0);
1325 =item C<$UserAutocompleteFields>
1327 Specifies which fields of L<RT::User> to match against and how to
1328 match each field when autocompleting users. Valid match methods are
1329 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1333 Set($UserAutocompleteFields, {
1334 EmailAddress => 'STARTSWITH',
1335 Name => 'STARTSWITH',
1339 =item C<$AllowUserAutocompleteForUnprivileged>
1341 Should unprivileged users be allowed to autocomplete users. Setting
1342 this option to 1 means unprivileged users will be able to search all
1347 Set($AllowUserAutocompleteForUnprivileged, 0);
1349 =item C<$DisplayTicketAfterQuickCreate>
1351 Enable this to redirect to the created ticket display page
1352 automatically when using QuickCreate.
1356 Set($DisplayTicketAfterQuickCreate, 0);
1358 =item C<$WikiImplicitLinks>
1360 Support implicit links in WikiText custom fields? Setting this to 1
1361 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1362 become links to searches for those words. If used on Articles, it links
1363 to the Article with that name.
1367 Set($WikiImplicitLinks, 0);
1369 =item C<$PreviewScripMessages>
1371 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1372 reply page should include the content of the messages to be sent.
1376 Set($PreviewScripMessages, 0);
1378 =item C<$SimplifiedRecipients>
1380 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1381 B<any> kind of mail will be shown on the ticket reply page, instead of a
1382 detailed breakdown by scrip.
1386 Set($SimplifiedRecipients, 0);
1388 =item C<$HideResolveActionsWithDependencies>
1390 If set to 1, this option will skip ticket menu actions which can't be
1391 completed successfully because of outstanding active Depends On tickets.
1393 By default, all ticket actions are displayed in the menu even if some of
1394 them can't be successful until all Depends On links are resolved or
1395 transitioned to another inactive status.
1399 Set($HideResolveActionsWithDependencies, 0);
1409 =item C<$ArticleOnTicketCreate>
1411 Set this to 1 to display the Articles interface on the Ticket Create
1412 page in addition to the Reply/Comment page.
1416 Set($ArticleOnTicketCreate, 0);
1418 =item C<$HideArticleSearchOnReplyCreate>
1420 Set this to 1 to hide the search and include boxes from the Article
1421 UI. This assumes you have enabled Article Hotlist feature, otherwise
1422 you will have no access to Articles.
1426 Set($HideArticleSearchOnReplyCreate, 0);
1432 =head2 Message box properties
1436 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1438 For message boxes, set the entry box width, height and what type of
1439 wrapping to use. These options can be overridden by users in their
1442 When the width is set to undef, no column count is specified and the
1443 message box will take up 100% of the available width. Combining this
1444 with HARD messagebox wrapping (below) is not recommended, as it will
1445 lead to inconsistent width in transactions between browsers.
1447 These settings only apply to the non-RichText message box. See below
1448 for Rich Text settings.
1452 Set($MessageBoxWidth, undef);
1453 Set($MessageBoxHeight, 15);
1455 =item C<$MessageBoxWrap>
1457 Wrapping is disabled when using MessageBoxRichText because of a bad
1458 interaction between IE and wrapping with the Rich Text Editor.
1462 Set($MessageBoxWrap, "SOFT");
1464 =item C<$MessageBoxRichText>
1466 Should "rich text" editing be enabled? This option lets your users
1467 send HTML email messages from the web interface.
1471 Set($MessageBoxRichText, 1);
1473 =item C<$MessageBoxRichTextHeight>
1475 Height of rich text JavaScript enabled editing boxes (in pixels)
1479 Set($MessageBoxRichTextHeight, 200);
1481 =item C<$MessageBoxIncludeSignature>
1483 Should your users' signatures (from their Preferences page) be
1484 included in Comments and Replies.
1488 Set($MessageBoxIncludeSignature, 1);
1490 =item C<$MessageBoxIncludeSignatureOnComment>
1492 Should your users' signatures (from their Preferences page) be
1493 included in Comments. Setting this to false overrides
1494 C<$MessageBoxIncludeSignature>.
1498 Set($MessageBoxIncludeSignatureOnComment, 1);
1503 =head2 Transaction display
1507 =item C<$OldestTransactionsFirst>
1509 By default, RT shows newest transactions at the bottom of the ticket
1510 history page, if you want see them at the top set this to 0. This
1511 option can be overridden by users in their preferences.
1515 Set($OldestTransactionsFirst, 1);
1517 =item C<$DeferTransactionLoading>
1519 When set, defers loading ticket history until the user clicks a link.
1520 This should end up serving pages to users quicker, since generating
1521 all the HTML for transaction history can be slow for long tickets.
1525 # Set($DeferTransactionLoading, 1);
1527 =item C<$ShowBccHeader>
1529 By default, RT hides from the web UI information about blind copies
1530 user sent on reply or comment.
1534 Set($ShowBccHeader, 0);
1536 =item C<$TrustHTMLAttachments>
1538 If C<TrustHTMLAttachments> is not defined, we will display them as
1539 text. This prevents malicious HTML and JavaScript from being sent in a
1540 request (although there is probably more to it than that)
1544 Set($TrustHTMLAttachments, undef);
1546 =item C<$AlwaysDownloadAttachments>
1548 Always download attachments, regardless of content type. If set, this
1549 overrides C<TrustHTMLAttachments>.
1553 Set($AlwaysDownloadAttachments, undef);
1555 =item C<$AttachmentUnits>
1557 Controls the units (kilobytes or bytes) that attachment sizes use for
1558 display. The default is to display kilobytes if the attachment is
1559 larger than 1024 bytes, bytes otherwise. If you set
1560 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1561 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1565 Set($AttachmentUnits, undef);
1567 =item C<$PreferRichText>
1569 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1570 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1571 show only a minimal subset of HTML to avoid possible contamination by
1572 cross-site-scripting attacks.
1576 Set($PreferRichText, undef);
1578 =item C<$MaxInlineBody>
1580 C<$MaxInlineBody> is the maximum attachment size that we want to see
1581 inline when viewing a transaction. RT will inline any text if the
1582 value is undefined or 0. This option can be overridden by users in
1587 Set($MaxInlineBody, 12000);
1589 =item C<$ShowTransactionImages>
1591 By default, RT shows images attached to incoming (and outgoing) ticket
1592 updates inline. Set this variable to 0 if you'd like to disable that
1597 Set($ShowTransactionImages, 1);
1599 =item C<$PlainTextPre>
1601 Normally plaintext attachments are displayed as HTML with line breaks
1602 preserved. This causes space- and tab-based formatting not to be
1603 displayed correctly. By setting $PlainTextPre messages will be
1604 displayed using <pre>.
1608 Set($PlainTextPre, 0);
1611 =item C<$PlainTextMono>
1613 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1614 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1615 of the browser window; this option overrides C<$PlainTextPre>.
1619 Set($PlainTextMono, 0);
1621 =item C<$SuppressInlineTextFiles>
1623 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1624 (text-type attachments with file names) are prevented from being
1625 displayed in-line when viewing a ticket's history.
1629 Set($SuppressInlineTextFiles, undef);
1632 =item C<@Active_MakeClicky>
1634 MakeClicky detects various formats of data in headers and email
1635 messages, and extends them with supporting links. By default, RT
1636 provides two formats:
1638 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1641 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1642 replaces the URL with a link.
1644 See F<share/html/Elements/MakeClicky> for documentation on how to add
1645 your own styles of link detection.
1649 Set(@Active_MakeClicky, qw());
1655 =head1 Application logic
1659 =item C<$ParseNewMessageForTicketCcs>
1661 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1662 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1663 messages. Be forewarned that if you have I<any> addresses which forward
1664 mail to RT automatically and you enable this option without modifying
1665 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1669 Set($ParseNewMessageForTicketCcs, undef);
1671 =item C<$UseTransactionBatch>
1673 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1674 such that a resolve and comment (for example) would happen
1675 simultaneously, instead of as two transactions, unaware of each
1680 Set($UseTransactionBatch, 1);
1682 =item C<$StrictLinkACL>
1684 When this feature is enabled a user needs I<ModifyTicket> rights on
1685 both tickets to link them together; otherwise, I<ModifyTicket> rights
1686 on either of them is sufficient.
1690 Set($StrictLinkACL, 1);
1692 =item C<$RedistributeAutoGeneratedMessages>
1694 Should RT redistribute correspondence that it identifies as machine
1695 generated? A 1 will do so; setting this to 0 will cause no
1696 such messages to be redistributed. You can also use 'privileged' (the
1697 default), which will redistribute only to privileged users. This helps
1698 to protect against malformed bounces and loops caused by auto-created
1699 requestors with bogus addresses.
1703 Set($RedistributeAutoGeneratedMessages, "privileged");
1705 =item C<$ApprovalRejectionNotes>
1707 Should rejection notes from approvals be sent to the requestors?
1711 Set($ApprovalRejectionNotes, 1);
1713 =item C<$ForceApprovalsView>
1715 Should approval tickets only be viewed and modified through the standard
1716 approval interface? Changing this setting to 1 will redirect any attempt to
1717 use the normal ticket display and modify page for approval tickets.
1719 For example, with this option set to 1 and an approval ticket #123:
1721 /Ticket/Display.html?id=123
1725 /Approval/Display.html?id=123
1731 Set($ForceApprovalsView, 0);
1733 =head1 Extra security
1737 This is a list of extra security measures to enable that help keep your RT
1738 safe. If you don't know what these mean, you should almost certainly leave the
1741 =item C<$DisallowExecuteCode>
1743 If set to a true value, the C<ExecuteCode> right will be removed from
1744 all users, B<including> the superuser. This is intended for when RT is
1745 installed into a shared environment where even the superuser should not
1746 be allowed to run arbitrary Perl code on the server via scrips.
1750 Set($DisallowExecuteCode, 0);
1752 =item C<$Framebusting>
1754 If set to a false value, framekiller javascript will be disabled and the
1755 X-Frame-Options: DENY header will be suppressed from all responses.
1756 This disables RT's clickjacking protection.
1760 Set($Framebusting, 1);
1762 =item C<$RestrictReferrer>
1764 If set to a false value, the HTTP C<Referer> (sic) header will not be
1765 checked to ensure that requests come from RT's own domain. As RT allows
1766 for GET requests to alter state, disabling this opens RT up to
1767 cross-site request forgery (CSRF) attacks.
1771 Set($RestrictReferrer, 1);
1773 =item C<$RestrictLoginReferrer>
1775 If set to a false value, RT will allow the user to log in from any link
1776 or request, merely by passing in C<user> and C<pass> parameters; setting
1777 it to a true value forces all logins to come from the login box, so the
1778 user us aware that they are being logged in. The default is off, for
1779 backwards compatability.
1783 Set($RestrictLoginReferrer, 0);
1789 =head1 Authorization and user configuration
1793 =item C<$WebExternalAuth>
1795 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1796 REMOTE_USER variable.
1800 Set($WebExternalAuth, undef);
1802 =item C<$WebExternalAuthContinuous>
1804 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1805 REMOTE_USER on each access. If you would prefer this to only happen
1806 once (at initial login) set this to a false value. The default
1807 setting will help ensure that if your external authentication system
1808 deauthenticates a user, RT notices as soon as possible.
1812 Set($WebExternalAuthContinuous, 1);
1814 =item C<$WebFallbackToInternalAuth>
1816 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1817 chance of fallback to the login screen, even if REMOTE_USER failed.
1821 Set($WebFallbackToInternalAuth, undef);
1823 =item C<$WebExternalGecos>
1825 C<$WebExternalGecos> means to match 'gecos' field as the user
1826 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1831 Set($WebExternalGecos, undef);
1833 =item C<$WebExternalAuto>
1835 C<$WebExternalAuto> will create users under the same name as
1836 REMOTE_USER upon login, if it's missing in the Users table.
1840 Set($WebExternalAuto, undef);
1842 =item C<$AutoCreate>
1844 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1845 User's Create method. Use it to set defaults, such as creating
1846 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1850 Set($AutoCreate, undef);
1852 =item C<$WebSessionClass>
1854 C<$WebSessionClass> is the class you wish to use for managing
1855 Sessions. It defaults to use your SQL database, but if you are using
1856 MySQL 3.x and plans to use non-ascii Queue names, uncomment and add
1857 this line to F<RT_SiteConfig.pm> to prevent session corruption.
1861 # Set($WebSessionClass, "Apache::Session::File");
1863 =item C<$AutoLogoff>
1865 By default, RT's user sessions persist until a user closes his or her
1866 browser. With the C<$AutoLogoff> option you can setup session lifetime
1867 in minutes. A user will be logged out if he or she doesn't send any
1868 requests to RT for the defined time.
1872 Set($AutoLogoff, 0);
1874 =item C<$LogoutRefresh>
1876 The number of seconds to wait after logout before sending the user to
1877 the login page. By default, 1 second, though you may want to increase
1878 this if you display additional information on the logout page.
1882 Set($LogoutRefresh, 1);
1884 =item C<$WebSecureCookies>
1886 By default, RT's session cookie isn't marked as "secure". Some web
1887 browsers will treat secure cookies more carefully than non-secure
1888 ones, being careful not to write them to disk, only sending them over
1889 an SSL secured connection, and so on. To enable this behavior, set
1890 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1891 on I<unless> users are only connecting via SSL encrypted HTTPS
1896 Set($WebSecureCookies, 0);
1898 =item C<$WebHttpOnlyCookies>
1900 Default RT's session cookie to not being directly accessible to
1901 javascript. The content is still sent during regular and AJAX requests,
1902 and other cookies are unaffected, but the session-id is less
1903 programmatically accessible to javascript. Turning this off should only
1904 be necessary in situations with odd client-side authentication
1909 Set($WebHttpOnlyCookies, 1);
1911 =item C<$MinimumPasswordLength>
1913 C<$MinimumPasswordLength> defines the minimum length for user
1914 passwords. Setting it to 0 disables this check.
1918 Set($MinimumPasswordLength, 5);
1923 =head1 Internationalization
1927 =item C<@LexiconLanguages>
1929 An array that contains languages supported by RT's
1930 internationalization interface. Defaults to all *.po lexicons;
1931 setting it to C<qw(en ja)> will make RT bilingual instead of
1932 multilingual, but will save some memory.
1936 Set(@LexiconLanguages, qw(*));
1938 =item C<@EmailInputEncodings>
1940 An array that contains default encodings used to guess which charset
1941 an attachment uses, if it does not specify one explicitly. All
1942 options must be recognized by L<Encode::Guess>. The first element may
1943 also be '*', which enables encoding detection using
1944 L<Encode::Detect::Detector>, if installed.
1948 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1950 =item C<$EmailOutputEncoding>
1952 The charset for localized email. Must be recognized by Encode.
1956 Set($EmailOutputEncoding, "utf-8");
1966 =head1 Date and time handling
1970 =item C<$DateTimeFormat>
1972 You can choose date and time format. See the "Output formatters"
1973 section in perldoc F<lib/RT/Date.pm> for more options. This option
1974 can be overridden by users in their preferences.
1978 C<Set($DateTimeFormat, "LocalizedDateTime");>
1979 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
1980 C<Set($DateTimeFormat, "RFC2822");>
1981 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
1985 Set($DateTimeFormat, "DefaultFormat");
1987 # Next two options are for Time::ParseDate
1989 =item C<$DateDayBeforeMonth>
1991 Set this to 1 if your local date convention looks like "dd/mm/yy"
1992 instead of "mm/dd/yy". Used only for parsing, not for displaying
1997 Set($DateDayBeforeMonth, 1);
1999 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2001 Should an unspecified day or year in a date refer to a future or a
2002 past value? For example, should a date of "Tuesday" default to mean
2003 the date for next Tuesday or last Tuesday? Should the date "March 1"
2004 default to the date for next March or last March?
2006 Set C<$AmbiguousDayInPast> for the last date, or
2007 C<$AmbiguousDayInFuture> for the next date; the default is usually
2008 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2012 Set($AmbiguousDayInPast, 0);
2013 Set($AmbiguousDayInFuture, 0);
2015 =item C<$DefaultTimeUnitsToHours>
2017 Use this to set the default units for time entry to hours instead of
2018 minutes. Note that this only effects entry, not display.
2022 Set($DefaultTimeUnitsToHours, 0);
2029 =head1 GnuPG integration
2031 A full description of the (somewhat extensive) GnuPG integration can
2032 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2033 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2039 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2040 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2042 If you want to allow people to encrypt attachments inside the DB then
2043 set C<AllowEncryptDataInDB> to 1.
2045 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2046 emails encrypted for key RT doesn't have and can not decrypt.
2048 Set C<RejectOnBadData> to false if you don't want to reject letters
2049 with incorrect GnuPG data.
2055 OutgoingMessagesFormat => "RFC", # Inline
2056 AllowEncryptDataInDB => 0,
2058 RejectOnMissingPrivateKey => 1,
2059 RejectOnBadData => 1,
2062 =item C<%GnuPGOptions>
2064 Options to pass to the GnuPG program.
2066 If you override this in your RT_SiteConfig, you should be sure to
2067 include a homedir setting.
2069 Note that options with '-' character MUST be quoted.
2074 homedir => q{var/data/gpg},
2076 # URL of a keyserver
2077 # keyserver => 'hkp://subkeys.pgp.net',
2079 # enables the automatic retrieving of keys when encrypting
2080 # 'auto-key-locate' => 'keyserver',
2082 # enables the automatic retrieving of keys when verifying signatures
2083 # 'auto-key-retrieve' => undef,
2092 =head2 Lifecycle definitions
2094 Each lifecycle is a list of possible statuses split into three logic
2095 sets: B<initial>, B<active> and B<inactive>. Each status in a
2096 lifecycle must be unique. (Statuses may not be repeated across sets.)
2097 Each set may have any number of statuses.
2103 active => ['open', 'stalled'],
2104 inactive => ['resolved', 'rejected', 'deleted'],
2108 Status names can be from 1 to 64 ASCII characters. Statuses are
2109 localized using RT's standard internationalization and localization
2116 You can define multiple B<initial> statuses for tickets in a given
2119 RT will automatically set its B<Started> date when you change a
2120 ticket's status from an B<initial> state to an B<active> or
2125 B<Active> tickets are "currently in play" - they're things that are
2126 being worked on and not yet complete.
2130 B<Inactive> tickets are typically in their "final resting state".
2132 While you're free to implement a workflow that ignores that
2133 description, typically once a ticket enters an inactive state, it will
2134 never again enter an active state.
2136 RT will automatically set the B<Resolved> date when a ticket's status
2137 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2140 B<deleted> is still a special status and protected by the
2141 B<DeleteTicket> right, unless you re-defined rights (read below). If
2142 you don't want to allow ticket deletion at any time simply don't
2143 include it in your lifecycle.
2147 Statuses in each set are ordered and listed in the UI in the defined
2150 Changes between statuses are constrained by transition rules, as
2153 =head2 Default values
2155 In some cases a default value is used to display in UI or in API when
2156 value is not provided. You can configure defaults using the following
2163 on_resolve => 'resolved',
2168 The following defaults are used.
2174 If you (or your code) doesn't specify a status when creating a ticket,
2175 RT will use the this status. See also L</Statuses available during
2180 When tickets are merged, the status of the ticket that was merged
2181 away is forced to this value. It should be one of inactive statuses;
2182 'resolved' or its equivalent is most probably the best candidate.
2186 When an approval is accepted, the status of depending tickets will
2187 be changed to this value.
2191 When an approval is denied, the status of depending tickets will
2192 be changed to this value.
2196 =head2 Transitions between statuses and UI actions
2198 A B<Transition> is a change of status from A to B. You should define
2199 all possible transitions in each lifecycle using the following format:
2204 '' => [qw(new open resolved)],
2205 new => [qw(open resolved rejected deleted)],
2206 open => [qw(stalled resolved rejected deleted)],
2207 stalled => [qw(open)],
2208 resolved => [qw(open)],
2209 rejected => [qw(open)],
2210 deleted => [qw(open)],
2215 =head3 Statuses available during ticket creation
2217 By default users can create tickets with any status, except
2218 deleted. If you want to restrict statuses available during creation
2219 then describe transition from '' (empty string), like in the example
2222 =head3 Protecting status changes with rights
2224 A transition or group of transitions can be protected by a specific
2225 right. Additionally, you can name new right names, which will be added
2226 to the system to control that transition. For example, if you wished to
2227 create a lesser right than ModifyTicket for rejecting tickets, you could
2233 '* -> deleted' => 'DeleteTicket',
2234 '* -> rejected' => 'RejectTicket',
2235 '* -> *' => 'ModifyTicket',
2240 This would create a new C<RejectTicket> right in the system which you
2241 could assign to whatever groups you choose.
2243 On the left hand side you can have the following variants:
2250 Valid transitions are listed in order of priority. If a user attempts
2251 to change a ticket's status from B<new> to B<open> then the lifecycle
2252 is checked for presence of an exact match, then for 'any to B<open>',
2253 'B<new> to any' and finally 'any to any'.
2255 If you don't define any rights, or there is no match for a transition,
2256 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2258 =head3 Labeling and defining actions
2260 For each transition you can define an action that will be shown in the
2261 UI; each action annotated with a label and an update type.
2263 Each action may provide a default update type, which can be
2264 B<Comment>, B<Respond>, or absent. For example, you may want your
2265 staff to write a reply to the end user when they change status from
2266 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2267 B<Comment> nor B<Respond> are mandatory, and user may leave the
2268 message empty, regardless of the update type.
2270 This configuration can be used to accomplish what
2271 $ResolveDefaultUpdateType was used for in RT 3.8.
2273 Use the following format to define labels and actions of transitions:
2278 'new -> open' => { label => 'Open it', update => 'Respond' },
2279 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2280 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2281 'new -> deleted' => { label => 'Delete' },
2283 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2284 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2285 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2287 'stalled -> open' => { label => 'Open it' },
2288 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2289 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2290 'deleted -> open' => { label => 'Undelete' },
2295 In addition, you may define multiple actions for the same transition.
2296 Alternately, you may use '* -> x' to match more than one transition.
2303 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2304 'new -> rejected' => { label => 'Quick Reject' },
2306 '* -> deleted' => { label => 'Delete' },
2312 =head2 Moving tickets between queues with different lifecycles
2314 Unless there is an explicit mapping between statuses in two different
2315 lifecycles, you can not move tickets between queues with these
2316 lifecycles. This is true even if the different lifecycles use the exact
2317 same set of statuses. Such a mapping is defined as follows:
2320 'from lifecycle -> to lifecycle' => {
2321 'status in left lifecycle' => 'status in right lifecycle',
2331 initial => [ 'new' ],
2332 active => [ 'open', 'stalled' ],
2333 inactive => [ 'resolved', 'rejected', 'deleted' ],
2337 on_merge => 'resolved',
2339 denied => 'rejected',
2343 '' => [qw(new open resolved)],
2345 # from => [ to list ],
2346 new => [qw(open stalled resolved rejected deleted)],
2347 open => [qw(new stalled resolved rejected deleted)],
2348 stalled => [qw(new open rejected resolved deleted)],
2349 resolved => [qw(new open stalled rejected deleted)],
2350 rejected => [qw(new open stalled resolved deleted)],
2351 deleted => [qw(new open stalled rejected resolved)],
2354 '* -> deleted' => 'DeleteTicket',
2355 '* -> *' => 'ModifyTicket',
2359 label => 'Open It', # loc
2360 update => 'Respond',
2362 'new -> resolved' => {
2363 label => 'Resolve', # loc
2364 update => 'Comment',
2366 'new -> rejected' => {
2367 label => 'Reject', # loc
2368 update => 'Respond',
2370 'new -> deleted' => {
2371 label => 'Delete', # loc
2374 'open -> stalled' => {
2375 label => 'Stall', # loc
2376 update => 'Comment',
2378 'open -> resolved' => {
2379 label => 'Resolve', # loc
2380 update => 'Comment',
2382 'open -> rejected' => {
2383 label => 'Reject', # loc
2384 update => 'Respond',
2387 'stalled -> open' => {
2388 label => 'Open It', # loc
2390 'resolved -> open' => {
2391 label => 'Re-open', # loc
2392 update => 'Comment',
2394 'rejected -> open' => {
2395 label => 'Re-open', # loc
2396 update => 'Comment',
2398 'deleted -> open' => {
2399 label => 'Undelete', # loc
2403 # don't change lifecyle of the approvals, they are not capable to deal with
2406 initial => [ 'new' ],
2407 active => [ 'open', 'stalled' ],
2408 inactive => [ 'resolved', 'rejected', 'deleted' ],
2412 on_merge => 'resolved',
2416 '' => [qw(new open resolved)],
2418 # from => [ to list ],
2419 new => [qw(open stalled resolved rejected deleted)],
2420 open => [qw(new stalled resolved rejected deleted)],
2421 stalled => [qw(new open rejected resolved deleted)],
2422 resolved => [qw(new open stalled rejected deleted)],
2423 rejected => [qw(new open stalled resolved deleted)],
2424 deleted => [qw(new open stalled rejected resolved)],
2427 '* -> deleted' => 'DeleteTicket',
2428 '* -> rejected' => 'ModifyTicket',
2429 '* -> *' => 'ModifyTicket',
2433 label => 'Open It', # loc
2434 update => 'Respond',
2436 'new -> resolved' => {
2437 label => 'Resolve', # loc
2438 update => 'Comment',
2440 'new -> rejected' => {
2441 label => 'Reject', # loc
2442 update => 'Respond',
2444 'new -> deleted' => {
2445 label => 'Delete', # loc
2448 'open -> stalled' => {
2449 label => 'Stall', # loc
2450 update => 'Comment',
2452 'open -> resolved' => {
2453 label => 'Resolve', # loc
2454 update => 'Comment',
2456 'open -> rejected' => {
2457 label => 'Reject', # loc
2458 update => 'Respond',
2461 'stalled -> open' => {
2462 label => 'Open It', # loc
2464 'resolved -> open' => {
2465 label => 'Re-open', # loc
2466 update => 'Comment',
2468 'rejected -> open' => {
2469 label => 'Re-open', # loc
2470 update => 'Comment',
2472 'deleted -> open' => {
2473 label => 'Undelete', # loc
2483 =head1 Administrative interface
2487 =item C<$ShowRTPortal>
2489 RT can show administrators a feed of recent RT releases and other
2490 related announcements and information from Best Practical on the top
2491 level Configuration page. This feature helps you stay up to date on
2492 RT security announcements and version updates.
2494 RT provides this feature using an "iframe" on C</Admin/index.html>
2495 which asks the administrator's browser to show an inline page from
2496 Best Practical's website.
2498 If you'd rather not make this feature available to your
2499 administrators, set C<$ShowRTPortal> to a false value.
2503 Set($ShowRTPortal, 1);
2505 =item C<%AdminSearchResultFormat>
2507 In the admin interface, format strings similar to tickets result
2508 formats are used. Use C<%AdminSearchResultFormat> to define the format
2509 strings used in the admin interface on a per-RT-class basis.
2513 Set(%AdminSearchResultFormat,
2515 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2516 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2517 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__},
2520 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2521 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2522 .q{,'__Description__'},
2525 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2526 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2527 .q{,__RealName__, __EmailAddress__},
2530 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2531 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2532 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2535 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2536 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2537 .q{,__Stage__, __Condition__, __Action__, __Template__},
2540 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2541 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2542 .q{,__Stage__, __Condition__, __Action__, __Template__},
2545 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2546 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2547 .q{,'__Description__'},
2549 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2550 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2551 .q{,__Description__},
2559 =head1 Development options
2565 RT comes with a "Development mode" setting. This setting, as a
2566 convenience for developers, turns on several of development options
2567 that you most likely don't want in production:
2573 Disables CSS and JS minification and concatenation. Both CSS and JS
2574 will be instead be served as a number of individual smaller files,
2575 unchanged from how they are stored on disk.
2579 Uses L<Module::Refresh> to reload changed Perl modules on each
2584 Turns off Mason's C<static_source> directive; this causes Mason to
2585 reload template files which have been modified on disk.
2589 Turns on Mason's HTML C<error_format>; this renders compilation errors
2590 to the browser, along with a full stack trace. It is possible for
2591 stack traces to reveal sensitive information such as passwords or
2596 Turns off caching of callbacks; this enables additional callbacks to
2597 be added while the server is running.
2603 Set($DevelMode, "0");
2606 =item C<$RecordBaseClass>
2608 What abstract base class should RT use for its records. You should
2609 probably never change this.
2611 Valid values are C<DBIx::SearchBuilder::Record> or
2612 C<DBIx::SearchBuilder::Record::Cachable>
2616 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2619 =item C<@MasonParameters>
2621 C<@MasonParameters> is the list of parameters for the constructor of
2622 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2623 debugging, e.g. profiling individual components with:
2625 use MasonX::Profiler; # available on CPAN
2626 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2630 Set(@MasonParameters, ());
2632 =item C<$StatementLog>
2634 RT has rudimentary SQL statement logging support; simply set
2635 C<$StatementLog> to be the level that you wish SQL statements to be
2638 Enabling this option will also expose the SQL Queries page in the
2639 Configuration -> Tools menu for SuperUsers.
2643 Set($StatementLog, undef);
2650 =head1 Deprecated options
2654 =item C<$LinkTransactionsRun1Scrip>
2656 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2657 one transaction and run one scrip. Set this value to 1 if you want
2658 only one of the link transactions to have scrips run.
2662 Set($LinkTransactionsRun1Scrip, 0);
2664 =item C<$ResolveDefaultUpdateType>
2666 This option has been deprecated. You can configure this site-wide
2667 with L</Lifecycles> (see L</Labeling and defining actions>).