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 , 'mysql');
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 , 'rt_user');
138 =item C<$DatabasePassword>
140 Password the C<$DatabaseUser> should use to access the database
144 Set($DatabasePassword , 'rt_pass');
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 , 'rt3');
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 => '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, '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 value actually specifies a directory in F<share/html/NoAuth/css/>
850 from which RT will try to load the file main.css (which should
851 @import any other files the stylesheet needs). This allows you to
852 easily and cleanly create your own stylesheets to apply to RT. This
853 option can be overridden by users in their preferences.
857 Set($WebDefaultStylesheet, 'web2');
859 =item C<$UsernameFormat>
861 This determines how user info is displayed. 'concise' will show one of
862 either NickName, RealName, Name or EmailAddress, depending on what exists
863 and whether the user is privileged or not. 'verbose' will show RealName and
868 Set($UsernameFormat, 'concise');
872 Domain name of the RT server, eg 'www.example.com'. It should not contain
873 anything else, but server name.
877 Set( $WebDomain, 'localhost' );
881 If we're running as a superuser, run on port 80
882 Otherwise, pick a high port for this user.
884 443 is default port for https protocol.
888 Set($WebPort, 80);# + ($< * 7274) % 32766 + ($< && 1024));
892 If you're putting the web ui somewhere other than at the root of
893 your server, you should set C<$WebPath> to the path you'll be
896 C<$WebPath> requires a leading / but no trailing /, or it can be blank.
898 In most cases, you should leave C<$WebPath> set to '' (an empty value).
904 =item C<$WebBaseURL>, C<$WebURL>
906 Usually you don't want to set these options. The only obviouse reason is
907 RT accessible via https protocol on non standard port, eg
908 'https://rt.example.com:9999'. In all other cases these options are computed
909 using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
911 C<$WebBaseURL> is the scheme, server and port (eg 'http://rt.example.com')
912 for constructing urls to the web UI. C<$WebBaseURL> doesn't need a trailing /.
914 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for example:
915 'http://www.example.com/rt/'.
919 my $port = RT->Config->Get('WebPort');
921 ($port == 443? 'https': 'http') .'://'
922 . RT->Config->Get('WebDomain')
923 . ($port != 80 && $port != 443? ":$port" : '')
926 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
928 =item C<$WebImagesURL>
930 C<$WebImagesURL> points to the base URL where RT can find its images.
931 Define the directory name to be used for images in rt web
936 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
940 C<$LogoURL> points to the URL of the RT logo displayed in the web UI
944 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bplogo.gif");
946 =item C<$LogoLinkURL>
948 C<$LogoLinkURL> is the URL that the RT logo hyperlinks to.
952 Set($LogoLinkURL, "http://bestpractical.com");
954 =item C<$LogoAltText>
956 C<$LogoAltText> is a string of text for the alt-text of the logo. It
957 will be passed through C<loc> for localization.
961 Set($LogoAltText, "Best Practical Solutions, LLC corporate logo");
963 =item C<$LogoImageHeight>
965 C<$LogoImageHeight> is the value of the C<height> attribute of the logo
970 Set($LogoImageHeight, 33);
972 =item C<$LogoImageWidth>
974 C<$LogoImageWidth> is the value of the C<width> attribute of the logo
979 Set($LogoImageWidth, 177);
981 =item C<$WebNoAuthRegex>
983 What portion of RT's URL space should not require authentication.
985 This is mostly for extension and doesn't mean RT will work without
986 login if you change it.
990 Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
992 =item C<$SelfServiceRegex>
994 What portion of RT's URLspace should be accessible to Unprivileged users
995 This does not override the redirect from F</Ticket/Display.html> to
996 F</SelfService/Display.html> when Unprivileged users attempt to access
1001 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
1003 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
1005 For message boxes, set the entry box width, height and what type of
1006 wrapping to use. These options can be overridden by users in their
1009 Default width: 72, height: 15
1011 These settings only apply to the non-RichText message box.
1012 See below for Rich Text settings.
1016 Set($MessageBoxWidth, 72);
1017 Set($MessageBoxHeight, 15);
1019 =item C<$MessageBoxWrap>
1021 Default wrapping: "HARD" (choices "SOFT", "HARD")
1023 Wrapping is disabled when using MessageBoxRichText because
1024 of a bad interaction between IE and wrapping with the Rich
1029 Set($MessageBoxWrap, "HARD");
1031 =item C<$MessageBoxRichText>
1033 Should "rich text" editing be enabled? This option lets your users send html email messages from the web interface.
1037 Set($MessageBoxRichText, 1);
1039 =item C<$MessageBoxRichTextHeight>
1041 Height of RichText javascript enabled editing boxes (in pixels)
1045 Set($MessageBoxRichTextHeight, 200);
1047 =item C<$MessageBoxIncludeSignature>
1049 Should your user's signatures (from their Preferences page) be included in Comments and Replies
1053 Set($MessageBoxIncludeSignature, 1);
1055 =item C<$MessageBoxIncludeSignatureOnComment>
1057 Should your user's signatures (from their Preferences page) be included in Comments. Setting this to false overrides C<$MessageBoxIncludeSignature>.
1061 Set($MessageBoxIncludeSignatureOnComment, 1);
1063 =item C<$WikiImplicitLinks>
1065 Support implicit links in WikiText custom fields? A true value
1066 causes InterCapped or ALLCAPS words in WikiText fields to
1067 automatically become links to searches for those words. If used on
1068 RTFM articles, it links to the RTFM article with that name.
1072 Set($WikiImplicitLinks, 0);
1074 =item C<$TrustHTMLAttachments>
1076 if C<TrustHTMLAttachments> is not defined, we will display them
1077 as text. This prevents malicious HTML and javascript from being
1078 sent in a request (although there is probably more to it than that)
1082 Set($TrustHTMLAttachments, undef);
1084 =item C<$AlwaysDownloadAttachments>
1086 Always download attachments, regardless of content type. If set,
1087 this overrides C<TrustHTMLAttachments>.
1091 Set($AlwaysDownloadAttachments, undef);
1093 =item C<$AttachmentUnits>
1095 Controls the units (kilobytes or bytes) that attachment sizes use
1096 for display. The default is to display kilobytes if the attachment
1097 is larger than 1024 bytes, bytes otherwise. If you set
1098 C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
1099 displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
1103 Set($AttachmentUnits, undef);
1105 =item C<$RedistributeAutoGeneratedMessages>
1107 Should RT redistribute correspondence that it identifies as
1108 machine generated? A true value will do so; setting this to '0'
1109 will cause no such messages to be redistributed.
1110 You can also use 'privileged' (the default), which will redistribute
1111 only to privileged users. This helps to protect against malformed
1112 bounces and loops caused by autocreated requestors with bogus addresses.
1116 Set($RedistributeAutoGeneratedMessages, 'privileged');
1118 =item C<$PreferRichText>
1120 If C<$PreferRichText> is set to a true value, RT will show HTML/Rich text
1121 messages in preference to their plaintext alternatives. RT "scrubs" the
1122 html to show only a minimal subset of HTML to avoid possible contamination
1123 by cross-site-scripting attacks.
1127 Set($PreferRichText, undef);
1129 =item C<$WebExternalAuth>
1131 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1132 REMOTE_USER variable.
1136 Set($WebExternalAuth, undef);
1138 =item C<$WebExternalAuthContinuous>
1140 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1141 REMOTE_USER on each access. If you would prefer this to only happen
1142 once (at initial login) set this to a false value. The default setting
1143 will help ensure that if your external auth system deauthenticates a
1144 user, RT notices as soon as possible.
1148 Set($WebExternalAuthContinuous, 1);
1150 =item C<$WebFallbackToInternalAuth>
1152 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a chance
1153 of fallback to the login screen, even if REMOTE_USER failed.
1157 Set($WebFallbackToInternalAuth , undef);
1159 =item C<$WebExternalGecos>
1161 C<$WebExternalGecos> means to match 'gecos' field as the user identity);
1162 useful with mod_auth_pwcheck and IIS Integrated Windows logon.
1166 Set($WebExternalGecos , undef);
1168 =item C<$WebExternalAuto>
1170 C<$WebExternalAuto> will create users under the same name as REMOTE_USER
1171 upon login, if it's missing in the Users table.
1175 Set($WebExternalAuto , undef);
1177 =item C<$AutoCreate>
1179 If C<$WebExternalAuto> is true, C<$AutoCreate> will be passed to User's
1180 Create method. Use it to set defaults, such as creating
1181 Unprivileged users with C<{ Privileged => 0 }>
1182 ( Must be a hashref of arguments )
1186 Set($AutoCreate, undef);
1188 =item C<$WebSessionClass>
1190 C<$WebSessionClass> is the class you wish to use for managing Sessions.
1191 It defaults to use your SQL database, but if you are using MySQL 3.x and
1192 plans to use non-ascii Queue names, uncomment and add this line to
1193 F<RT_SiteConfig.pm> will prevent session corruption.
1197 # Set($WebSessionClass , 'Apache::Session::File');
1199 =item C<$AutoLogoff>
1201 By default, RT's user sessions persist until a user closes his or her
1202 browser. With the C<$AutoLogoff> option you can setup session lifetime in
1203 minutes. A user will be logged out if he or she doesn't send any requests
1204 to RT for the defined time.
1208 Set($AutoLogoff, 0);
1210 =item C<$LogoutRefresh>
1212 The number of seconds to wait after logout before sending the user to the
1213 login page. By default, 1 second, though you may want to increase this if
1214 you display additional information on the logout page.
1218 Set($LogoutRefresh, 1);
1220 =item C<$WebSecureCookies>
1222 By default, RT's session cookie isn't marked as "secure" Some web browsers
1223 will treat secure cookies more carefully than non-secure ones, being careful
1224 not to write them to disk, only send them over an SSL secured connection
1225 and so on. To enable this behaviour, set C<$WebSecureCookies> to a true value.
1226 NOTE: You probably don't want to turn this on _unless_ users are only connecting
1227 via SSL encrypted HTTP connections.
1231 Set($WebSecureCookies, 0);
1233 =item C<$WebFlushDbCacheEveryRequest>
1235 By default, RT clears its database cache after every page view.
1236 This ensures that you've always got the most current information
1237 when working in a multi-process (mod_perl or FastCGI) Environment
1238 Setting C<$WebFlushDbCacheEveryRequest> to '0' will turn this off,
1239 which will speed RT up a bit, at the expense of a tiny bit of data
1244 Set($WebFlushDbCacheEveryRequest, '1');
1247 =item C<$MaxInlineBody>
1249 C<$MaxInlineBody> is the maximum attachment size that we want to see
1250 inline when viewing a transaction. RT will inline any text if value
1251 is undefined or 0. This option can be overridden by users in their
1256 Set($MaxInlineBody, 12000);
1258 =item C<$DefaultSummaryRows>
1260 C<$DefaultSummaryRows> is default number of rows displayed in for search
1261 results on the frontpage.
1265 Set($DefaultSummaryRows, 10);
1267 =item C<$HomePageRefreshInterval>
1269 C<$HomePageRefreshInterval> is default number of seconds to refresh the RT
1270 home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1274 Set($HomePageRefreshInterval, 0);
1276 =item C<$SearchResultsRefreshInterval>
1278 C<$SearchResultsRefreshInterval> is default number of seconds to refresh
1279 search results in RT. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1283 Set($SearchResultsRefreshInterval, 0);
1285 =item C<$OldestTransactionsFirst>
1287 By default, RT shows newest transactions at the bottom of the ticket
1288 history page, if you want see them at the top set this to '0'. This
1289 option can be overridden by users in their preferences.
1293 Set($OldestTransactionsFirst, '1');
1295 =item C<$ShowTransactionImages>
1297 By default, RT shows images attached to incoming (and outgoing) ticket updates
1298 inline. Set this variable to 0 if you'd like to disable that behaviour
1302 Set($ShowTransactionImages, 1);
1304 =item C<$PlainTextPre>
1306 Normally plaintext attachments are displayed as HTML with line
1307 breaks preserved. This causes space- and tab-based formatting not
1308 to be displayed correctly. By setting $PlainTextPre they'll be
1309 displayed using <pre> instead so such formatting works, but they'll
1310 use a monospaced font, no matter what the value of C<$PlainTextMono> is.
1314 Set($PlainTextPre, 0);
1317 =item C<$PlainTextMono>
1318 To display plaintext attachments,
1319 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1320 formatting, but unlike PlainTextPre, the text will wrap to fit into the
1325 Set($PlainTextMono, 0);
1327 =item C<$ShowUnreadMessageNotifications>
1329 By default, RT will prompt users when there are new, unread messages on
1330 tickets they are viewing.
1332 Set C<$ShowUnreadMessageNotifications> to a false value to disable this feature.
1336 Set($ShowUnreadMessageNotifications, 1);
1339 =item C<$HomepageComponents>
1341 C<$HomepageComponents> is an arrayref of allowed components on a user's
1342 customized homepage ("RT at a glance").
1346 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]);
1348 =item C<@MasonParameters>
1350 C<@MasonParameters> is the list of parameters for the constructor of
1351 HTML::Mason's Apache or CGI Handler. This is normally only useful
1352 for debugging, eg. profiling individual components with:
1354 use MasonX::Profiler; # available on CPAN
1355 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
1359 Set(@MasonParameters, ());
1361 =item C<$DefaultSearchResultFormat>
1363 C<$DefaultSearchResultFormat> is the default format for RT search results
1367 Set ($DefaultSearchResultFormat, qq{
1368 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1369 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1376 '<small>__Requestors__</small>',
1377 '<small>__CreatedRelative__</small>',
1378 '<small>__ToldRelative__</small>',
1379 '<small>__LastUpdatedRelative__</small>',
1380 '<small>__TimeLeft__</small>'});
1382 =item C<$DefaultSelfServiceSearchResultFormat>
1384 C<$DefaultSelfServiceSearchResultFormat> is the default format of searches displayed in the
1385 SelfService interface.
1389 Set($DefaultSelfServiceSearchResultFormat, qq{
1390 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1391 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1396 =item C<%AdminSearchResultFormat>
1398 In admin interface format strings similar to tickets search result
1399 formats are used. Use C<%AdminSearchResultFormat> to define format
1400 strings per RT class.
1404 Set(%AdminSearchResultFormat,
1406 q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1407 .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1408 .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__},
1411 q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1412 .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1413 .q{,'__Description__'},
1416 q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1417 .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1418 .q{,__RealName__, __EmailAddress__},
1421 q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
1422 .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
1423 .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
1426 q{'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
1427 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
1428 .q{,__Stage__, __Condition__, __Action__, __Template__},
1431 q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
1432 .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
1433 .q{,'__Description__'},
1436 =item C<$SuppressInlineTextFiles>
1438 If C<$SuppressInlineTextFiles> is set to a true value, then uploaded
1439 text files (text-type attachments with file names) are prevented
1440 from being displayed in-line when viewing a ticket's history.
1444 Set($SuppressInlineTextFiles, undef);
1446 =item C<$DontSearchFileAttachments>
1448 If C<$DontSearchFileAttachments> is set to a true value, then uploaded
1449 files (attachments with file names) are not searched during full-content
1454 Set($DontSearchFileAttachments, undef);
1458 The L<GD> module (which RT uses for graphs) ships with a builtin font
1459 that doesn't have full Unicode support. You can use a given TrueType font
1460 for a specific language by setting %ChartFont to (language =E<gt> the
1461 absolute path of a font) pairs. Your GD library must have support for
1462 TrueType fonts to use this option. If there is no entry for a language
1463 in the hash then font with 'others' key is used.
1465 RT comes with two TrueType fonts covering most available languages.
1471 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1472 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1473 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
1474 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
1477 =item C<$ChartsTimezonesInDB>
1479 Dates are stored using UTC timezone in the DB, so charts groupped
1480 by dates and time are not representative. Set C<$ChartsTimezonesInDB>
1481 to a true value to enable timezones conversions using DB's
1482 capabilities. You may need to do some work on DB side to use this
1483 feature, read more in F<docs/timezones_in_charts.pod>.
1487 Set( $ChartsTimezonesInDB, 0 );
1489 =item C<@Active_MakeClicky>
1491 MakeClicky detects various formats of data in headers and email
1492 messages, and extends them with supporting links. By default, RT
1493 provides two formats:
1495 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1498 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1499 replace URL with link and *adds spaces* into text if it's longer
1500 then 30 chars. This allow browser to wrap long URLs and avoid
1501 horizontal scrolling.
1503 See F<share/html/Elements/MakeClicky> for documentation on how to add your own.
1507 Set(@Active_MakeClicky, qw());
1509 =item C<$DefaultQueue>
1511 Use this to select the default queue name that will be used for creating new
1512 tickets. You may use either the queue's name or its ID. This only affects the
1513 queue selection boxes on the web interface.
1517 #Set($DefaultQueue, 'General');
1519 =item C<$DefaultTimeUnitsToHours>
1521 Use this to set the default units for time entry to hours instead of minutes.
1525 Set($DefaultTimeUnitsToHours, 0);
1529 =head1 L<Net::Server> (rt-server) Configuration
1533 =item C<$StandaloneMinServers>, C<$StandaloneMaxServers>
1535 The absolute minimum and maximum number of servers that will be created to
1536 handle requests. Having multiple servers means that serving a slow page will
1537 affect other users less.
1541 Set($StandaloneMinServers, 1);
1542 Set($StandaloneMaxServers, 1);
1544 =item C<$StandaloneMinSpareServers>, C<$StandaloneMaxSpareServers>
1546 These next two options can be used to scale up and down the number of servers
1547 to adjust to load. These two options will respect the C<$StandaloneMinServers
1548 > and C<$StandaloneMaxServers options>.
1552 Set($StandaloneMinSpareServers, 0);
1553 Set($StandaloneMaxSpareServers, 0);
1555 =item C<$StandaloneMaxRequests>
1557 This sets the absolute maximum number of requests a single server will serve.
1558 Setting this would be useful if, for example, memory usage slowly crawls up
1563 #Set($StandaloneMaxRequests, 50);
1565 =item C<%NetServerOptions>
1567 C<%NetServerOptions> is a hash of additional options to use for
1568 L<Net::Server/DEFAULT ARGUMENTS>. For example, you could set
1569 reverse_lookups to get the hostnames for all users with:
1571 C<Set(%NetServerOptions, (reverse_lookups => 1));>
1575 Set(%NetServerOptions, ());
1580 =head1 UTF-8 Configuration
1584 =item C<@LexiconLanguages>
1586 An array that contains languages supported by RT's internationalization
1587 interface. Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
1588 RT bilingual instead of multilingual, but will save some memory.
1592 Set(@LexiconLanguages, qw(*));
1594 =item C<@EmailInputEncodings>
1596 An array that contains default encodings used to guess which charset
1597 an attachment uses if not specified. Must be recognized by
1602 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1604 =item C<$EmailOutputEncoding>
1606 The charset for localized email. Must be recognized by Encode.
1610 Set($EmailOutputEncoding, 'utf-8');
1615 =head1 Date Handling Configuration
1619 =item C<$DateTimeFormat>
1621 You can choose date and time format. See "Output formatters"
1622 section in perldoc F<lib/RT/Date.pm> for more options. This option can
1623 be overridden by users in their preferences.
1626 C<Set($DateTimeFormat, 'LocalizedDateTime');>
1627 C<Set($DateTimeFormat, { Format => 'ISO', Seconds => 0 });>
1628 C<Set($DateTimeFormat, 'RFC2822');>
1629 C<Set($DateTimeFormat, { Format => 'RFC2822', Seconds => 0, DayOfWeek => 0 });>
1633 Set($DateTimeFormat, 'DefaultFormat');
1635 # Next two options are for Time::ParseDate
1637 =item C<$DateDayBeforeMonth>
1639 Set this to 1 if your local date convention looks like "dd/mm/yy" instead of
1640 "mm/dd/yy". Used only for parsing, not for displaying dates.
1644 Set($DateDayBeforeMonth , 1);
1646 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
1648 Should an unspecified day or year in a date refer to a future or a
1649 past value? For example, should a date of "Tuesday" default to mean
1650 the date for next Tuesday or last Tuesday? Should the date "March 1"
1651 default to the date for next March or last March?
1653 Set $<AmbiguousDayInPast> for the last date, or $<$AmbiguousDayInFuture> for the
1656 The default is usually good.
1660 Set($AmbiguousDayInPast, 0);
1661 Set($AmbiguousDayInFuture, 0);
1665 =head1 Approval Configuration
1667 Configration for the approvl system
1671 =item C<$ApprovalRejectionNotes>
1673 Should rejection notes be sent to the requestors? The default is true.
1677 Set($ApprovalRejectionNotes, 1);
1682 =head1 Miscellaneous Configuration
1686 =item C<@ActiveStatus>, C<@InactiveStatus>
1688 You can define new statuses and even reorder existing statuses here.
1689 WARNING. DO NOT DELETE ANY OF THE DEFAULT STATUSES. If you do, RT
1690 will break horribly. The statuses you add must be no longer than
1695 Set(@ActiveStatus, qw(new open stalled));
1696 Set(@InactiveStatus, qw(resolved rejected deleted));
1698 =item C<$LinkTransactionsRun1Scrip>
1700 RT-3.4 backward compatibility setting. Add/Delete Link used to record one
1701 transaction and run one scrip. Set this value to 1 if you want
1702 only one of the link transactions to have scrips run.
1706 Set($LinkTransactionsRun1Scrip, 0);
1708 =item C<$StrictLinkACL>
1710 When this feature is enabled a user needs I<ModifyTicket> rights on both
1711 tickets to link them together, otherwise he can have rights on either of
1716 Set($StrictLinkACL, 1);
1718 =item C<$PreviewScripMessages>
1720 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1721 reply page should include the content of the messages to be sent.
1725 Set($PreviewScripMessages, 0);
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<@CustomFieldValuesSources>
1740 Set C<@CustomFieldValuesSources> to a list of class names which extend
1741 L<RT::CustomFieldValues::External>. This can be used to pull lists of
1742 custom field values from external sources at runtime.
1746 Set(@CustomFieldValuesSources, ());
1748 =item C<$CanonicalizeRedirectURLs>
1750 Set C<$CanonicalizeRedirectURLs> to 1 to use $C<WebURL> when redirecting rather
1751 than the one we get from C<%ENV>.
1753 If you use RT behind a reverse proxy, you almost certainly want to
1758 Set($CanonicalizeRedirectURLs, 0);
1759 =item C<$EnableReminders>
1761 Hide links/portlets related to Reminders by setting this to 0
1765 Set($EnableReminders,1);
1770 Set C<@Plugins> to a list of external RT plugins that should be enabled (those
1771 plugins have to be previously downloaded and installed).
1774 C<Set(@Plugins, (qw(Extension::QuickDelete RT::FM)));>
1782 =head1 Development Configuration
1788 RT comes with a "Development mode" setting.
1789 This setting, as a convenience for developers, turns on
1790 all sorts of development options that you most likely don't want in
1793 * Turns off Mason's 'static_source' directive. By default, you can't
1794 edit RT's web ui components on the fly and have RT magically pick up
1795 your changes. (It's a big performance hit)
1801 Set($DevelMode, '0');
1806 =head1 Deprecated Options
1810 =item C<$AlwaysUseBase64>
1812 Encode blobs as base64 in DB (?)
1814 =item C<$TicketBaseURI>
1816 Base URI to tickets in this system; used when loading (?)
1818 =item C<$UseCodeTickets>
1820 This option is exists for backwards compatibility. Don't use it.