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.
503 On shutdown, RT will clean up the temporary file created when using
504 the 'testfile' option. If testing while the RT server is still running,
505 you can find the files in the location noted in the log file. If you run
506 a tool like C<rt-crontool> however, or if you look after stopping the server,
507 the files will have been deleted when the process completed. If you need to
508 keep the files for development or debugging, you can manually set
509 C<< UNLINK => 0 >> where the testfile config is processed in
510 F<lib/RT/Interface/Email.pm>.
514 Set($MailCommand, "sendmailpipe");
516 =item C<$SetOutgoingMailFrom>
518 C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
519 Correspond mail address of the ticket's queue.
521 Warning: If you use this setting, bounced mails will appear to be
522 incoming mail to the system, thus creating new tickets.
524 If the value contains an C<@>, it is assumed to be an email address and used as
525 a global envelope sender. Expected usage in this case is to simply set the
526 same envelope sender on all mail from RT, without defining
527 C<$OverrideOutgoingMailFrom>. If you do define C<$OverrideOutgoingMailFrom>,
528 anything specified there overrides the global value (including Default).
530 This option only works if C<$MailCommand> is set to 'sendmailpipe'.
534 Set($SetOutgoingMailFrom, 0);
536 =item C<$OverrideOutgoingMailFrom>
538 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
539 address of the queue as it is handed to sendmail -f. This helps force
540 the From_ header away from www-data or other email addresses that show
541 up in the "Sent by" line in Outlook.
543 The option is a hash reference of queue name to email address. If
544 there is no ticket involved, then the value of the C<Default> key will
547 This option only works if C<$SetOutgoingMailFrom> is enabled and
548 C<$MailCommand> is set to 'sendmailpipe'.
552 Set($OverrideOutgoingMailFrom, {
553 # 'Default' => 'admin@rt.example.com',
554 # 'General' => 'general@rt.example.com',
557 =item C<$DefaultMailPrecedence>
559 C<$DefaultMailPrecedence> is used to control the default Precedence
560 level of outgoing mail where none is specified. By default it is
561 C<bulk>, but if you only send mail to your staff, you may wish to
564 Note that you can set the precedence of individual templates by
565 including an explicit Precedence header.
567 If you set this value to C<undef> then we do not set a default
568 Precedence header to outgoing mail. However, if there already is a
569 Precedence header, it will be preserved.
573 Set($DefaultMailPrecedence, "bulk");
575 =item C<$DefaultErrorMailPrecedence>
577 C<$DefaultErrorMailPrecedence> is used to control the default
578 Precedence level of outgoing mail that indicates some kind of error
579 condition. By default it is C<bulk>, but if you only send mail to your
580 staff, you may wish to change it.
582 If you set this value to C<undef> then we do not add a Precedence
583 header to error mail.
587 Set($DefaultErrorMailPrecedence, "bulk");
589 =item C<$UseOriginatorHeader>
591 C<$UseOriginatorHeader> is used to control the insertion of an
592 RT-Originator Header in every outgoing mail, containing the mail
593 address of the transaction creator.
597 Set($UseOriginatorHeader, 1);
599 =item C<$UseFriendlyFromLine>
601 By default, RT sets the outgoing mail's "From:" header to "SenderName
602 via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
606 Set($UseFriendlyFromLine, 1);
608 =item C<$FriendlyFromLineFormat>
610 C<sprintf()> format of the friendly 'From:' header; its arguments are
611 SenderName and SenderEmailAddress.
615 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
617 =item C<$UseFriendlyToLine>
619 RT can optionally set a "Friendly" 'To:' header when sending messages
620 to Ccs or AdminCcs (rather than having a blank 'To:' header.
622 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
623 are using sendmail, rather than postfix, qmail, exim or some other
624 MTA, you _must_ disable this option.
628 Set($UseFriendlyToLine, 0);
630 =item C<$FriendlyToLineFormat>
632 C<sprintf()> format of the friendly 'To:' header; its arguments are
633 WatcherType and TicketId.
637 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
639 =item C<$NotifyActor>
641 By default, RT doesn't notify the person who performs an update, as
642 they already know what they've done. If you'd like to change this
643 behavior, Set C<$NotifyActor> to 1
647 Set($NotifyActor, 0);
649 =item C<$RecordOutgoingEmail>
651 By default, RT records each message it sends out to its own internal
652 database. To change this behavior, set C<$RecordOutgoingEmail> to 0
654 If this is disabled, users' digest mail delivery preferences
655 (i.e. EmailFrequency) will also be ignored.
659 Set($RecordOutgoingEmail, 1);
661 =item C<$VERPPrefix>, C<$VERPDomain>
663 Setting these options enables VERP support
664 L<http://cr.yp.to/proto/verp.txt>.
666 Uncomment the following two directives to generate envelope senders
667 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
668 (i.e. rt-jesse=fsck.com@rt.example.com ).
670 This currently only works with sendmail and sendmailpipe.
674 # Set($VERPPrefix, "rt-");
675 # Set($VERPDomain, $RT::Organization);
678 =item C<$ForwardFromUser>
680 By default, RT forwards a message using queue's address and adds RT's
681 tag into subject of the outgoing message, so recipients' replies go
682 into RT as correspondents.
684 To change this behavior, set C<$ForwardFromUser> to 1 and RT
685 will use the address of the current user and remove RT's subject tag.
689 Set($ForwardFromUser, 0);
693 =head2 Email dashboards
697 =item C<$DashboardAddress>
699 The email address from which RT will send dashboards. If none is set,
700 then C<$OwnerEmail> will be used.
704 Set($DashboardAddress, '');
706 =item C<$DashboardSubject>
708 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
709 Weekly, Monthly) of the dashboard and the dashboard's name.
713 Set($DashboardSubject, "%s Dashboard: %s");
715 =item C<@EmailDashboardRemove>
717 A list of regular expressions that will be used to remove content from
722 Set(@EmailDashboardRemove, ());
728 =head2 Sendmail configuration
730 These options only take effect if C<$MailCommand> is 'sendmail' or
735 =item C<$SendmailArguments>
737 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
738 If you picked 'sendmailpipe', you MUST add a -t flag to
739 C<$SendmailArguments> These options are good for most sendmail
740 wrappers and work-a-likes.
742 These arguments are good for sendmail brand sendmail 8 and newer:
743 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
747 Set($SendmailArguments, "-oi -t");
750 =item C<$SendmailBounceArguments>
752 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
753 assuming RT needs to send an error (i.e. bounce).
757 Set($SendmailBounceArguments, '-f "<>"');
759 =item C<$SendmailPath>
761 If you selected 'sendmailpipe' above, you MUST specify the path to
762 your sendmail binary in C<$SendmailPath>.
766 Set($SendmailPath, "/usr/sbin/sendmail");
771 =head2 SMTP configuration
773 These options only take effect if C<$MailCommand> is 'smtp'
779 C<$SMTPServer> should be set to the hostname of the SMTP server to use
783 Set($SMTPServer, undef);
787 C<$SMTPFrom> should be set to the 'From' address to use, if not the
792 Set($SMTPFrom, undef);
796 C<$SMTPDebug> should be set to 1 to debug SMTP mail sending
810 C<@MailParams> defines a list of options passed to $MailCommand if it
811 is not 'sendmailpipe', 'sendmail', or 'smtp'
815 Set(@MailParams, ());
824 =item C<$WebDefaultStylesheet>
826 This determines the default stylesheet the RT web interface will use.
827 RT ships with several themes by default:
829 web2 The default layout for RT 3.8
830 aileron The default layout for RT 4.0
831 ballard Theme which doesn't rely on JavaScript for menuing
833 This value actually specifies a directory in F<share/html/NoAuth/css/>
834 from which RT will try to load the file main.css (which should @import
835 any other files the stylesheet needs). This allows you to easily and
836 cleanly create your own stylesheets to apply to RT. This option can
837 be overridden by users in their preferences.
841 Set($WebDefaultStylesheet, "aileron");
843 =item C<$DefaultQueue>
845 Use this to select the default queue name that will be used for
846 creating new tickets. You may use either the queue's name or its
847 ID. This only affects the queue selection boxes on the web interface.
851 # Set($DefaultQueue, "General");
853 =item C<$RememberDefaultQueue>
855 When a queue is selected in the new ticket dropdown, make it the new
856 default for the new ticket dropdown.
860 # Set($RememberDefaultQueue, 1);
862 =item C<$EnableReminders>
864 Hide all links and portlets related to Reminders by setting this to 0
868 Set($EnableReminders, 1);
870 =item C<@CustomFieldValuesSources>
872 Set C<@CustomFieldValuesSources> to a list of class names which extend
873 L<RT::CustomFieldValues::External>. This can be used to pull lists of
874 custom field values from external sources at runtime.
878 Set(@CustomFieldValuesSources, ());
880 =item C<$CanonicalizeRedirectURLs>
882 Set C<$CanonicalizeRedirectURLs> to 1 to use C<$WebURL> when
883 redirecting rather than the one we get from C<%ENV>.
885 Apache's UseCanonicalName directive changes the hostname that RT
886 finds in C<%ENV>. You can read more about what turning it On or Off
887 means in the documentation for your version of Apache.
889 If you use RT behind a reverse proxy, you almost certainly want to
894 Set($CanonicalizeRedirectURLs, 0);
898 A list of JavaScript files to be included in head. Removing any of
899 the default entries is not suggested.
901 If you're a plugin author, refer to RT->AddJavaScript.
908 jquery-ui-1.8.4.custom.min.js
909 jquery-ui-timepicker-addon.js
910 jquery-ui-patch-datepicker.js
915 jquery.event.hover-1.0.js
918 jquery.supposition.js
925 Path to the jsmin binary; if specified, it will be used to minify
926 C<JSFiles>. The default, and the fallback if the binary cannot be
927 found, is to simply concatenate the files.
929 jsmin can be installed by running 'make jsmin' from the RT install
930 directory, or from http://www.crockford.com/javascript/jsmin.html
934 # Set($JSMinPath, "/path/to/jsmin");
938 A list of additional CSS files to be included in head.
940 If you're a plugin author, refer to RT->AddStyleSheets.
944 Set(@CSSFiles, qw//);
946 =item C<$UsernameFormat>
948 This determines how user info is displayed. 'concise' will show one of
949 either NickName, RealName, Name or EmailAddress, depending on what
950 exists and whether the user is privileged or not. 'verbose' will show
951 RealName and EmailAddress.
955 Set($UsernameFormat, "concise");
957 =item C<$WebBaseURL>, C<$WebURL>
959 Usually you don't want to set these options. The only obvious reason
960 is if RT is accessible via https protocol on a non standard port, e.g.
961 'https://rt.example.com:9999'. In all other cases these options are
962 computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
964 C<$WebBaseURL> is the scheme, server and port
965 (e.g. 'http://rt.example.com') for constructing URLs to the web
966 UI. C<$WebBaseURL> doesn't need a trailing /.
968 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
969 example: 'http://www.example.com/rt/'.
973 my $port = RT->Config->Get('WebPort');
975 ($port == 443? 'https': 'http') .'://'
976 . RT->Config->Get('WebDomain')
977 . ($port != 80 && $port != 443? ":$port" : '')
980 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
982 =item C<$WebImagesURL>
984 C<$WebImagesURL> points to the base URL where RT can find its images.
985 Define the directory name to be used for images in RT web documents.
989 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
993 C<$LogoURL> points to the URL of the RT logo displayed in the web UI.
994 This can also be configured via the web UI.
998 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bpslogo.png");
1000 =item C<$LogoLinkURL>
1002 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
1006 Set($LogoLinkURL, "http://bestpractical.com");
1008 =item C<$LogoAltText>
1010 C<$LogoAltText> is a string of text for the alt-text of the logo. It
1011 will be passed through C<loc> for localization.
1015 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
1017 =item C<$LogoImageHeight>
1019 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
1024 Set($LogoImageHeight, 38);
1026 =item C<$LogoImageWidth>
1028 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
1033 Set($LogoImageWidth, 181);
1035 =item C<$WebNoAuthRegex>
1037 What portion of RT's URL space should not require authentication. The
1038 default is almost certainly correct, and should only be changed if you
1043 Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
1045 =item C<$SelfServiceRegex>
1047 What portion of RT's URLspace should be accessible to Unprivileged
1048 users This does not override the redirect from F</Ticket/Display.html>
1049 to F</SelfService/Display.html> when Unprivileged users attempt to
1050 access ticked displays.
1054 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1056 =item C<$WebFlushDbCacheEveryRequest>
1058 By default, RT clears its database cache after every page view. This
1059 ensures that you've always got the most current information when
1060 working in a multi-process (mod_perl or FastCGI) Environment. Setting
1061 C<$WebFlushDbCacheEveryRequest> to 0 will turn this off, which will
1062 speed RT up a bit, at the expense of a tiny bit of data accuracy.
1066 Set($WebFlushDbCacheEveryRequest, 1);
1070 The L<GD> module (which RT uses for graphs) ships with a built-in font
1071 that doesn't have full Unicode support. You can use a given TrueType
1072 font for a specific language by setting %ChartFont to (language =E<gt>
1073 the absolute path of a font) pairs. Your GD library must have support
1074 for TrueType fonts to use this option. If there is no entry for a
1075 language in the hash then font with 'others' key is used.
1077 RT comes with two TrueType fonts covering most available languages.
1083 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1084 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1085 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1086 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1089 =item C<$ChartsTimezonesInDB>
1091 RT stores dates using the UTC timezone in the DB, so charts grouped by
1092 dates and time are not representative. Set C<$ChartsTimezonesInDB> to 1
1093 to enable timezone conversions using your DB's capabilities. You may
1094 need to do some work on the DB side to use this feature, read more in
1095 F<docs/customizing/timezones_in_charts.pod>.
1097 At this time, this feature only applies to MySQL and PostgreSQL.
1101 Set($ChartsTimezonesInDB, 0);
1111 =item C<$DefaultSummaryRows>
1113 C<$DefaultSummaryRows> is default number of rows displayed in for
1114 search results on the front page.
1118 Set($DefaultSummaryRows, 10);
1120 =item C<$HomePageRefreshInterval>
1122 C<$HomePageRefreshInterval> is default number of seconds to refresh
1123 the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1127 Set($HomePageRefreshInterval, 0);
1129 =item C<$HomepageComponents>
1131 C<$HomepageComponents> is an arrayref of allowed components on a
1132 user's customized homepage ("RT at a glance").
1137 $HomepageComponents,
1139 qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches) # loc_qw
1148 =head2 Ticket search
1152 =item C<$UseSQLForACLChecks>
1154 Historically, ACLs were checked on display, which could lead to empty
1155 search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
1156 to limit search results in SQL instead, which eliminates these
1159 This option is still relatively new; it may result in performance
1160 problems in some cases, or significant speedups in others.
1164 Set($UseSQLForACLChecks, undef);
1166 =item C<$TicketsItemMapSize>
1168 On the display page of a ticket from search results, RT provides links
1169 to the first, next, previous and last ticket from the results. In
1170 order to build these links, RT needs to fetch the full result set from
1171 the database, which can be resource-intensive.
1173 Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
1174 to build these links. If the full result set is larger than this
1175 number, RT will omit the "last" link in the menu. Set this to zero to
1176 always examine all results.
1180 Set($TicketsItemMapSize, 1000);
1182 =item C<$SearchResultsRefreshInterval>
1184 C<$SearchResultsRefreshInterval> is default number of seconds to
1185 refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
1190 Set($SearchResultsRefreshInterval, 0);
1192 =item C<$DefaultSearchResultFormat>
1194 C<$DefaultSearchResultFormat> is the default format for RT search
1199 Set ($DefaultSearchResultFormat, qq{
1200 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1201 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1208 '<small>__Requestors__</small>',
1209 '<small>__CreatedRelative__</small>',
1210 '<small>__ToldRelative__</small>',
1211 '<small>__LastUpdatedRelative__</small>',
1212 '<small>__TimeLeft__</small>'});
1214 =item C<$DefaultSelfServiceSearchResultFormat>
1216 C<$DefaultSelfServiceSearchResultFormat> is the default format of
1217 searches displayed in the SelfService interface.
1221 Set($DefaultSelfServiceSearchResultFormat, qq{
1222 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1223 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1228 =item C<%FullTextSearch>
1230 Full text search (FTS) without database indexing is a very slow
1231 operation, and is thus disabled by default.
1233 Before setting C<Indexed> to 1, read F<docs/full_text_indexing.pod> for
1234 the full details of FTS on your particular database.
1236 It is possible to enable FTS without database indexing support, simply
1237 by setting the C<Enable> key to 1, while leaving C<Indexed> set to 0.
1238 This is not generally suggested, as unindexed full-text searching can
1239 cause severe performance problems.
1243 Set(%FullTextSearch,
1248 =item C<$DontSearchFileAttachments>
1250 If C<$DontSearchFileAttachments> is set to 1, then uploaded files
1251 (attachments with file names) are not searched during content
1254 Note that if you use indexed FTS then named attachments are still
1255 indexed by default regardless of this option.
1259 Set($DontSearchFileAttachments, undef);
1261 =item C<$OnlySearchActiveTicketsInSimpleSearch>
1263 When query in simple search doesn't have status info, use this to only
1268 Set($OnlySearchActiveTicketsInSimpleSearch, 1);
1270 =item C<$SearchResultsAutoRedirect>
1272 When only one ticket is found in search, use this to redirect to the
1273 ticket display page automatically.
1277 Set($SearchResultsAutoRedirect, 0);
1283 =head2 Ticket display
1287 =item C<$ShowMoreAboutPrivilegedUsers>
1289 This determines if the 'More about requestor' box on
1290 Ticket/Display.html is shown for Privileged Users.
1294 Set($ShowMoreAboutPrivilegedUsers, 0);
1296 =item C<$MoreAboutRequestorTicketList>
1298 This can be set to Active, Inactive, All or None. It controls what
1299 ticket list will be displayed in the 'More about requestor' box on
1300 Ticket/Display.html. This option can be controlled by users also.
1304 Set($MoreAboutRequestorTicketList, "Active");
1306 =item C<$MoreAboutRequestorExtraInfo>
1308 By default, the 'More about requestor' box on Ticket/Display.html
1309 shows the Requestor's name and ticket list. If you would like to see
1310 extra information about the user, this expects a Format string of user
1311 attributes. Please note that not all the attributes are supported in
1312 this display because we're not building a table.
1315 C<Set($MoreAboutRequestorExtraInfo,"Organization, Address1")>
1319 Set($MoreAboutRequestorExtraInfo, "");
1321 =item C<$MoreAboutRequestorGroupsLimit>
1323 By default, the 'More about requestor' box on Ticket/Display.html
1324 shows all the groups of the Requestor. Use this to limit the number
1325 of groups; a value of undef removes the group display entirely.
1329 Set($MoreAboutRequestorGroupsLimit, 0);
1331 =item C<$UseSideBySideLayout>
1333 Should the ticket create and update forms use a more space efficient
1334 two column layout. This layout may not work in narrow browsers if you
1335 set a MessageBoxWidth (below).
1339 Set($UseSideBySideLayout, 1);
1341 =item C<$EditCustomFieldsSingleColumn>
1343 When displaying a list of Ticket Custom Fields for editing, RT
1344 defaults to a 2 column list. If you set this to 1, it will instead
1345 display the Custom Fields in a single column.
1349 Set($EditCustomFieldsSingleColumn, 0);
1351 =item C<$ShowUnreadMessageNotifications>
1353 If set to 1, RT will prompt users when there are new,
1354 unread messages on tickets they are viewing.
1358 Set($ShowUnreadMessageNotifications, 0);
1360 =item C<$AutocompleteOwners>
1362 If set to 1, the owner drop-downs for ticket update/modify and the query
1363 builder are replaced by text fields that autocomplete. This can
1364 alleviate the sometimes huge owner list for installations where many
1365 users have the OwnTicket right.
1369 Set($AutocompleteOwners, 0);
1371 =item C<$AutocompleteOwnersForSearch>
1373 If set to 1, the owner drop-downs for the query builder are always
1374 replaced by text field that autocomplete and C<$AutocompleteOwners>
1375 is ignored. Helpful when owners list is huge in the query builder.
1379 Set($AutocompleteOwnersForSearch, 0);
1381 =item C<$UserAutocompleteFields>
1383 Specifies which fields of L<RT::User> to match against and how to
1384 match each field when autocompleting users. Valid match methods are
1385 LIKE, STARTSWITH, ENDSWITH, =, and !=.
1389 Set($UserAutocompleteFields, {
1390 EmailAddress => 'STARTSWITH',
1391 Name => 'STARTSWITH',
1395 =item C<$AllowUserAutocompleteForUnprivileged>
1397 Should unprivileged users be allowed to autocomplete users. Setting
1398 this option to 1 means unprivileged users will be able to search all
1403 Set($AllowUserAutocompleteForUnprivileged, 0);
1405 =item C<$DisplayTicketAfterQuickCreate>
1407 Enable this to redirect to the created ticket display page
1408 automatically when using QuickCreate.
1412 Set($DisplayTicketAfterQuickCreate, 0);
1414 =item C<$WikiImplicitLinks>
1416 Support implicit links in WikiText custom fields? Setting this to 1
1417 causes InterCapped or ALLCAPS words in WikiText fields to automatically
1418 become links to searches for those words. If used on Articles, it links
1419 to the Article with that name.
1423 Set($WikiImplicitLinks, 0);
1425 =item C<$PreviewScripMessages>
1427 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1428 reply page should include the content of the messages to be sent.
1432 Set($PreviewScripMessages, 0);
1434 =item C<$SimplifiedRecipients>
1436 If C<$SimplifiedRecipients> is set, a simple list of who will receive
1437 B<any> kind of mail will be shown on the ticket reply page, instead of a
1438 detailed breakdown by scrip.
1442 Set($SimplifiedRecipients, 0);
1444 =item C<$HideResolveActionsWithDependencies>
1446 If set to 1, this option will skip ticket menu actions which can't be
1447 completed successfully because of outstanding active Depends On tickets.
1449 By default, all ticket actions are displayed in the menu even if some of
1450 them can't be successful until all Depends On links are resolved or
1451 transitioned to another inactive status.
1455 Set($HideResolveActionsWithDependencies, 0);
1465 =item C<$ArticleOnTicketCreate>
1467 Set this to 1 to display the Articles interface on the Ticket Create
1468 page in addition to the Reply/Comment page.
1472 Set($ArticleOnTicketCreate, 0);
1474 =item C<$HideArticleSearchOnReplyCreate>
1476 Set this to 1 to hide the search and include boxes from the Article
1477 UI. This assumes you have enabled Article Hotlist feature, otherwise
1478 you will have no access to Articles.
1482 Set($HideArticleSearchOnReplyCreate, 0);
1488 =head2 Message box properties
1492 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1494 For message boxes, set the entry box width, height and what type of
1495 wrapping to use. These options can be overridden by users in their
1498 When the width is set to undef, no column count is specified and the
1499 message box will take up 100% of the available width. Combining this
1500 with HARD messagebox wrapping (below) is not recommended, as it will
1501 lead to inconsistent width in transactions between browsers.
1503 These settings only apply to the non-RichText message box. See below
1504 for Rich Text settings.
1508 Set($MessageBoxWidth, undef);
1509 Set($MessageBoxHeight, 15);
1511 =item C<$MessageBoxWrap>
1513 Wrapping is disabled when using MessageBoxRichText because of a bad
1514 interaction between IE and wrapping with the Rich Text Editor.
1518 Set($MessageBoxWrap, "SOFT");
1520 =item C<$MessageBoxRichText>
1522 Should "rich text" editing be enabled? This option lets your users
1523 send HTML email messages from the web interface.
1527 Set($MessageBoxRichText, 1);
1529 =item C<$MessageBoxRichTextHeight>
1531 Height of rich text JavaScript enabled editing boxes (in pixels)
1535 Set($MessageBoxRichTextHeight, 200);
1537 =item C<$MessageBoxIncludeSignature>
1539 Should your users' signatures (from their Preferences page) be
1540 included in Comments and Replies.
1544 Set($MessageBoxIncludeSignature, 1);
1546 =item C<$MessageBoxIncludeSignatureOnComment>
1548 Should your users' signatures (from their Preferences page) be
1549 included in Comments. Setting this to false overrides
1550 C<$MessageBoxIncludeSignature>.
1554 Set($MessageBoxIncludeSignatureOnComment, 1);
1559 =head2 Transaction display
1563 =item C<$OldestTransactionsFirst>
1565 By default, RT shows newest transactions at the bottom of the ticket
1566 history page, if you want see them at the top set this to 0. This
1567 option can be overridden by users in their preferences.
1571 Set($OldestTransactionsFirst, 1);
1573 =item C<$DeferTransactionLoading>
1575 When set, defers loading ticket history until the user clicks a link.
1576 This should end up serving pages to users quicker, since generating
1577 all the HTML for transaction history can be slow for long tickets.
1581 # Set($DeferTransactionLoading, 1);
1583 =item C<$ShowBccHeader>
1585 By default, RT hides from the web UI information about blind copies
1586 user sent on reply or comment.
1590 Set($ShowBccHeader, 0);
1592 =item C<$TrustHTMLAttachments>
1594 If C<TrustHTMLAttachments> is not defined, we will display them as
1595 text. This prevents malicious HTML and JavaScript from being sent in a
1596 request (although there is probably more to it than that)
1600 Set($TrustHTMLAttachments, undef);
1602 =item C<$AlwaysDownloadAttachments>
1604 Always download attachments, regardless of content type. If set, this
1605 overrides C<TrustHTMLAttachments>.
1609 Set($AlwaysDownloadAttachments, undef);
1611 =item C<$AttachmentUnits>
1613 Controls the units (kilobytes or bytes) that attachment sizes use for
1614 display. The default is to display kilobytes if the attachment is
1615 larger than 1024 bytes, bytes otherwise. If you set
1616 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1617 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1621 Set($AttachmentUnits, undef);
1623 =item C<$PreferRichText>
1625 If C<$PreferRichText> is set to 1, RT will show HTML/Rich text messages
1626 in preference to their plain-text alternatives. RT "scrubs" the HTML to
1627 show only a minimal subset of HTML to avoid possible contamination by
1628 cross-site-scripting attacks.
1632 Set($PreferRichText, undef);
1634 =item C<$MaxInlineBody>
1636 C<$MaxInlineBody> is the maximum attachment size that we want to see
1637 inline when viewing a transaction. RT will inline any text if the
1638 value is undefined or 0. This option can be overridden by users in
1643 Set($MaxInlineBody, 12000);
1645 =item C<$ShowTransactionImages>
1647 By default, RT shows images attached to incoming (and outgoing) ticket
1648 updates inline. Set this variable to 0 if you'd like to disable that
1653 Set($ShowTransactionImages, 1);
1655 =item C<$PlainTextPre>
1657 Normally plaintext attachments are displayed as HTML with line breaks
1658 preserved. This causes space- and tab-based formatting not to be
1659 displayed correctly. By setting $PlainTextPre messages will be
1660 displayed using <pre>.
1664 Set($PlainTextPre, 0);
1667 =item C<$PlainTextMono>
1669 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1670 formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
1671 of the browser window; this option overrides C<$PlainTextPre>.
1675 Set($PlainTextMono, 0);
1677 =item C<$SuppressInlineTextFiles>
1679 If C<$SuppressInlineTextFiles> is set to 1, then uploaded text files
1680 (text-type attachments with file names) are prevented from being
1681 displayed in-line when viewing a ticket's history.
1685 Set($SuppressInlineTextFiles, undef);
1688 =item C<@Active_MakeClicky>
1690 MakeClicky detects various formats of data in headers and email
1691 messages, and extends them with supporting links. By default, RT
1692 provides two formats:
1694 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1697 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1698 replaces the URL with a link.
1700 See F<share/html/Elements/MakeClicky> for documentation on how to add
1701 your own styles of link detection.
1705 Set(@Active_MakeClicky, qw());
1711 =head1 Application logic
1715 =item C<$ParseNewMessageForTicketCcs>
1717 If C<$ParseNewMessageForTicketCcs> is set to 1, RT will attempt to
1718 divine Ticket 'Cc' watchers from the To and Cc lines of incoming
1719 messages. Be forewarned that if you have I<any> addresses which forward
1720 mail to RT automatically and you enable this option without modifying
1721 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
1725 Set($ParseNewMessageForTicketCcs, undef);
1727 =item C<$UseTransactionBatch>
1729 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1730 such that a resolve and comment (for example) would happen
1731 simultaneously, instead of as two transactions, unaware of each
1736 Set($UseTransactionBatch, 1);
1738 =item C<$StrictLinkACL>
1740 When this feature is enabled a user needs I<ModifyTicket> rights on
1741 both tickets to link them together; otherwise, I<ModifyTicket> rights
1742 on either of them is sufficient.
1746 Set($StrictLinkACL, 1);
1748 =item C<$RedistributeAutoGeneratedMessages>
1750 Should RT redistribute correspondence that it identifies as machine
1751 generated? A 1 will do so; setting this to 0 will cause no
1752 such messages to be redistributed. You can also use 'privileged' (the
1753 default), which will redistribute only to privileged users. This helps
1754 to protect against malformed bounces and loops caused by auto-created
1755 requestors with bogus addresses.
1759 Set($RedistributeAutoGeneratedMessages, "privileged");
1761 =item C<$ApprovalRejectionNotes>
1763 Should rejection notes from approvals be sent to the requestors?
1767 Set($ApprovalRejectionNotes, 1);
1769 =item C<$ForceApprovalsView>
1771 Should approval tickets only be viewed and modified through the standard
1772 approval interface? Changing this setting to 1 will redirect any attempt to
1773 use the normal ticket display and modify page for approval tickets.
1775 For example, with this option set to 1 and an approval ticket #123:
1777 /Ticket/Display.html?id=123
1781 /Approval/Display.html?id=123
1787 Set($ForceApprovalsView, 0);
1789 =head1 Extra security
1791 This is a list of extra security measures to enable that help keep your RT
1792 safe. If you don't know what these mean, you should almost certainly leave the
1797 =item C<$DisallowExecuteCode>
1799 If set to a true value, the C<ExecuteCode> right will be removed from
1800 all users, B<including> the superuser. This is intended for when RT is
1801 installed into a shared environment where even the superuser should not
1802 be allowed to run arbitrary Perl code on the server via scrips.
1806 Set($DisallowExecuteCode, 0);
1808 =item C<$Framebusting>
1810 If set to a false value, framekiller javascript will be disabled and the
1811 X-Frame-Options: DENY header will be suppressed from all responses.
1812 This disables RT's clickjacking protection.
1816 Set($Framebusting, 1);
1818 =item C<$RestrictReferrer>
1820 If set to a false value, the HTTP C<Referer> (sic) header will not be
1821 checked to ensure that requests come from RT's own domain. As RT allows
1822 for GET requests to alter state, disabling this opens RT up to
1823 cross-site request forgery (CSRF) attacks.
1827 Set($RestrictReferrer, 1);
1829 =item C<$RestrictLoginReferrer>
1831 If set to a false value, RT will allow the user to log in from any link
1832 or request, merely by passing in C<user> and C<pass> parameters; setting
1833 it to a true value forces all logins to come from the login box, so the
1834 user is aware that they are being logged in. The default is off, for
1835 backwards compatability.
1839 Set($RestrictLoginReferrer, 0);
1841 =item C<@ReferrerWhitelist>
1843 This is a list of hostname:port combinations that RT will treat as being
1844 part of RT's domain. This is particularly useful if you access RT as
1845 multiple hostnames or have an external auth system that needs to
1846 redirect back to RT once authentication is complete.
1848 Set(@ReferrerWhitelist, qw(www.example.com:443 www3.example.com:80));
1850 If the "RT has detected a possible cross-site request forgery" error is triggered
1851 by a host:port sent by your browser that you believe should be valid, you can copy
1852 the host:port from the error message into this list.
1854 Simple wildcards, similar to SSL certificates, are allowed. For example:
1856 *.example.com:80 # matches foo.example.com
1857 # but not example.com
1858 # or foo.bar.example.com
1860 www*.example.com:80 # matches www3.example.com
1861 # and www-test.example.com
1862 # and www.example.com
1866 Set(@ReferrerWhitelist, qw());
1872 =head1 Authorization and user configuration
1876 =item C<$WebExternalAuth>
1878 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1879 REMOTE_USER variable.
1883 Set($WebExternalAuth, undef);
1885 =item C<$WebExternalAuthContinuous>
1887 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1888 REMOTE_USER on each access. If you would prefer this to only happen
1889 once (at initial login) set this to a false value. The default
1890 setting will help ensure that if your external authentication system
1891 deauthenticates a user, RT notices as soon as possible.
1895 Set($WebExternalAuthContinuous, 1);
1897 =item C<$WebFallbackToInternalAuth>
1899 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
1900 chance of fallback to the login screen, even if REMOTE_USER failed.
1904 Set($WebFallbackToInternalAuth, undef);
1906 =item C<$WebExternalGecos>
1908 C<$WebExternalGecos> means to match 'gecos' field as the user
1909 identity); useful with mod_auth_pwcheck and IIS Integrated Windows
1914 Set($WebExternalGecos, undef);
1916 =item C<$WebExternalAuto>
1918 C<$WebExternalAuto> will create users under the same name as
1919 REMOTE_USER upon login, if it's missing in the Users table.
1923 Set($WebExternalAuto, undef);
1925 =item C<$AutoCreate>
1927 If C<$WebExternalAuto> is set to 1, C<$AutoCreate> will be passed to
1928 User's Create method. Use it to set defaults, such as creating
1929 Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
1933 Set($AutoCreate, undef);
1935 =item C<$WebSessionClass>
1937 C<$WebSessionClass> is the class you wish to use for managing sessions.
1938 It defaults to use your SQL database, except on Oracle, where it
1939 defaults to files on disk.
1943 # Set($WebSessionClass, "Apache::Session::File");
1945 =item C<$AutoLogoff>
1947 By default, RT's user sessions persist until a user closes his or her
1948 browser. With the C<$AutoLogoff> option you can setup session lifetime
1949 in minutes. A user will be logged out if he or she doesn't send any
1950 requests to RT for the defined time.
1954 Set($AutoLogoff, 0);
1956 =item C<$LogoutRefresh>
1958 The number of seconds to wait after logout before sending the user to
1959 the login page. By default, 1 second, though you may want to increase
1960 this if you display additional information on the logout page.
1964 Set($LogoutRefresh, 1);
1966 =item C<$WebSecureCookies>
1968 By default, RT's session cookie isn't marked as "secure". Some web
1969 browsers will treat secure cookies more carefully than non-secure
1970 ones, being careful not to write them to disk, only sending them over
1971 an SSL secured connection, and so on. To enable this behavior, set
1972 C<$WebSecureCookies> to 1. NOTE: You probably don't want to turn this
1973 on I<unless> users are only connecting via SSL encrypted HTTPS
1978 Set($WebSecureCookies, 0);
1980 =item C<$WebHttpOnlyCookies>
1982 Default RT's session cookie to not being directly accessible to
1983 javascript. The content is still sent during regular and AJAX requests,
1984 and other cookies are unaffected, but the session-id is less
1985 programmatically accessible to javascript. Turning this off should only
1986 be necessary in situations with odd client-side authentication
1991 Set($WebHttpOnlyCookies, 1);
1993 =item C<$MinimumPasswordLength>
1995 C<$MinimumPasswordLength> defines the minimum length for user
1996 passwords. Setting it to 0 disables this check.
2000 Set($MinimumPasswordLength, 5);
2005 =head1 Internationalization
2009 =item C<@LexiconLanguages>
2011 An array that contains languages supported by RT's
2012 internationalization interface. Defaults to all *.po lexicons;
2013 setting it to C<qw(en ja)> will make RT bilingual instead of
2014 multilingual, but will save some memory.
2018 Set(@LexiconLanguages, qw(*));
2020 =item C<@EmailInputEncodings>
2022 An array that contains default encodings used to guess which charset
2023 an attachment uses, if it does not specify one explicitly. All
2024 options must be recognized by L<Encode::Guess>. The first element may
2025 also be '*', which enables encoding detection using
2026 L<Encode::Detect::Detector>, if installed.
2030 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
2032 =item C<$EmailOutputEncoding>
2034 The charset for localized email. Must be recognized by Encode.
2038 Set($EmailOutputEncoding, "utf-8");
2048 =head1 Date and time handling
2052 =item C<$DateTimeFormat>
2054 You can choose date and time format. See the "Output formatters"
2055 section in perldoc F<lib/RT/Date.pm> for more options. This option
2056 can be overridden by users in their preferences.
2060 C<Set($DateTimeFormat, "LocalizedDateTime");>
2061 C<Set($DateTimeFormat, { Format => "ISO", Seconds => 0 });>
2062 C<Set($DateTimeFormat, "RFC2822");>
2063 C<Set($DateTimeFormat, { Format => "RFC2822", Seconds => 0, DayOfWeek => 0 });>
2067 Set($DateTimeFormat, "DefaultFormat");
2069 # Next two options are for Time::ParseDate
2071 =item C<$DateDayBeforeMonth>
2073 Set this to 1 if your local date convention looks like "dd/mm/yy"
2074 instead of "mm/dd/yy". Used only for parsing, not for displaying
2079 Set($DateDayBeforeMonth, 1);
2081 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
2083 Should an unspecified day or year in a date refer to a future or a
2084 past value? For example, should a date of "Tuesday" default to mean
2085 the date for next Tuesday or last Tuesday? Should the date "March 1"
2086 default to the date for next March or last March?
2088 Set C<$AmbiguousDayInPast> for the last date, or
2089 C<$AmbiguousDayInFuture> for the next date; the default is usually
2090 correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
2094 Set($AmbiguousDayInPast, 0);
2095 Set($AmbiguousDayInFuture, 0);
2097 =item C<$DefaultTimeUnitsToHours>
2099 Use this to set the default units for time entry to hours instead of
2100 minutes. Note that this only effects entry, not display.
2104 Set($DefaultTimeUnitsToHours, 0);
2111 =head1 GnuPG integration
2113 A full description of the (somewhat extensive) GnuPG integration can
2114 be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
2115 `perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
2121 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
2122 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
2124 If you want to allow people to encrypt attachments inside the DB then
2125 set C<AllowEncryptDataInDB> to 1.
2127 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
2128 emails encrypted for key RT doesn't have and can not decrypt.
2130 Set C<RejectOnBadData> to false if you don't want to reject letters
2131 with incorrect GnuPG data.
2137 OutgoingMessagesFormat => "RFC", # Inline
2138 AllowEncryptDataInDB => 0,
2140 RejectOnMissingPrivateKey => 1,
2141 RejectOnBadData => 1,
2144 =item C<%GnuPGOptions>
2146 Options to pass to the GnuPG program.
2148 If you override this in your RT_SiteConfig, you should be sure to
2149 include a homedir setting.
2151 Note that options with '-' character MUST be quoted.
2156 homedir => q{var/data/gpg},
2158 # URL of a keyserver
2159 # keyserver => 'hkp://subkeys.pgp.net',
2161 # enables the automatic retrieving of keys when encrypting
2162 # 'auto-key-locate' => 'keyserver',
2164 # enables the automatic retrieving of keys when verifying signatures
2165 # 'auto-key-retrieve' => undef,
2174 =head2 Lifecycle definitions
2176 Each lifecycle is a list of possible statuses split into three logic
2177 sets: B<initial>, B<active> and B<inactive>. Each status in a
2178 lifecycle must be unique. (Statuses may not be repeated across sets.)
2179 Each set may have any number of statuses.
2185 active => ['open', 'stalled'],
2186 inactive => ['resolved', 'rejected', 'deleted'],
2190 Status names can be from 1 to 64 ASCII characters. Statuses are
2191 localized using RT's standard internationalization and localization
2198 You can define multiple B<initial> statuses for tickets in a given
2201 RT will automatically set its B<Started> date when you change a
2202 ticket's status from an B<initial> state to an B<active> or
2207 B<Active> tickets are "currently in play" - they're things that are
2208 being worked on and not yet complete.
2212 B<Inactive> tickets are typically in their "final resting state".
2214 While you're free to implement a workflow that ignores that
2215 description, typically once a ticket enters an inactive state, it will
2216 never again enter an active state.
2218 RT will automatically set the B<Resolved> date when a ticket's status
2219 is changed from an B<Initial> or B<Active> status to an B<Inactive>
2222 B<deleted> is still a special status and protected by the
2223 B<DeleteTicket> right, unless you re-defined rights (read below). If
2224 you don't want to allow ticket deletion at any time simply don't
2225 include it in your lifecycle.
2229 Statuses in each set are ordered and listed in the UI in the defined
2232 Changes between statuses are constrained by transition rules, as
2235 =head2 Default values
2237 In some cases a default value is used to display in UI or in API when
2238 value is not provided. You can configure defaults using the following
2245 on_resolve => 'resolved',
2250 The following defaults are used.
2256 If you (or your code) doesn't specify a status when creating a ticket,
2257 RT will use the this status. See also L</Statuses available during
2262 When tickets are merged, the status of the ticket that was merged
2263 away is forced to this value. It should be one of inactive statuses;
2264 'resolved' or its equivalent is most probably the best candidate.
2268 When an approval is accepted, the status of depending tickets will
2269 be changed to this value.
2273 When an approval is denied, the status of depending tickets will
2274 be changed to this value.
2276 =item reminder_on_open
2278 When a reminder is opened, the status will be changed to this value.
2280 =item reminder_on_resolve
2282 When a reminder is resolved, the status will be changed to this value.
2286 =head2 Transitions between statuses and UI actions
2288 A B<Transition> is a change of status from A to B. You should define
2289 all possible transitions in each lifecycle using the following format:
2294 '' => [qw(new open resolved)],
2295 new => [qw(open resolved rejected deleted)],
2296 open => [qw(stalled resolved rejected deleted)],
2297 stalled => [qw(open)],
2298 resolved => [qw(open)],
2299 rejected => [qw(open)],
2300 deleted => [qw(open)],
2305 =head3 Statuses available during ticket creation
2307 By default users can create tickets with a status of new,
2308 open, or resolved, but cannot create tickets with a status of
2309 rejected, stalled, or deleted. If you want to change the statuses
2310 available during creation, update the transition from '' (empty
2311 string), like in the example above.
2313 =head3 Protecting status changes with rights
2315 A transition or group of transitions can be protected by a specific
2316 right. Additionally, you can name new right names, which will be added
2317 to the system to control that transition. For example, if you wished to
2318 create a lesser right than ModifyTicket for rejecting tickets, you could
2324 '* -> deleted' => 'DeleteTicket',
2325 '* -> rejected' => 'RejectTicket',
2326 '* -> *' => 'ModifyTicket',
2331 This would create a new C<RejectTicket> right in the system which you
2332 could assign to whatever groups you choose.
2334 On the left hand side you can have the following variants:
2341 Valid transitions are listed in order of priority. If a user attempts
2342 to change a ticket's status from B<new> to B<open> then the lifecycle
2343 is checked for presence of an exact match, then for 'any to B<open>',
2344 'B<new> to any' and finally 'any to any'.
2346 If you don't define any rights, or there is no match for a transition,
2347 RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
2349 =head3 Labeling and defining actions
2351 For each transition you can define an action that will be shown in the
2352 UI; each action annotated with a label and an update type.
2354 Each action may provide a default update type, which can be
2355 B<Comment>, B<Respond>, or absent. For example, you may want your
2356 staff to write a reply to the end user when they change status from
2357 B<new> to B<open>, and thus set the update to B<Respond>. Neither
2358 B<Comment> nor B<Respond> are mandatory, and user may leave the
2359 message empty, regardless of the update type.
2361 This configuration can be used to accomplish what
2362 $ResolveDefaultUpdateType was used for in RT 3.8.
2364 Use the following format to define labels and actions of transitions:
2369 'new -> open' => { label => 'Open it', update => 'Respond' },
2370 'new -> resolved' => { label => 'Resolve', update => 'Comment' },
2371 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2372 'new -> deleted' => { label => 'Delete' },
2374 'open -> stalled' => { label => 'Stall', update => 'Comment' },
2375 'open -> resolved' => { label => 'Resolve', update => 'Comment' },
2376 'open -> rejected' => { label => 'Reject', update => 'Respond' },
2378 'stalled -> open' => { label => 'Open it' },
2379 'resolved -> open' => { label => 'Re-open', update => 'Comment' },
2380 'rejected -> open' => { label => 'Re-open', update => 'Comment' },
2381 'deleted -> open' => { label => 'Undelete' },
2386 In addition, you may define multiple actions for the same transition.
2387 Alternately, you may use '* -> x' to match more than one transition.
2394 'new -> rejected' => { label => 'Reject', update => 'Respond' },
2395 'new -> rejected' => { label => 'Quick Reject' },
2397 '* -> deleted' => { label => 'Delete' },
2403 =head2 Moving tickets between queues with different lifecycles
2405 Unless there is an explicit mapping between statuses in two different
2406 lifecycles, you can not move tickets between queues with these
2407 lifecycles. This is true even if the different lifecycles use the exact
2408 same set of statuses. Such a mapping is defined as follows:
2411 'from lifecycle -> to lifecycle' => {
2412 'status in left lifecycle' => 'status in right lifecycle',
2422 initial => [ 'new' ],
2423 active => [ 'open', 'stalled' ],
2424 inactive => [ 'resolved', 'rejected', 'deleted' ],
2428 on_merge => 'resolved',
2430 denied => 'rejected',
2431 reminder_on_open => 'open',
2432 reminder_on_resolve => 'resolved',
2436 '' => [qw(new open resolved)],
2438 # from => [ to list ],
2439 new => [qw(open stalled resolved rejected deleted)],
2440 open => [qw(new stalled resolved rejected deleted)],
2441 stalled => [qw(new open rejected resolved deleted)],
2442 resolved => [qw(new open stalled rejected deleted)],
2443 rejected => [qw(new open stalled resolved deleted)],
2444 deleted => [qw(new open stalled rejected resolved)],
2447 '* -> deleted' => 'DeleteTicket',
2448 '* -> *' => 'ModifyTicket',
2452 label => 'Open It', # loc
2453 update => 'Respond',
2455 'new -> resolved' => {
2456 label => 'Resolve', # loc
2457 update => 'Comment',
2459 'new -> rejected' => {
2460 label => 'Reject', # loc
2461 update => 'Respond',
2463 'new -> deleted' => {
2464 label => 'Delete', # loc
2467 'open -> stalled' => {
2468 label => 'Stall', # loc
2469 update => 'Comment',
2471 'open -> resolved' => {
2472 label => 'Resolve', # loc
2473 update => 'Comment',
2475 'open -> rejected' => {
2476 label => 'Reject', # loc
2477 update => 'Respond',
2480 'stalled -> open' => {
2481 label => 'Open It', # loc
2483 'resolved -> open' => {
2484 label => 'Re-open', # loc
2485 update => 'Comment',
2487 'rejected -> open' => {
2488 label => 'Re-open', # loc
2489 update => 'Comment',
2491 'deleted -> open' => {
2492 label => 'Undelete', # loc
2496 # don't change lifecyle of the approvals, they are not capable to deal with
2499 initial => [ 'new' ],
2500 active => [ 'open', 'stalled' ],
2501 inactive => [ 'resolved', 'rejected', 'deleted' ],
2505 on_merge => 'resolved',
2506 reminder_on_open => 'open',
2507 reminder_on_resolve => 'resolved',
2511 '' => [qw(new open resolved)],
2513 # from => [ to list ],
2514 new => [qw(open stalled resolved rejected deleted)],
2515 open => [qw(new stalled resolved rejected deleted)],
2516 stalled => [qw(new open rejected resolved deleted)],
2517 resolved => [qw(new open stalled rejected deleted)],
2518 rejected => [qw(new open stalled resolved deleted)],
2519 deleted => [qw(new open stalled rejected resolved)],
2522 '* -> deleted' => 'DeleteTicket',
2523 '* -> rejected' => 'ModifyTicket',
2524 '* -> *' => 'ModifyTicket',
2528 label => 'Open It', # loc
2529 update => 'Respond',
2531 'new -> resolved' => {
2532 label => 'Resolve', # loc
2533 update => 'Comment',
2535 'new -> rejected' => {
2536 label => 'Reject', # loc
2537 update => 'Respond',
2539 'new -> deleted' => {
2540 label => 'Delete', # loc
2543 'open -> stalled' => {
2544 label => 'Stall', # loc
2545 update => 'Comment',
2547 'open -> resolved' => {
2548 label => 'Resolve', # loc
2549 update => 'Comment',
2551 'open -> rejected' => {
2552 label => 'Reject', # loc
2553 update => 'Respond',
2556 'stalled -> open' => {
2557 label => 'Open It', # loc
2559 'resolved -> open' => {
2560 label => 'Re-open', # loc
2561 update => 'Comment',
2563 'rejected -> open' => {
2564 label => 'Re-open', # loc
2565 update => 'Comment',
2567 'deleted -> open' => {
2568 label => 'Undelete', # loc
2578 =head1 Administrative interface
2582 =item C<$ShowRTPortal>
2584 RT can show administrators a feed of recent RT releases and other
2585 related announcements and information from Best Practical on the top
2586 level Configuration page. This feature helps you stay up to date on
2587 RT security announcements and version updates.
2589 RT provides this feature using an "iframe" on C</Admin/index.html>
2590 which asks the administrator's browser to show an inline page from
2591 Best Practical's website.
2593 If you'd rather not make this feature available to your
2594 administrators, set C<$ShowRTPortal> to a false value.
2598 Set($ShowRTPortal, 1);
2600 =item C<%AdminSearchResultFormat>
2602 In the admin interface, format strings similar to tickets result
2603 formats are used. Use C<%AdminSearchResultFormat> to define the format
2604 strings used in the admin interface on a per-RT-class basis.
2608 Set(%AdminSearchResultFormat,
2610 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2611 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2612 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__,__Lifecycle__},
2615 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2616 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2617 .q{,'__Description__'},
2620 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2621 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2622 .q{,__RealName__, __EmailAddress__},
2625 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2626 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2627 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
2630 q{'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
2631 .q{,'<a href="__WebPath__/Admin/Queues/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
2632 .q{,__Stage__, __Condition__, __Action__, __Template__},
2635 q{'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__id__</a>/TITLE:#'}
2636 .q{,'<a href="__WebPath__/Admin/Global/Scrip.html?id=__id__">__Description__</a>/TITLE:Description'}
2637 .q{,__Stage__, __Condition__, __Action__, __Template__},
2640 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
2641 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
2642 .q{,'__Description__'},
2644 q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
2645 .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
2646 .q{,__Description__},
2654 =head1 Development options
2660 RT comes with a "Development mode" setting. This setting, as a
2661 convenience for developers, turns on several of development options
2662 that you most likely don't want in production:
2668 Disables CSS and JS minification and concatenation. Both CSS and JS
2669 will be instead be served as a number of individual smaller files,
2670 unchanged from how they are stored on disk.
2674 Uses L<Module::Refresh> to reload changed Perl modules on each
2679 Turns off Mason's C<static_source> directive; this causes Mason to
2680 reload template files which have been modified on disk.
2684 Turns on Mason's HTML C<error_format>; this renders compilation errors
2685 to the browser, along with a full stack trace. It is possible for
2686 stack traces to reveal sensitive information such as passwords or
2691 Turns off caching of callbacks; this enables additional callbacks to
2692 be added while the server is running.
2698 Set($DevelMode, "0");
2701 =item C<$RecordBaseClass>
2703 What abstract base class should RT use for its records. You should
2704 probably never change this.
2706 Valid values are C<DBIx::SearchBuilder::Record> or
2707 C<DBIx::SearchBuilder::Record::Cachable>
2711 Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
2714 =item C<@MasonParameters>
2716 C<@MasonParameters> is the list of parameters for the constructor of
2717 HTML::Mason's Apache or CGI Handler. This is normally only useful for
2718 debugging, e.g. profiling individual components with:
2720 use MasonX::Profiler; # available on CPAN
2721 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
2725 Set(@MasonParameters, ());
2727 =item C<$StatementLog>
2729 RT has rudimentary SQL statement logging support; simply set
2730 C<$StatementLog> to be the level that you wish SQL statements to be
2733 Enabling this option will also expose the SQL Queries page in the
2734 Configuration -> Tools menu for SuperUsers.
2738 Set($StatementLog, undef);
2745 =head1 Deprecated options
2749 =item C<$LinkTransactionsRun1Scrip>
2751 RT-3.4 backward compatibility setting. Add/Delete Link used to record
2752 one transaction and run one scrip. Set this value to 1 if you want
2753 only one of the link transactions to have scrips run.
2757 Set($LinkTransactionsRun1Scrip, 0);
2759 =item C<$ResolveDefaultUpdateType>
2761 This option has been deprecated. You can configure this site-wide
2762 with L</Lifecycles> (see L</Labeling and defining actions>).