16 NEVER EDIT RT_Config.pm.
18 Instead, copy any sections you want to change to F<RT_SiteConfig.pm> and edit them there.
22 =head1 Base Configuration
28 C<$rtname> is the string that RT will look for in mail messages to
29 figure out what ticket a new piece of mail belongs to.
31 Your domain name is recommended, so as not to pollute the namespace.
32 once you start using a given tag, you should probably never change it.
33 (otherwise, mail for existing tickets won't get put in the right place)
37 Set($rtname , "example.com");
40 =item C<$EmailSubjectTagRegex>
42 This regexp controls what subject tags RT recognizes as its own.
43 If you're not dealing with historical C<$rtname> values, you'll likely
44 never have to enable this feature.
46 Be VERY CAREFUL with it. Note that it overrides C<$rtname> for subject
47 token matching and that you should use only "non-capturing" parenthesis
48 grouping. For example:
50 C<Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );>
54 C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
56 This setting would make RT behave exactly as it does without the
61 #Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
65 =item C<$Organization>
67 You should set this to your organization's DNS domain. For example,
68 I<fsck.com> or I<asylum.arkham.ma.us>. It's used by the linking interface to
69 guarantee that ticket URIs are unique and easy to construct.
73 Set($Organization , "example.com");
75 =item C<$MinimumPasswordLength>
77 C<$MinimumPasswordLength> defines the minimum length for user
78 passwords. Setting it to 0 disables this check.
82 Set($MinimumPasswordLength , "5");
86 C<$Timezone> is used to convert times entered by users into GMT and back again
87 It should be set to a timezone recognized by your local unix box.
91 Set($Timezone , 'US/Eastern');
95 =head1 Database Configuration
99 =item C<$DatabaseType>
101 Database driver being used; case matters.
103 Valid types are "mysql", "Oracle" and "Pg"
107 Set($DatabaseType , 'Pg');
109 =item C<$DatabaseHost>, C<$DatabaseRTHost>
111 The domain name of your database server.
113 If you're running mysql and it's on localhost,
114 leave it blank for enhanced performance
118 Set($DatabaseHost , 'localhost');
119 Set($DatabaseRTHost , 'localhost');
121 =item C<$DatabasePort>
123 The port that your database server is running on. Ignored unless it's
124 a positive integer. It's usually safe to leave this blank
128 Set($DatabasePort , '');
130 =item C<$DatabaseUser>
132 The name of the database user (inside the database)
136 Set($DatabaseUser , 'freeside');
138 =item C<$DatabasePassword>
140 Password the C<$DatabaseUser> should use to access the database
144 Set($DatabasePassword , '');
146 =item C<$DatabaseName>
148 The name of the RT's database on your database server. For Oracle
149 it's SID, DB objects are created in L<$DatabaseUser>'s schema.
153 Set($DatabaseName , 'freeside');
155 =item C<$DatabaseRequireSSL>
157 If you're using Postgres and have compiled in SSL support,
158 set C<$DatabaseRequireSSL> to 1 to turn on SSL communication
162 Set($DatabaseRequireSSL , undef);
164 =item C<$UseSQLForACLChecks>
166 In RT for ages ACL are checked after search what in some situtations
167 result in empty search pages and wrong count of tickets.
169 Set C<$UseSQLForACLChecks> to 1 to use SQL and get rid of these problems.
171 However, this option is beta. In some cases it result in performance
172 improvements, but some setups can not handle it.
176 Set($UseSQLForACLChecks, undef);
178 =item C<$TicketsItemMapSize>
180 In RT at display page of a ticket and there is the current search,
181 then links for first, next, previous and last ticket are shown in
184 To build full map RT has to fetch full result set out of DB what can
185 eat lots of resourses. Using this option it's possible to limit number
188 Set C<$TicketsItemMapSize> to number of tickets you want RT to look
189 at to build the map. If full result set is bigger than that number
190 then there would be no 'last' link in the menu.
192 Set this to zero to return back to old behaviour.
196 Set($TicketsItemMapSize, 1000);
200 =head1 Incoming Mail Gateway Configuration
206 C<$OwnerEmail> is the address of a human who manages RT. RT will send
207 errors generated by the mail gateway to this address. This address
208 should _not_ be an address that's managed by your RT instance.
212 Set($OwnerEmail , 'root');
214 =item C<$LoopsToRTOwner>
216 If C<$LoopsToRTOwner> is defined, RT will send mail that it believes
217 might be a loop to C<$OwnerEmail>
221 Set($LoopsToRTOwner , 1);
225 If C<$StoreLoops> is defined, RT will record messages that it believes
226 to be part of mail loops.
228 As it does this, it will try to be careful not to send mail to the
229 sender of these messages
233 Set($StoreLoops , undef);
235 =item C<$MaxAttachmentSize>
237 C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments stored
240 For mysql and oracle, we set this size at 10 megabytes.
241 If you're running a postgres version earlier than 7.1, you will need
242 to drop this to 8192. (8k)
247 Set($MaxAttachmentSize , 10000000);
249 =item C<$TruncateLongAttachments>
251 C<$TruncateLongAttachments>: if this is set to a non-undef value,
252 RT will truncate attachments longer than C<$MaxAttachmentSize>.
256 Set($TruncateLongAttachments , undef);
258 =item C<$DropLongAttachments>
260 C<$DropLongAttachments>: if this is set to a non-undef value,
261 RT will silently drop attachments longer than C<MaxAttachmentSize>.
265 Set($DropLongAttachments , undef);
267 =item C<$ParseNewMessageForTicketCcs>
269 If C<$ParseNewMessageForTicketCcs> is true, RT will attempt to divine
270 Ticket 'Cc' watchers from the To and Cc lines of incoming messages
271 Be forewarned that if you have _any_ addresses which forward mail to
272 RT automatically and you enable this option without modifying
273 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
277 Set($ParseNewMessageForTicketCcs , undef);
279 =item C<$RTAddressRegexp>
281 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a ticket CC if
282 the setting above is enabled. It is important that you set this to a
283 regular expression that matches all addresses used by your RT. This lets RT
284 avoid sending mail to itself. It will also hide RT addresses from the list of
285 "One-time Cc" and Bcc lists on ticket reply.
289 Set($RTAddressRegexp , undef);
291 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
293 RT provides functionality which allows the system to rewrite
294 incoming email addresses. In its simplest form,
295 you can substitute the value in $<CanonicalizeEmailAddressReplace>
296 for the value in $<CanonicalizeEmailAddressMatch>
297 (These values are passed to the $<CanonicalizeEmailAddress> subroutine in
300 By default, that routine performs a C<s/$Match/$Replace/gi> on any address
305 #Set($CanonicalizeEmailAddressMatch , '@subdomain\.example\.com$');
306 #Set($CanonicalizeEmailAddressReplace , '@example.com');
308 =item C<$CanonicalizeEmailAddressMatch>
310 Set this to true and the create new user page will use the values that you
311 enter in the form but use the function CanonicalizeUserInfo in
316 Set($CanonicalizeOnCreate, 0);
318 =item C<$SenderMustExistInExternalDatabase>
320 If C<$SenderMustExistInExternalDatabase> is true, RT will refuse to
321 create non-privileged accounts for unknown users if you are using
322 the C<$LookupSenderInExternalDatabase> option.
323 Instead, an error message will be mailed and RT will forward the
324 message to C<$RTOwner>.
326 If you are not using C<$LookupSenderInExternalDatabase>, this option
329 If you define an AutoRejectRequest template, RT will use this
330 template for the rejection message.
334 Set($SenderMustExistInExternalDatabase , undef);
336 =item C<$ValidateUserEmailAddresses>
338 If C<$ValidateUserEmailAddresses> is true, RT will refuse to create users with
339 an invalid email address (as specified in RFC 2822) or with an email address
340 made of multiple email adresses.
344 Set($ValidateUserEmailAddresses, undef);
346 =item C<@MailPlugins>
348 C<@MailPlugins> is a list of auth plugins for L<RT::Interface::Email>
349 to use; see L<rt-mailgate>
353 =item C<$UnsafeEmailCommands>
355 C<$UnsafeEmailCommands>, if set to true, enables 'take' and 'resolve'
356 as possible actions via the mail gateway. As its name implies, this
357 is very unsafe, as it allows email with a forged sender to possibly
358 resolve arbitrary tickets!
362 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
364 The default "extract remote tracking tags" scrip settings; these
365 detect when your RT is talking to another RT, and adjusts the
370 Set($ExtractSubjectTagMatch, qr/\[.+? #\d+\]/);
371 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
372 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
373 : qr/\[\Q$RT::rtname\E #\d+\]/));
377 =head1 Outgoing Mail Configuration
381 =item C<$MailCommand>
383 C<$MailCommand> defines which method RT will use to try to send mail.
384 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
385 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
388 Note that you should remove the '-t' from C<$SendmailArguments>
389 if you use 'sendmail' rather than 'sendmailpipe'
393 Set($MailCommand , 'sendmailpipe');
395 =item C<$SetOutgoingMailFrom>
397 C<$SetOutgoingMailFrom> tells RT to set the sender envelope with the correspond
398 mail address of the ticket's queue.
400 Warning: If you use this setting, bounced mails will appear to be incoming
401 mail to the system, thus creating new tickets.
405 Set($SetOutgoingMailFrom, 0);
407 =item C<$OverrideOutgoingMailFrom>
409 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
410 address of the queue. The option is a hash reference of queue name to
413 If there is no ticket involved, then the value of the C<Default> key will be
418 Set($OverrideOutgoingMailFrom, {
419 # 'Default' => 'admin@rt.example.com',
420 # 'General' => 'general@rt.example.com',
425 =item C<$DefaultMailPrecedence>
427 C<$DefaultMailPrecedence> is used to control the default
428 Precedence level of outgoing mail where none is specified.
429 By default it is C<bulk>, but if you only send mail to
430 your staff, you may wish to change it.
432 Note that you can set the precedence of individual templates
433 by including an explicit Precedence header.
435 If you set this value to C<undef> then we do not set a default
436 Precedence header to outgoing mail. However, if there already is a
437 Precedence header it will be preserved.
441 Set($DefaultMailPrecedence, 'bulk');
445 =item C<$DefaultErrorMailPrecedence>
447 C<$DefaultErrorMailPrecedence> is used to control the default
448 Precedence level of outgoing mail that indicates some kind of
449 error condition. By default it is C<bulk>, but if you only send
450 mail to your staff, you may wish to change it.
452 If you set this value to C<undef> then we do not add a Precedence
453 header to error mail.
457 Set($DefaultErrorMailPrecedence, 'bulk');
461 =item C<$UseOriginatorHeader>
463 C<$UseOriginatorHeader> is used to control the insertion of an
464 RT-Originator Header in every outgoing mail, containing the
465 mail address of the transaction creator.
469 Set($UseOriginatorHeader, 1);
473 =head1 Sendmail Configuration
475 These options only take effect if C<$MailCommand> is 'sendmail' or
480 =item C<$SendmailArguments>
482 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
483 If you picked 'sendmailpipe', you MUST add a -t flag to C<$SendmailArguments>
484 These options are good for most sendmail wrappers and workalikes
486 These arguments are good for sendmail brand sendmail 8 and newer
487 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
491 Set($SendmailArguments , "-oi -t");
494 =item C<$SendmailBounceArguments>
496 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
497 assuming RT needs to send an error (ie. bounce).
501 Set($SendmailBounceArguments , '-f "<>"');
503 =item C<$SendmailPath>
505 If you selected 'sendmailpipe' above, you MUST specify the path to
506 your sendmail binary in C<$SendmailPath>.
510 Set($SendmailPath , "/usr/sbin/sendmail");
515 =head1 SMTP Configuration
517 These options only take effect if C<$MailCommand> is 'smtp'
523 C<$SMTPServer> should be set to the hostname of the SMTP server to use
527 Set($SMTPServer, undef);
531 C<$SMTPFrom> should be set to the 'From' address to use, if not the
536 Set($SMTPFrom, undef);
540 C<$SMTPDebug> should be set to true to debug SMTP mail sending
548 =head1 Other Mailer Configuration
554 C<@MailParams> defines a list of options passed to $MailCommand if it
555 is not 'sendmailpipe', 'sendmail', or 'smtp'
559 Set(@MailParams, ());
561 =item C<$CorrespondAddress>, C<$CommentAddress>
563 RT is designed such that any mail which already has a ticket-id associated
564 with it will get to the right place automatically.
566 C<$CorrespondAddress> and C<$CommentAddress> are the default addresses
567 that will be listed in From: and Reply-To: headers of correspondence
568 and comment mail tracked by RT, unless overridden by a queue-specific
573 Set($CorrespondAddress , '');
575 Set($CommentAddress , '');
577 =item C<$DashboardAddress>
579 The email address from which RT will send dashboards. If none is set, then
580 C<$OwnerEmail> will be used.
584 Set($DashboardAddress, '');
586 =item C<$UseFriendlyFromLine>
588 By default, RT sets the outgoing mail's "From:" header to
589 "SenderName via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
593 Set($UseFriendlyFromLine, 1);
595 =item C<$FriendlyFromLineFormat>
597 C<sprintf()> format of the friendly 'From:' header; its arguments
598 are SenderName and SenderEmailAddress.
602 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
604 =item C<$UseFriendlyToLine>
606 RT can optionally set a "Friendly" 'To:' header when sending messages to
607 Ccs or AdminCcs (rather than having a blank 'To:' header.
609 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL
610 If you are using sendmail, rather than postfix, qmail, exim or some other MTA,
611 you _must_ disable this option.
615 Set($UseFriendlyToLine, 0);
617 =item C<$FriendlyToLineFormat>
619 C<sprintf()> format of the friendly 'From:' header; its arguments
620 are WatcherType and TicketId.
624 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
626 =item C<$NotifyActor>
628 By default, RT doesn't notify the person who performs an update, as they
629 already know what they've done. If you'd like to change this behaviour,
630 Set C<$NotifyActor> to 1
634 Set($NotifyActor, 0);
636 =item C<$RecordOutgoingEmail>
638 By default, RT records each message it sends out to its own internal database.
639 To change this behavior, set C<$RecordOutgoingEmail> to 0
643 Set($RecordOutgoingEmail, 1);
645 =item C<$VERPPrefix>, C<$VERPPrefix>
647 VERP support (http://cr.yp.to/proto/verp.txt)
649 uncomment the following two directives to generate envelope senders
650 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
651 (i.e. rt-jesse=fsck.com@rt.example.com ).
653 This currently only works with sendmail and sendmailppie.
657 # Set($VERPPrefix, 'rt-');
658 # Set($VERPDomain, $RT::Organization);
661 =item C<$ForwardFromUser>
663 By default, RT forwards a message using queue's address and adds RT's tag into
664 subject of the outgoing message, so recipients' replies go into RT as correspondents.
666 To change this behavior, set C<$ForwardFromUser> to true value and RT will use
667 address of the current user and leave subject without RT's tag.
671 Set($ForwardFromUser, 0);
673 =item C<$ShowBccHeader>
675 By default RT hides from the web UI information about blind copies user sent on
678 To change this set the following option to true value.
682 Set($ShowBccHeader, 0);
684 =item C<$DashboardSubject>
686 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
687 Weekly, Monthly) of the dashboard and the dashboard's name. [_1] for the name
692 Set($DashboardSubject, '%s Dashboard: %s');
696 =head1 GnuPG Configuration
698 A full description of the (somewhat extensive) GnuPG integration can be found
699 by running the command `perldoc L<RT::Crypt::GnuPG>` (or `perldoc
700 lib/RT/Crypt/GnuPG.pm` from your RT install directory).
706 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
707 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
709 If you want to allow people to encrypt attachments inside the DB then
710 set C<AllowEncryptDataInDB> to true
712 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
713 emails encrypted for key RT doesn't have and can not decrypt.
715 Set C<RejectOnBadData> to false if you don't want to reject letters
716 with incorrect GnuPG data.
722 OutgoingMessagesFormat => 'RFC', # Inline
723 AllowEncryptDataInDB => 0,
725 RejectOnMissingPrivateKey => 1,
726 RejectOnBadData => 1,
729 =item C<%GnuPGOptions>
731 Options of GnuPG program.
733 If you override this in your RT_SiteConfig, you should be sure
734 to include a homedir setting.
736 NOTE that options with '-' character MUST be quoted.
741 homedir => '/opt/rt3/var/data/gpg',
744 # keyserver => 'hkp://subkeys.pgp.net',
746 # enables the automatic retrieving of keys when encrypting
747 # 'auto-key-locate' => 'keyserver',
749 # enables the automatic retrieving of keys when verifying signatures
750 # 'auto-key-retrieve' => undef,
756 =head1 Logging Configuration
758 The default is to log anything except debugging
759 information to syslog. Check the L<Log::Dispatch> POD for
760 information about how to get things by syslog, mail or anything
761 else, get debugging info in the log, etc.
763 It might generally make sense to send error and higher by email to
764 some administrator. If you do this, be careful that this email
765 isn't sent to this RT instance. Mail loops will generate a critical
770 =item C<$LogToSyslog>, C<$LogToScreen>
772 The minimum level error that will be logged to the specific device.
773 From lowest to highest priority, the levels are:
774 debug info notice warning error critical alert emergency
778 Set($LogToSyslog , 'info');
779 Set($LogToScreen , 'info');
781 =item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
783 Logging to a standalone file is also possible, but note that the
784 file should needs to both exist and be writable by all direct users
785 of the RT API. This generally include the web server, whoever
786 rt-crontool runs as. Note that as rt-mailgate and the RT CLI go
787 through the webserver, so their users do not need to have write
788 permissions to this file. If you expect to have multiple users of
789 the direct API, Best Practical recommends using syslog instead of
794 Set($LogToFile , undef);
795 Set($LogDir, '/opt/rt3/var/log');
796 Set($LogToFileNamed , "rt.log"); #log to rt.log
798 =item C<$LogStackTraces>
800 If set to a log level then logging will include stack traces for
801 messages with level equal to or greater than specified.
803 NOTICE: Stack traces include parameters supplied to functions or
804 methods. It is possible for stack trace logging to reveal sensitive
805 information such as passwords or ticket content in your logs.
809 Set($LogStackTraces, '');
811 =item C<@LogToSyslogConf>
813 On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
814 override any other options RT passes to L<Log::Dispatch::Syslog>.
815 Other interesting flags include facility and logopt. (See the
816 L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
817 ident too, if you have multiple RT installations.)
821 Set(@LogToSyslogConf, ());
823 =item C<$StatementLog>,
825 RT has rudimentary SQL statement logging support if you have
826 DBIx-SearchBuilder 1.31_1 or higher; simply set C<$StatementLog> to be
827 the level that you wish SQL statements to be logged at.
831 Set($StatementLog, undef);
835 =head1 Web Interface Configuration
839 =item C<$WebDefaultStylesheet>
841 This determines the default stylesheet the RT web interface will use.
842 RT ships with several themes by default:
844 web2 The totally new, default layout for RT 3.8
845 3.5-default RT 3.5 and 3.6 original layout
846 3.4-compat A 3.4 compatibility stylesheet to make RT look
849 This bundled distibution of RT also includes (enabled by default):
850 freeside2.1 Integration with Freeside
852 This value actually specifies a directory in F<share/html/NoAuth/css/>
853 from which RT will try to load the file main.css (which should
854 @import any other files the stylesheet needs). This allows you to
855 easily and cleanly create your own stylesheets to apply to RT. This
856 option can be overridden by users in their preferences.
860 Set($WebDefaultStylesheet, 'freeside2.1');
862 =item C<$UsernameFormat>
864 This determines how user info is displayed. 'concise' will show one of
865 either NickName, RealName, Name or EmailAddress, depending on what exists
866 and whether the user is privileged or not. 'verbose' will show RealName and
871 Set($UsernameFormat, 'verbose');
875 Domain name of the RT server, eg 'www.example.com'. It should not contain
876 anything else, but server name.
880 Set( $WebDomain, 'localhost' );
884 If we're running as a superuser, run on port 80
885 Otherwise, pick a high port for this user.
887 443 is default port for https protocol.
891 Set($WebPort, 80);# + ($< * 7274) % 32766 + ($< && 1024));
895 If you're putting the web ui somewhere other than at the root of
896 your server, you should set C<$WebPath> to the path you'll be
899 C<$WebPath> requires a leading / but no trailing /, or it can be blank.
901 In most cases, you should leave C<$WebPath> set to '' (an empty value).
907 =item C<$WebBaseURL>, C<$WebURL>
909 Usually you don't want to set these options. The only obviouse reason is
910 RT accessible via https protocol on non standard port, eg
911 'https://rt.example.com:9999'. In all other cases these options are computed
912 using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
914 C<$WebBaseURL> is the scheme, server and port (eg 'http://rt.example.com')
915 for constructing urls to the web UI. C<$WebBaseURL> doesn't need a trailing /.
917 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for example:
918 'http://www.example.com/rt/'.
922 my $port = RT->Config->Get('WebPort');
924 ($port == 443? 'https': 'http') .'://'
925 . RT->Config->Get('WebDomain')
926 . ($port != 80 && $port != 443? ":$port" : '')
929 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
931 =item C<$WebImagesURL>
933 C<$WebImagesURL> points to the base URL where RT can find its images.
934 Define the directory name to be used for images in rt web
939 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
943 C<$LogoURL> points to the URL of the RT logo displayed in the web UI
947 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bplogo.gif");
949 =item C<$LogoLinkURL>
951 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
955 Set($LogoLinkURL, "http://bestpractical.com");
957 =item C<$LogoAltText>
959 C<$LogoAltText> is a string of text for the alt-text of the logo. It
960 will be passed through C<loc> for localization.
964 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
966 =item C<$LogoImageHeight>
968 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
973 Set($LogoImageHeight, 33);
975 =item C<$LogoImageWidth>
977 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
982 Set($LogoImageWidth, 177);
984 =item C<$WebNoAuthRegex>
986 What portion of RT's URL space should not require authentication.
988 This is mostly for extension and doesn't mean RT will work without
989 login if you change it.
993 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
995 =item C<$SelfServiceRegex>
997 What portion of RT's URLspace should be accessible to Unprivileged users
998 This does not override the redirect from F</Ticket/Display.html> to
999 F</SelfService/Display.html> when Unprivileged users attempt to access
1004 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1006 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1008 For message boxes, set the entry box width, height and what type of
1009 wrapping to use. These options can be overridden by users in their
1012 Default width: 72, height: 15
1014 These settings only apply to the non-RichText message box.
1015 See below for Rich Text settings.
1019 Set($MessageBoxWidth, 72);
1020 Set($MessageBoxHeight, 15);
1022 =item C<$MessageBoxWrap>
1024 Default wrapping: "HARD" (choices "SOFT", "HARD")
1026 Wrapping is disabled when using MessageBoxRichText because
1027 of a bad interaction between IE and wrapping with the Rich
1032 Set($MessageBoxWrap, "HARD");
1034 =item C<$MessageBoxRichText>
1036 Should "rich text" editing be enabled? This option lets your users send html email messages from the web interface.
1040 Set($MessageBoxRichText, 1);
1042 =item C<$MessageBoxRichTextHeight>
1044 Height of RichText javascript enabled editing boxes (in pixels)
1048 Set($MessageBoxRichTextHeight, 200);
1050 =item C<$MessageBoxIncludeSignature>
1052 Should your user's signatures (from their Preferences page) be included in Comments and Replies
1056 Set($MessageBoxIncludeSignature, 1);
1058 =item C<$MessageBoxIncludeSignatureOnComment>
1060 Should your user's signatures (from their Preferences page) be included in Comments. Setting this to false overrides C<$MessageBoxIncludeSignature>.
1064 Set($MessageBoxIncludeSignatureOnComment, 1);
1066 =item C<$WikiImplicitLinks>
1068 Support implicit links in WikiText custom fields? A true value
1069 causes InterCapped or ALLCAPS words in WikiText fields to
1070 automatically become links to searches for those words. If used on
1071 RTFM articles, it links to the RTFM article with that name.
1075 Set($WikiImplicitLinks, 0);
1077 =item C<$TrustHTMLAttachments>
1079 if C<TrustHTMLAttachments> is not defined, we will display them
1080 as text. This prevents malicious HTML and javascript from being
1081 sent in a request (although there is probably more to it than that)
1085 Set($TrustHTMLAttachments, undef);
1087 =item C<$AlwaysDownloadAttachments>
1089 Always download attachments, regardless of content type. If set,
1090 this overrides C<TrustHTMLAttachments>.
1094 Set($AlwaysDownloadAttachments, undef);
1096 =item C<$AttachmentUnits>
1098 Controls the units (kilobytes or bytes) that attachment sizes use
1099 for display. The default is to display kilobytes if the attachment
1100 is larger than 1024 bytes, bytes otherwise. If you set
1101 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1102 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1106 Set($AttachmentUnits, undef);
1108 =item C<$RedistributeAutoGeneratedMessages>
1110 Should RT redistribute correspondence that it identifies as
1111 machine generated? A true value will do so; setting this to '0'
1112 will cause no such messages to be redistributed.
1113 You can also use 'privileged' (the default), which will redistribute
1114 only to privileged users. This helps to protect against malformed
1115 bounces and loops caused by autocreated requestors with bogus addresses.
1119 Set($RedistributeAutoGeneratedMessages, 'privileged');
1121 =item C<$PreferRichText>
1123 If C<$PreferRichText> is set to a true value, RT will show HTML/Rich text
1124 messages in preference to their plaintext alternatives. RT "scrubs" the
1125 html to show only a minimal subset of HTML to avoid possible contamination
1126 by cross-site-scripting attacks.
1130 Set($PreferRichText, undef);
1132 =item C<$WebExternalAuth>
1134 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1135 REMOTE_USER variable.
1139 Set($WebExternalAuth, undef);
1141 =item C<$WebExternalAuthContinuous>
1143 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1144 REMOTE_USER on each access. If you would prefer this to only happen
1145 once (at initial login) set this to a false value. The default setting
1146 will help ensure that if your external auth system deauthenticates a
1147 user, RT notices as soon as possible.
1151 Set($WebExternalAuthContinuous, 1);
1153 =item C<$WebFallbackToInternalAuth>
1155 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a chance
1156 of fallback to the login screen, even if REMOTE_USER failed.
1160 Set($WebFallbackToInternalAuth , undef);
1162 =item C<$WebExternalGecos>
1164 C<$WebExternalGecos> means to match 'gecos' field as the user identity);
1165 useful with mod_auth_pwcheck and IIS Integrated Windows logon.
1169 Set($WebExternalGecos , undef);
1171 =item C<$WebExternalAuto>
1173 C<$WebExternalAuto> will create users under the same name as REMOTE_USER
1174 upon login, if it's missing in the Users table.
1178 Set($WebExternalAuto , undef);
1180 =item C<$AutoCreate>
1182 If C<$WebExternalAuto> is true, C<$AutoCreate> will be passed to User's
1183 Create method. Use it to set defaults, such as creating
1184 Unprivileged users with C<{ Privileged => 0 }>
1185 ( Must be a hashref of arguments )
1189 Set($AutoCreate, undef);
1191 =item C<$WebSessionClass>
1193 C<$WebSessionClass> is the class you wish to use for managing Sessions.
1194 It defaults to use your SQL database, but if you are using MySQL 3.x and
1195 plans to use non-ascii Queue names, uncomment and add this line to
1196 F<RT_SiteConfig.pm> will prevent session corruption.
1200 # Set($WebSessionClass , 'Apache::Session::File');
1202 =item C<$AutoLogoff>
1204 By default, RT's user sessions persist until a user closes his or her
1205 browser. With the C<$AutoLogoff> option you can setup session lifetime in
1206 minutes. A user will be logged out if he or she doesn't send any requests
1207 to RT for the defined time.
1211 Set($AutoLogoff, 0);
1213 =item C<$LogoutRefresh>
1215 The number of seconds to wait after logout before sending the user to the
1216 login page. By default, 1 second, though you may want to increase this if
1217 you display additional information on the logout page.
1221 Set($LogoutRefresh, 1);
1223 =item C<$WebSecureCookies>
1225 By default, RT's session cookie isn't marked as "secure" Some web browsers
1226 will treat secure cookies more carefully than non-secure ones, being careful
1227 not to write them to disk, only send them over an SSL secured connection
1228 and so on. To enable this behaviour, set C<$WebSecureCookies> to a true value.
1229 NOTE: You probably don't want to turn this on _unless_ users are only connecting
1230 via SSL encrypted HTTP connections.
1234 Set($WebSecureCookies, 0);
1236 =item C<$WebFlushDbCacheEveryRequest>
1238 By default, RT clears its database cache after every page view.
1239 This ensures that you've always got the most current information
1240 when working in a multi-process (mod_perl or FastCGI) Environment
1241 Setting C<$WebFlushDbCacheEveryRequest> to '0' will turn this off,
1242 which will speed RT up a bit, at the expense of a tiny bit of data
1247 Set($WebFlushDbCacheEveryRequest, '1');
1250 =item C<$MaxInlineBody>
1252 C<$MaxInlineBody> is the maximum attachment size that we want to see
1253 inline when viewing a transaction. RT will inline any text if value
1254 is undefined or 0. This option can be overridden by users in their
1259 Set($MaxInlineBody, 12000);
1261 =item C<$DefaultSummaryRows>
1263 C<$DefaultSummaryRows> is default number of rows displayed in for search
1264 results on the frontpage.
1268 Set($DefaultSummaryRows, 10);
1270 =item C<$HomePageRefreshInterval>
1272 C<$HomePageRefreshInterval> is default number of seconds to refresh the RT
1273 home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1277 Set($HomePageRefreshInterval, 0);
1279 =item C<$SearchResultsRefreshInterval>
1281 C<$SearchResultsRefreshInterval> is default number of seconds to refresh
1282 search results in RT. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1286 Set($SearchResultsRefreshInterval, 0);
1288 =item C<$OldestTransactionsFirst>
1290 By default, RT shows newest transactions at the bottom of the ticket
1291 history page, if you want see them at the top set this to '0'. This
1292 option can be overridden by users in their preferences.
1296 Set($OldestTransactionsFirst, '1');
1298 =item C<$ShowTransactionImages>
1300 By default, RT shows images attached to incoming (and outgoing) ticket updates
1301 inline. Set this variable to 0 if you'd like to disable that behaviour
1305 Set($ShowTransactionImages, 1);
1307 =item C<$PlainTextPre>
1309 Normally plaintext attachments are displayed as HTML with line
1310 breaks preserved. This causes space- and tab-based formatting not
1311 to be displayed correctly. By setting $PlainTextPre they'll be
1312 displayed using <pre> instead so such formatting works, but they'll
1313 use a monospaced font, no matter what the value of C<$PlainTextMono> is.
1317 Set($PlainTextPre, 0);
1320 =item C<$PlainTextMono>
1321 To display plaintext attachments,
1322 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1323 formatting, but unlike PlainTextPre, the text will wrap to fit into the
1328 Set($PlainTextMono, 0);
1330 =item C<$ShowUnreadMessageNotifications>
1332 By default, RT will prompt users when there are new, unread messages on
1333 tickets they are viewing.
1335 Set C<$ShowUnreadMessageNotifications> to a false value to disable this feature.
1339 Set($ShowUnreadMessageNotifications, 1);
1342 =item C<$HomepageComponents>
1344 C<$HomepageComponents> is an arrayref of allowed components on a user's
1345 customized homepage ("RT at a glance").
1349 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyCalendar MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]);
1351 =item C<@MasonParameters>
1353 C<@MasonParameters> is the list of parameters for the constructor of
1354 HTML::Mason's Apache or CGI Handler. This is normally only useful
1355 for debugging, eg. profiling individual components with:
1357 use MasonX::Profiler; # available on CPAN
1358 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
1362 Set(@MasonParameters, ());
1364 =item C<$DefaultSearchResultFormat>
1366 C<$DefaultSearchResultFormat> is the default format for RT search results
1370 Set ($DefaultSearchResultFormat, qq{
1371 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1372 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1379 '<small>__Requestors__</small>',
1380 '<small>__CreatedRelative__</small>',
1381 '<small>__ToldRelative__</small>',
1382 '<small>__LastUpdatedRelative__</small>',
1383 '<small>__TimeLeft__</small>'});
1385 =item C<$DefaultSelfServiceSearchResultFormat>
1387 C<$DefaultSelfServiceSearchResultFormat> is the default format of searches displayed in the
1388 SelfService interface.
1392 Set($DefaultSelfServiceSearchResultFormat, qq{
1393 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1394 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1399 =item C<%AdminSearchResultFormat>
1401 In admin interface format strings similar to tickets search result
1402 formats are used. Use C<%AdminSearchResultFormat> to define format
1403 strings per RT class.
1407 Set(%AdminSearchResultFormat,
1409 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1410 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1411 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__},
1414 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1415 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1416 .q{,'__Description__'},
1419 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1420 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1421 .q{,__RealName__, __EmailAddress__},
1424 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1425 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1426 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
1429 q{'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
1430 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
1431 .q{,__Stage__, __Condition__, __Action__, __Template__},
1434 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
1435 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
1436 .q{,'__Description__'},
1439 =item C<$SuppressInlineTextFiles>
1441 If C<$SuppressInlineTextFiles> is set to a true value, then uploaded
1442 text files (text-type attachments with file names) are prevented
1443 from being displayed in-line when viewing a ticket's history.
1447 Set($SuppressInlineTextFiles, undef);
1449 =item C<$DontSearchFileAttachments>
1451 If C<$DontSearchFileAttachments> is set to a true value, then uploaded
1452 files (attachments with file names) are not searched during full-content
1457 Set($DontSearchFileAttachments, undef);
1461 The L<GD> module (which RT uses for graphs) ships with a builtin font
1462 that doesn't have full Unicode support. You can use a given TrueType font
1463 for a specific language by setting %ChartFont to (language =E<gt> the
1464 absolute path of a font) pairs. Your GD library must have support for
1465 TrueType fonts to use this option. If there is no entry for a language
1466 in the hash then font with 'others' key is used.
1468 RT comes with two TrueType fonts covering most available languages.
1474 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1475 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1476 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1477 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1480 =item C<$ChartsTimezonesInDB>
1482 Dates are stored using UTC timezone in the DB, so charts groupped
1483 by dates and time are not representative. Set C<$ChartsTimezonesInDB>
1484 to a true value to enable timezones conversions using DB's
1485 capabilities. You may need to do some work on DB side to use this
1486 feature, read more in F<docs/timezones_in_charts.pod>.
1490 Set( $ChartsTimezonesInDB, 0 );
1492 =item C<@Active_MakeClicky>
1494 MakeClicky detects various formats of data in headers and email
1495 messages, and extends them with supporting links. By default, RT
1496 provides two formats:
1498 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1501 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1502 replace URL with link and *adds spaces* into text if it's longer
1503 then 30 chars. This allow browser to wrap long URLs and avoid
1504 horizontal scrolling.
1506 See F<share/html/Elements/MakeClicky> for documentation on how to add your own.
1510 Set(@Active_MakeClicky, qw());
1512 =item C<$DefaultQueue>
1514 Use this to select the default queue name that will be used for creating new
1515 tickets. You may use either the queue's name or its ID. This only affects the
1516 queue selection boxes on the web interface.
1520 #Set($DefaultQueue, 'General');
1522 =item C<$DefaultTimeUnitsToHours>
1524 Use this to set the default units for time entry to hours instead of minutes.
1528 Set($DefaultTimeUnitsToHours, 0);
1532 =head1 L<Net::Server> (rt-server) Configuration
1536 =item C<$StandaloneMinServers>, C<$StandaloneMaxServers>
1538 The absolute minimum and maximum number of servers that will be created to
1539 handle requests. Having multiple servers means that serving a slow page will
1540 affect other users less.
1544 Set($StandaloneMinServers, 1);
1545 Set($StandaloneMaxServers, 1);
1547 =item C<$StandaloneMinSpareServers>, C<$StandaloneMaxSpareServers>
1549 These next two options can be used to scale up and down the number of servers
1550 to adjust to load. These two options will respect the C<$StandaloneMinServers
1551 > and C<$StandaloneMaxServers options>.
1555 Set($StandaloneMinSpareServers, 0);
1556 Set($StandaloneMaxSpareServers, 0);
1558 =item C<$StandaloneMaxRequests>
1560 This sets the absolute maximum number of requests a single server will serve.
1561 Setting this would be useful if, for example, memory usage slowly crawls up
1566 #Set($StandaloneMaxRequests, 50);
1568 =item C<%NetServerOptions>
1570 C<%NetServerOptions> is a hash of additional options to use for
1571 L<Net::Server/DEFAULT ARGUMENTS>. For example, you could set
1572 reverse_lookups to get the hostnames for all users with:
1574 C<Set(%NetServerOptions, (reverse_lookups => 1));>
1578 Set(%NetServerOptions, ());
1583 =head1 UTF-8 Configuration
1587 =item C<@LexiconLanguages>
1589 An array that contains languages supported by RT's internationalization
1590 interface. Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
1591 RT bilingual instead of multilingual, but will save some memory.
1595 Set(@LexiconLanguages, qw(*));
1597 =item C<@EmailInputEncodings>
1599 An array that contains default encodings used to guess which charset
1600 an attachment uses if not specified. Must be recognized by
1605 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1607 =item C<$EmailOutputEncoding>
1609 The charset for localized email. Must be recognized by Encode.
1613 Set($EmailOutputEncoding, 'utf-8');
1618 =head1 Date Handling Configuration
1622 =item C<$DateTimeFormat>
1624 You can choose date and time format. See "Output formatters"
1625 section in perldoc F<lib/RT/Date.pm> for more options. This option can
1626 be overridden by users in their preferences.
1629 C<Set($DateTimeFormat, 'LocalizedDateTime');>
1630 C<Set($DateTimeFormat, { Format => 'ISO', Seconds => 0 });>
1631 C<Set($DateTimeFormat, 'RFC2822');>
1632 C<Set($DateTimeFormat, { Format => 'RFC2822', Seconds => 0, DayOfWeek => 0 });>
1636 Set($DateTimeFormat, 'DefaultFormat');
1638 # Next two options are for Time::ParseDate
1640 =item C<$DateDayBeforeMonth>
1642 Set this to 1 if your local date convention looks like "dd/mm/yy" instead of
1643 "mm/dd/yy". Used only for parsing, not for displaying dates.
1647 Set($DateDayBeforeMonth , 1);
1649 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
1651 Should an unspecified day or year in a date refer to a future or a
1652 past value? For example, should a date of "Tuesday" default to mean
1653 the date for next Tuesday or last Tuesday? Should the date "March 1"
1654 default to the date for next March or last March?
1656 Set $<AmbiguousDayInPast> for the last date, or $<$AmbiguousDayInFuture> for the
1659 The default is usually good.
1663 Set($AmbiguousDayInPast, 0);
1664 Set($AmbiguousDayInFuture, 0);
1668 =head1 Approval Configuration
1670 Configration for the approvl system
1674 =item C<$ApprovalRejectionNotes>
1676 Should rejection notes be sent to the requestors? The default is true.
1680 Set($ApprovalRejectionNotes, 1);
1685 =head1 Miscellaneous Configuration
1689 =item C<@ActiveStatus>, C<@InactiveStatus>
1691 You can define new statuses and even reorder existing statuses here.
1692 WARNING. DO NOT DELETE ANY OF THE DEFAULT STATUSES. If you do, RT
1693 will break horribly. The statuses you add must be no longer than
1698 Set(@ActiveStatus, qw(new open stalled));
1699 Set(@InactiveStatus, qw(resolved rejected deleted));
1701 =item C<$LinkTransactionsRun1Scrip>
1703 RT-3.4 backward compatibility setting. Add/Delete Link used to record one
1704 transaction and run one scrip. Set this value to 1 if you want
1705 only one of the link transactions to have scrips run.
1709 Set($LinkTransactionsRun1Scrip, 0);
1711 =item C<$StrictLinkACL>
1713 When this feature is enabled a user needs I<ModifyTicket> rights on both
1714 tickets to link them together, otherwise he can have rights on either of
1719 Set($StrictLinkACL, 1);
1721 =item C<$PreviewScripMessages>
1723 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1724 reply page should include the content of the messages to be sent.
1728 Set($PreviewScripMessages, 0);
1730 =item C<$UseTransactionBatch>
1732 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1733 such that a resolve and comment (for example) would happen
1734 simultaneously, instead of as two transactions, unaware of each
1739 Set($UseTransactionBatch, 1);
1741 =item C<@CustomFieldValuesSources>
1743 Set C<@CustomFieldValuesSources> to a list of class names which extend
1744 L<RT::CustomFieldValues::External>. This can be used to pull lists of
1745 custom field values from external sources at runtime.
1749 Set(@CustomFieldValuesSources, ());
1751 =item C<$CanonicalizeRedirectURLs>
1753 Set C<$CanonicalizeRedirectURLs> to 1 to use $C<WebURL> when redirecting rather
1754 than the one we get from C<%ENV>.
1756 If you use RT behind a reverse proxy, you almost certainly want to
1761 Set($CanonicalizeRedirectURLs, 0);
1762 =item C<$EnableReminders>
1764 Hide links/portlets related to Reminders by setting this to 0
1768 Set($EnableReminders,1);
1773 Set C<@Plugins> to a list of external RT plugins that should be enabled (those
1774 plugins have to be previously downloaded and installed).
1777 C<Set(@Plugins, (qw(Extension::QuickDelete RT::FM)));>
1781 Set(@Plugins, (qw(RTx::Calendar)));
1785 =head1 Development Configuration
1791 RT comes with a "Development mode" setting.
1792 This setting, as a convenience for developers, turns on
1793 all sorts of development options that you most likely don't want in
1796 * Turns off Mason's 'static_source' directive. By default, you can't
1797 edit RT's web ui components on the fly and have RT magically pick up
1798 your changes. (It's a big performance hit)
1804 Set($DevelMode, '0');
1809 =head1 Deprecated Options
1813 =item C<$AlwaysUseBase64>
1815 Encode blobs as base64 in DB (?)
1817 =item C<$TicketBaseURI>
1819 Base URI to tickets in this system; used when loading (?)
1821 =item C<$UseCodeTickets>
1823 This option is exists for backwards compatibility. Don't use it.