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);
180 =head1 Incoming Mail Gateway Configuration
186 C<$OwnerEmail> is the address of a human who manages RT. RT will send
187 errors generated by the mail gateway to this address. This address
188 should _not_ be an address that's managed by your RT instance.
192 Set($OwnerEmail , 'root');
194 =item C<$LoopsToRTOwner>
196 If C<$LoopsToRTOwner> is defined, RT will send mail that it believes
197 might be a loop to C<$OwnerEmail>
201 Set($LoopsToRTOwner , 1);
205 If C<$StoreLoops> is defined, RT will record messages that it believes
206 to be part of mail loops.
208 As it does this, it will try to be careful not to send mail to the
209 sender of these messages
213 Set($StoreLoops , undef);
215 =item C<$MaxAttachmentSize>
217 C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments stored
220 For mysql and oracle, we set this size at 10 megabytes.
221 If you're running a postgres version earlier than 7.1, you will need
222 to drop this to 8192. (8k)
227 Set($MaxAttachmentSize , 10000000);
229 =item C<$TruncateLongAttachments>
231 C<$TruncateLongAttachments>: if this is set to a non-undef value,
232 RT will truncate attachments longer than C<$MaxAttachmentSize>.
236 Set($TruncateLongAttachments , undef);
238 =item C<$DropLongAttachments>
240 C<$DropLongAttachments>: if this is set to a non-undef value,
241 RT will silently drop attachments longer than C<MaxAttachmentSize>.
245 Set($DropLongAttachments , undef);
247 =item C<$ParseNewMessageForTicketCcs>
249 If C<$ParseNewMessageForTicketCcs> is true, RT will attempt to divine
250 Ticket 'Cc' watchers from the To and Cc lines of incoming messages
251 Be forewarned that if you have _any_ addresses which forward mail to
252 RT automatically and you enable this option without modifying
253 C<$RTAddressRegexp> below, you will get yourself into a heap of trouble.
257 Set($ParseNewMessageForTicketCcs , undef);
259 =item C<$RTAddressRegexp>
261 C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a ticket CC if
262 the setting above is enabled. It is important that you set this to a
263 regular expression that matches all addresses used by your RT. This lets RT
264 avoid sending mail to itself. It will also hide RT addresses from the list of
265 "One-time Cc" and Bcc lists on ticket reply.
269 Set($RTAddressRegexp , '^rt\@example.com$');
271 =item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
273 RT provides functionality which allows the system to rewrite
274 incoming email addresses. In its simplest form,
275 you can substitute the value in $<CanonicalizeEmailAddressReplace>
276 for the value in $<CanonicalizeEmailAddressMatch>
277 (These values are passed to the $<CanonicalizeEmailAddress> subroutine in
280 By default, that routine performs a C<s/$Match/$Replace/gi> on any address
285 #Set($CanonicalizeEmailAddressMatch , '@subdomain\.example\.com$');
286 #Set($CanonicalizeEmailAddressReplace , '@example.com');
288 =item C<$CanonicalizeEmailAddressMatch>
290 Set this to true and the create new user page will use the values that you
291 enter in the form but use the function CanonicalizeUserInfo in
296 Set($CanonicalizeOnCreate, 0);
298 =item C<$SenderMustExistInExternalDatabase>
300 If C<$SenderMustExistInExternalDatabase> is true, RT will refuse to
301 create non-privileged accounts for unknown users if you are using
302 the C<$LookupSenderInExternalDatabase> option.
303 Instead, an error message will be mailed and RT will forward the
304 message to C<$RTOwner>.
306 If you are not using C<$LookupSenderInExternalDatabase>, this option
309 If you define an AutoRejectRequest template, RT will use this
310 template for the rejection message.
314 Set($SenderMustExistInExternalDatabase , undef);
316 =item C<$ValidateUserEmailAddresses>
318 If C<$ValidateUserEmailAddresses> is true, RT will refuse to create users with
319 an invalid email address (as specified in RFC 2822) or with an email address
320 made of multiple email adresses.
324 Set($ValidateUserEmailAddresses, undef);
326 =item C<@MailPlugins>
328 C<@MailPlugins> is a list of auth plugins for L<RT::Interface::Email>
329 to use; see L<rt-mailgate>
333 =item C<$UnsafeEmailCommands>
335 C<$UnsafeEmailCommands>, if set to true, enables 'take' and 'resolve'
336 as possible actions via the mail gateway. As its name implies, this
337 is very unsafe, as it allows email with a forged sender to possibly
338 resolve arbitrary tickets!
342 =item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
344 The default "extract remote tracking tags" scrip settings; these
345 detect when your RT is talking to another RT, and adjusts the
350 Set($ExtractSubjectTagMatch, qr/\[.+? #\d+\]/);
351 Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
352 ? qr/\[(?:${RT::EmailSubjectTagRegex}) #\d+\]/
353 : qr/\[\Q$RT::rtname\E #\d+\]/));
357 =head1 Outgoing Mail Configuration
361 =item C<$MailCommand>
363 C<$MailCommand> defines which method RT will use to try to send mail.
364 We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
365 doesn't work well for you, try 'sendmail'. Other options are 'smtp'
368 Note that you should remove the '-t' from C<$SendmailArguments>
369 if you use 'sendmail' rather than 'sendmailpipe'
373 Set($MailCommand , 'sendmailpipe');
375 =item C<$SetOutgoingMailFrom>
377 C<$SetOutgoingMailFrom> tells RT to set the sender envelope with the correspond
378 mail address of the ticket's queue.
380 Warning: If you use this setting, bounced mails will appear to be incoming
381 mail to the system, thus creating new tickets.
385 Set($SetOutgoingMailFrom, 0);
387 =item C<$OverrideOutgoingMailFrom>
389 C<$OverrideOutgoingMailFrom> is used for overwriting the Correspond
390 address of the queue. The option is a hash reference of queue name to
393 If there is no ticket involved, then the value of the C<Default> key will be
398 Set($OverrideOutgoingMailFrom, {
399 # 'Default' => 'admin@rt.example.com',
400 # 'General' => 'general@rt.example.com',
405 =head1 Sendmail Configuration
407 These options only take effect if C<$MailCommand> is 'sendmail' or
412 =item C<$SendmailArguments>
414 C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
415 If you picked 'sendmailpipe', you MUST add a -t flag to C<$SendmailArguments>
416 These options are good for most sendmail wrappers and workalikes
418 These arguments are good for sendmail brand sendmail 8 and newer
419 C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
423 Set($SendmailArguments , "-oi -t");
426 =item C<$SendmailBounceArguments>
428 C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
429 assuming RT needs to send an error (ie. bounce).
433 Set($SendmailBounceArguments , '-f "<>"');
435 =item C<$SendmailPath>
437 If you selected 'sendmailpipe' above, you MUST specify the path to
438 your sendmail binary in C<$SendmailPath>.
442 Set($SendmailPath , "/usr/sbin/sendmail");
447 =head1 SMTP Configuration
449 These options only take effect if C<$MailCommand> is 'smtp'
455 C<$SMTPServer> should be set to the hostname of the SMTP server to use
459 Set($SMTPServer, undef);
463 C<$SMTPFrom> should be set to the 'From' address to use, if not the
468 Set($SMTPFrom, undef);
472 C<$SMTPDebug> should be set to true to debug SMTP mail sending
480 =head1 Other Mailer Configuration
486 C<@MailParams> defines a list of options passed to $MailCommand if it
487 is not 'sendmailpipe', 'sendmail', or 'smtp'
491 Set(@MailParams, ());
493 =item C<$CorrespondAddress>, C<$CommentAddress>
495 RT is designed such that any mail which already has a ticket-id associated
496 with it will get to the right place automatically.
498 C<$CorrespondAddress> and C<$CommentAddress> are the default addresses
499 that will be listed in From: and Reply-To: headers of correspondence
500 and comment mail tracked by RT, unless overridden by a queue-specific
505 Set($CorrespondAddress , '');
507 Set($CommentAddress , '');
509 =item C<$DashboardAddress>
511 The email address from which RT will send dashboards. If none is set, then
512 C<$OwnerEmail> will be used.
516 Set($DashboardAddress, '');
518 =item C<$UseFriendlyFromLine>
520 By default, RT sets the outgoing mail's "From:" header to
521 "SenderName via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
525 Set($UseFriendlyFromLine, 1);
527 =item C<$FriendlyFromLineFormat>
529 C<sprintf()> format of the friendly 'From:' header; its arguments
530 are SenderName and SenderEmailAddress.
534 Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
536 =item C<$UseFriendlyToLine>
538 RT can optionally set a "Friendly" 'To:' header when sending messages to
539 Ccs or AdminCcs (rather than having a blank 'To:' header.
541 This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL
542 If you are using sendmail, rather than postfix, qmail, exim or some other MTA,
543 you _must_ disable this option.
547 Set($UseFriendlyToLine, 0);
549 =item C<$FriendlyToLineFormat>
551 C<sprintf()> format of the friendly 'From:' header; its arguments
552 are WatcherType and TicketId.
556 Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
558 =item C<$NotifyActor>
560 By default, RT doesn't notify the person who performs an update, as they
561 already know what they've done. If you'd like to change this behaviour,
562 Set C<$NotifyActor> to 1
566 Set($NotifyActor, 0);
568 =item C<$RecordOutgoingEmail>
570 By default, RT records each message it sends out to its own internal database.
571 To change this behavior, set C<$RecordOutgoingEmail> to 0
575 Set($RecordOutgoingEmail, 1);
577 =item C<$VERPPrefix>, C<$VERPPrefix>
579 VERP support (http://cr.yp.to/proto/verp.txt)
581 uncomment the following two directives to generate envelope senders
582 of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
583 (i.e. rt-jesse=fsck.com@rt.example.com ).
585 This currently only works with sendmail and sendmailppie.
589 # Set($VERPPrefix, 'rt-');
590 # Set($VERPDomain, $RT::Organization);
593 =item C<$ForwardFromUser>
595 By default, RT forwards a message using queue's address and adds RT's tag into
596 subject of the outgoing message, so recipients' replies go into RT as correspondents.
598 To change this behavior, set C<$ForwardFromUser> to true value and RT will use
599 address of the current user and leave subject without RT's tag.
603 Set($ForwardFromUser, 0);
605 =item C<$ShowBccHeader>
607 By default RT hides from the web UI information about blind copies user sent on
610 To change this set the following option to true value.
614 Set($ShowBccHeader, 0);
616 =item C<$DashboardSubject>
618 Lets you set the subject of dashboards. Arguments are the frequency (Daily,
619 Weekly, Monthly) of the dashboard and the dashboard's name. [_1] for the name
624 Set($DashboardSubject, '%s Dashboard: %s');
628 =head1 GnuPG Configuration
630 A full description of the (somewhat extensive) GnuPG integration can be found
631 by running the command `perldoc L<RT::Crypt::GnuPG>` (or `perldoc
632 lib/RT/Crypt/GnuPG.pm` from your RT install directory).
638 Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
639 signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
641 If you want to allow people to encrypt attachments inside the DB then
642 set C<AllowEncryptDataInDB> to true
644 Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
645 emails encrypted for key RT doesn't have and can not decrypt.
647 Set C<RejectOnBadData> to false if you don't want to reject letters
648 with incorrect GnuPG data.
654 OutgoingMessagesFormat => 'RFC', # Inline
655 AllowEncryptDataInDB => 0,
657 RejectOnMissingPrivateKey => 1,
658 RejectOnBadData => 1,
661 =item C<%GnuPGOptions>
663 Options of GnuPG program.
665 If you override this in your RT_SiteConfig, you should be sure
666 to include a homedir setting.
668 NOTE that options with '-' character MUST be quoted.
673 homedir => 'var/data/gpg',
676 # keyserver => 'hkp://subkeys.pgp.net',
678 # enables the automatic retrieving of keys when encrypting
679 # 'auto-key-locate' => 'keyserver',
681 # enables the automatic retrieving of keys when verifying signatures
682 # 'auto-key-retrieve' => undef,
688 =head1 Logging Configuration
690 The default is to log anything except debugging
691 information to syslog. Check the L<Log::Dispatch> POD for
692 information about how to get things by syslog, mail or anything
693 else, get debugging info in the log, etc.
695 It might generally make sense to send error and higher by email to
696 some administrator. If you do this, be careful that this email
697 isn't sent to this RT instance. Mail loops will generate a critical
702 =item C<$LogToSyslog>, C<$LogToScreen>
704 The minimum level error that will be logged to the specific device.
705 From lowest to highest priority, the levels are:
706 debug info notice warning error critical alert emergency
710 Set($LogToSyslog , 'info');
711 Set($LogToScreen , 'info');
713 =item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
715 Logging to a standalone file is also possible, but note that the
716 file should needs to both exist and be writable by all direct users
717 of the RT API. This generally include the web server, whoever
718 rt-crontool runs as. Note that as rt-mailgate and the RT CLI go
719 through the webserver, so their users do not need to have write
720 permissions to this file. If you expect to have multiple users of
721 the direct API, Best Practical recommends using syslog instead of
726 Set($LogToFile , undef);
727 Set($LogDir, 'var/log');
728 Set($LogToFileNamed , "rt.log"); #log to rt.log
730 =item C<$LogStackTraces>
732 If set to a log level then logging will include stack traces for
733 messages with level equal to or greater than specified.
735 NOTICE: Stack traces include parameters supplied to functions or
736 methods. It is possible for stack trace logging to reveal sensitive
737 information such as passwords or ticket content in your logs.
741 Set($LogStackTraces, '');
743 =item C<@LogToSyslogConf>
745 On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
746 override any other options RT passes to L<Log::Dispatch::Syslog>.
747 Other interesting flags include facility and logopt. (See the
748 L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
749 ident too, if you have multiple RT installations.)
753 Set(@LogToSyslogConf, ());
755 =item C<$StatementLog>,
757 RT has rudimentary SQL statement logging support if you have
758 DBIx-SearchBuilder 1.31_1 or higher; simply set C<$StatementLog> to be
759 the level that you wish SQL statements to be logged at.
763 Set($StatementLog, undef);
767 =head1 Web Interface Configuration
771 =item C<$WebDefaultStylesheet>
773 This determines the default stylesheet the RT web interface will use.
774 RT ships with several themes by default:
776 web2 The totally new, default layout for RT 3.8
777 3.5-default RT 3.5 and 3.6 original layout
778 3.4-compat A 3.4 compatibility stylesheet to make RT look
781 This value actually specifies a directory in F<share/html/NoAuth/css/>
782 from which RT will try to load the file main.css (which should
783 @import any other files the stylesheet needs). This allows you to
784 easily and cleanly create your own stylesheets to apply to RT. This
785 option can be overridden by users in their preferences.
789 Set($WebDefaultStylesheet, 'web2');
791 =item C<$UsernameFormat>
793 This determines how user info is displayed. 'concise' will show one of
794 either NickName, RealName, Name or EmailAddress, depending on what exists
795 and whether the user is privileged or not. 'verbose' will show RealName and
800 Set($UsernameFormat, 'concise');
804 Domain name of the RT server, eg 'www.example.com'. It should not contain
805 anything else, but server name.
809 Set( $WebDomain, 'localhost' );
813 If we're running as a superuser, run on port 80
814 Otherwise, pick a high port for this user.
816 443 is default port for https protocol.
820 Set($WebPort, 80);# + ($< * 7274) % 32766 + ($< && 1024));
824 If you're putting the web ui somewhere other than at the root of
825 your server, you should set C<$WebPath> to the path you'll be
828 C<$WebPath> requires a leading / but no trailing /, or it can be blank.
830 In most cases, you should leave C<$WebPath> set to '' (an empty value).
836 =item C<$WebBaseURL>, C<$WebURL>
838 Usually you don't want to set these options. The only obviouse reason is
839 RT accessible via https protocol on non standard port, eg
840 'https://rt.example.com:9999'. In all other cases these options are computed
841 using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
843 C<$WebBaseURL> is the scheme, server and port (eg 'http://rt.example.com')
844 for constructing urls to the web UI. C<$WebBaseURL> doesn't need a trailing /.
846 C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for example:
847 'http://www.example.com/rt/'.
851 my $port = RT->Config->Get('WebPort');
853 ($port == 443? 'https': 'http') .'://'
854 . RT->Config->Get('WebDomain')
855 . ($port != 80 && $port != 443? ":$port" : '')
858 Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
860 =item C<$WebImagesURL>
862 C<$WebImagesURL> points to the base URL where RT can find its images.
863 Define the directory name to be used for images in rt web
868 Set($WebImagesURL, RT->Config->Get('WebPath') . "/NoAuth/images/");
872 C<$LogoURL> points to the URL of the RT logo displayed in the web UI
876 Set($LogoURL, RT->Config->Get('WebImagesURL') . "bplogo.gif");
878 =item C<$WebNoAuthRegex>
880 What portion of RT's URL space should not require authentication.
882 This is mostly for extension and doesn't mean RT will work without
883 login if you change it.
887 Set($WebNoAuthRegex, qr{^ /rt (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
889 =item C<$SelfServiceRegex>
891 What portion of RT's URLspace should be accessible to Unprivileged users
892 This does not override the redirect from F</Ticket/Display.html> to
893 F</SelfService/Display.html> when Unprivileged users attempt to access
898 Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
900 =item C<$MessageBoxWidth>, C<$MessageBoxHeight>
902 For message boxes, set the entry box width, height and what type of
903 wrapping to use. These options can be overridden by users in their
906 Default width: 72, height: 15
908 These settings only apply to the non-RichText message box.
909 See below for Rich Text settings.
913 Set($MessageBoxWidth, 72);
914 Set($MessageBoxHeight, 15);
916 =item C<$MessageBoxWrap>
918 Default wrapping: "HARD" (choices "SOFT", "HARD")
920 Wrapping is disabled when using MessageBoxRichText because
921 of a bad interaction between IE and wrapping with the Rich
926 Set($MessageBoxWrap, "HARD");
928 =item C<$MessageBoxRichText>
930 Should "rich text" editing be enabled? This option lets your users send html email messages from the web interface.
934 Set($MessageBoxRichText, 1);
936 =item C<$MessageBoxRichTextHeight>
938 Height of RichText javascript enabled editing boxes (in pixels)
942 Set($MessageBoxRichTextHeight, 200);
944 =item C<$MessageBoxIncludeSignature>
946 Should your user's signatures (from their Preferences page) be included in Comments and Replies
950 Set($MessageBoxIncludeSignature, 1);
952 =item C<$WikiImplicitLinks>
954 Support implicit links in WikiText custom fields? A true value
955 causes InterCapped or ALLCAPS words in WikiText fields to
956 automatically become links to searches for those words. If used on
957 RTFM articles, it links to the RTFM article with that name.
961 Set($WikiImplicitLinks, 0);
963 =item C<$TrustHTMLAttachments>
965 if C<TrustHTMLAttachments> is not defined, we will display them
966 as text. This prevents malicious HTML and javascript from being
967 sent in a request (although there is probably more to it than that)
971 Set($TrustHTMLAttachments, undef);
973 =item C<$RedistributeAutoGeneratedMessages>
975 Should RT redistribute correspondence that it identifies as
976 machine generated? A true value will do so; setting this to '0'
977 will cause no such messages to be redistributed.
978 You can also use 'privileged' (the default), which will redistribute
979 only to privileged users. This helps to protect against malformed
980 bounces and loops caused by autocreated requestors with bogus addresses.
984 Set($RedistributeAutoGeneratedMessages, 'privileged');
986 =item C<$PreferRichText>
988 If C<$PreferRichText> is set to a true value, RT will show HTML/Rich text
989 messages in preference to their plaintext alternatives. RT "scrubs" the
990 html to show only a minimal subset of HTML to avoid possible contamination
991 by cross-site-scripting attacks.
995 Set($PreferRichText, undef);
997 =item C<$WebExternalAuth>
999 If C<$WebExternalAuth> is defined, RT will defer to the environment's
1000 REMOTE_USER variable.
1004 Set($WebExternalAuth, undef);
1006 =item C<$WebExternalAuthContinuous>
1008 If C<$WebExternalAuthContinuous> is defined, RT will check for the
1009 REMOTE_USER on each access. If you would prefer this to only happen
1010 once (at initial login) set this to a false value. The default setting
1011 will help ensure that if your external auth system deauthenticates a
1012 user, RT notices as soon as possible.
1016 Set($WebExternalAuthContinuous, 1);
1018 =item C<$WebFallbackToInternalAuth>
1020 If C<$WebFallbackToInternalAuth> is defined, the user is allowed a chance
1021 of fallback to the login screen, even if REMOTE_USER failed.
1025 Set($WebFallbackToInternalAuth , undef);
1027 =item C<$WebExternalGecos>
1029 C<$WebExternalGecos> means to match 'gecos' field as the user identity);
1030 useful with mod_auth_pwcheck and IIS Integrated Windows logon.
1034 Set($WebExternalGecos , undef);
1036 =item C<$WebExternalAuto>
1038 C<$WebExternalAuto> will create users under the same name as REMOTE_USER
1039 upon login, if it's missing in the Users table.
1043 Set($WebExternalAuto , undef);
1045 =item C<$AutoCreate>
1047 If C<$WebExternalAuto> is true, C<$AutoCreate> will be passed to User's
1048 Create method. Use it to set defaults, such as creating
1049 Unprivileged users with C<{ Privileged => 0 }>
1050 ( Must be a hashref of arguments )
1054 Set($AutoCreate, undef);
1056 =item C<$WebSessionClass>
1058 C<$WebSessionClass> is the class you wish to use for managing Sessions.
1059 It defaults to use your SQL database, but if you are using MySQL 3.x and
1060 plans to use non-ascii Queue names, uncomment and add this line to
1061 F<RT_SiteConfig.pm> will prevent session corruption.
1065 # Set($WebSessionClass , 'Apache::Session::File');
1067 =item C<$AutoLogoff>
1069 By default, RT's user sessions persist until a user closes his or her
1070 browser. With the C<$AutoLogoff> option you can setup session lifetime in
1071 minutes. A user will be logged out if he or she doesn't send any requests
1072 to RT for the defined time.
1076 Set($AutoLogoff, 0);
1078 =item C<$WebSecureCookies>
1080 By default, RT's session cookie isn't marked as "secure" Some web browsers
1081 will treat secure cookies more carefully than non-secure ones, being careful
1082 not to write them to disk, only send them over an SSL secured connection
1083 and so on. To enable this behaviour, set C<$WebSecureCookies> to a true value.
1084 NOTE: You probably don't want to turn this on _unless_ users are only connecting
1085 via SSL encrypted HTTP connections.
1089 Set($WebSecureCookies, 0);
1091 =item C<$WebFlushDbCacheEveryRequest>
1093 By default, RT clears its database cache after every page view.
1094 This ensures that you've always got the most current information
1095 when working in a multi-process (mod_perl or FastCGI) Environment
1096 Setting C<$WebFlushDbCacheEveryRequest> to '0' will turn this off,
1097 which will speed RT up a bit, at the expense of a tiny bit of data
1102 Set($WebFlushDbCacheEveryRequest, '1');
1105 =item C<$MaxInlineBody>
1107 C<$MaxInlineBody> is the maximum attachment size that we want to see
1108 inline when viewing a transaction. RT will inline any text if value
1109 is undefined or 0. This option can be overridden by users in their
1114 Set($MaxInlineBody, 12000);
1116 =item C<$DefaultSummaryRows>
1118 C<$DefaultSummaryRows> is default number of rows displayed in for search
1119 results on the frontpage.
1123 Set($DefaultSummaryRows, 10);
1125 =item C<$HomePageRefreshInterval>
1127 C<$HomePageRefreshInterval> is default number of seconds to refresh the RT
1128 home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1132 Set($HomePageRefreshInterval, 0);
1134 =item C<$SearchResultsRefreshInterval>
1136 C<$SearchResultsRefreshInterval> is default number of seconds to refresh
1137 search results in RT. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
1141 Set($SearchResultsRefreshInterval, 0);
1143 =item C<$OldestTransactionsFirst>
1145 By default, RT shows newest transactions at the bottom of the ticket
1146 history page, if you want see them at the top set this to '0'. This
1147 option can be overridden by users in their preferences.
1151 Set($OldestTransactionsFirst, '1');
1153 =item C<$ShowTransactionImages>
1155 By default, RT shows images attached to incoming (and outgoing) ticket updates
1156 inline. Set this variable to 0 if you'd like to disable that behaviour
1160 Set($ShowTransactionImages, 1);
1162 =item C<$PlainTextPre>
1164 Normally plaintext attachments are displayed as HTML with line
1165 breaks preserved. This causes space- and tab-based formatting not
1166 to be displayed correctly. By setting $PlainTextPre they'll be
1167 displayed using <pre> instead so such formatting works, but they'll
1168 use a monospaced font, no matter what the value of C<$PlainTextMono> is.
1172 Set($PlainTextPre, 0);
1175 =item C<$PlainTextMono>
1176 To display plaintext attachments,
1177 Set C<$PlainTextMono> to 1 to use monospaced font and preserve
1178 formatting, but unlike PlainTextPre, the text will wrap to fit into the
1183 Set($PlainTextMono, 0);
1185 =item C<$ShowUnreadMessageNotifications>
1187 By default, RT will prompt users when there are new, unread messages on
1188 tickets they are viewing.
1190 Set C<$ShowUnreadMessageNotifications> to a false value to disable this feature.
1194 Set($ShowUnreadMessageNotifications, 1);
1197 =item C<$HomepageComponents>
1199 C<$HomepageComponents> is an arrayref of allowed components on a user's
1200 customized homepage ("RT at a glance").
1204 Set($HomepageComponents, [qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards)]);
1206 =item C<@MasonParameters>
1208 C<@MasonParameters> is the list of parameters for the constructor of
1209 HTML::Mason's Apache or CGI Handler. This is normally only useful
1210 for debugging, eg. profiling individual components with:
1212 use MasonX::Profiler; # available on CPAN
1213 Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
1217 Set(@MasonParameters, ());
1219 =item C<$DefaultSearchResultFormat>
1221 C<$DefaultSearchResultFormat> is the default format for RT search results
1225 Set ($DefaultSearchResultFormat, qq{
1226 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1227 '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1234 '<small>__Requestors__</small>',
1235 '<small>__CreatedRelative__</small>',
1236 '<small>__ToldRelative__</small>',
1237 '<small>__LastUpdatedRelative__</small>',
1238 '<small>__TimeLeft__</small>'});
1240 =item C<$DefaultSelfServiceSearchResultFormat>
1242 C<$DefaultSelfServiceSearchResultFormat> is the default format of searches displayed in the
1243 SelfService interface.
1247 Set($DefaultSelfServiceSearchResultFormat, qq{
1248 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
1249 '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
1254 =item C<$SuppressInlineTextFiles>
1256 If C<$SuppressInlineTextFiles> is set to a true value, then uploaded
1257 text files (text-type attachments with file names) are prevented
1258 from being displayed in-line when viewing a ticket's history.
1262 Set($SuppressInlineTextFiles, undef);
1264 =item C<$DontSearchFileAttachments>
1266 If C<$DontSearchFileAttachments> is set to a true value, then uploaded
1267 files (attachments with file names) are not searched during full-content
1272 Set($DontSearchFileAttachments, undef);
1276 The L<GD> module (which RT uses for graphs) uses a builtin font that doesn't
1277 have full Unicode support. You can use a particular TrueType font by setting
1278 $ChartFont to the absolute path of that font. Your GD library must have
1279 support for TrueType fonts to use this option.
1283 Set($ChartFont, undef);
1286 =item C<@Active_MakeClicky>
1288 MakeClicky detects various formats of data in headers and email
1289 messages, and extends them with supporting links. By default, RT
1290 provides two formats:
1292 * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
1295 * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
1296 replace URL with link and *adds spaces* into text if it's longer
1297 then 30 chars. This allow browser to wrap long URLs and avoid
1298 horizontal scrolling.
1300 See F<share/html/Elements/MakeClicky> for documentation on how to add your own.
1304 Set(@Active_MakeClicky, qw());
1306 =item C<$DefaultQueue>
1308 Use this to select the default queue name that will be used for creating new
1309 tickets. You may use either the queue's name or its ID. This only affects the
1310 queue selection boxes on the web interface.
1314 #Set($DefaultQueue, 'General');
1316 =item C<$DefaultTimeUnitsToHours>
1318 Use this to set the default units for time entry to hours instead of minutes.
1322 Set($DefaultTimeUnitsToHours, 0);
1326 =head1 L<Net::Server> (rt-server) Configuration
1330 =item C<$StandaloneMinServers>, C<$StandaloneMaxServers>
1332 The absolute minimum and maximum number of servers that will be created to
1333 handle requests. Having multiple servers means that serving a slow page will
1334 affect other users less.
1338 Set($StandaloneMinServers, 1);
1339 Set($StandaloneMaxServers, 1);
1341 =item C<$StandaloneMinSpareServers>, C<$StandaloneMaxSpareServers>
1343 These next two options can be used to scale up and down the number of servers
1344 to adjust to load. These two options will respect the C<$StandaloneMinServers
1345 > and C<$StandaloneMaxServers options>.
1349 Set($StandaloneMinSpareServers, 0);
1350 Set($StandaloneMaxSpareServers, 0);
1352 =item C<$StandaloneMaxRequests>
1354 This sets the absolute maximum number of requests a single server will serve.
1355 Setting this would be useful if, for example, memory usage slowly crawls up
1360 #Set($StandaloneMaxRequests, 50);
1362 =item C<%NetServerOptions>
1364 C<%NetServerOptions> is a hash of additional options to use for
1365 L<Net::Server/DEFAULT ARGUMENTS>. For example, you could set
1366 reverse_lookups to get the hostnames for all users with:
1368 C<Set(%NetServerOptions, (reverse_lookups => 1));>
1372 Set(%NetServerOptions, ());
1377 =head1 UTF-8 Configuration
1381 =item C<@LexiconLanguages>
1383 An array that contains languages supported by RT's internationalization
1384 interface. Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
1385 RT bilingual instead of multilingual, but will save some memory.
1389 Set(@LexiconLanguages, qw(*));
1391 =item C<@EmailInputEncodings>
1393 An array that contains default encodings used to guess which charset
1394 an attachment uses if not specified. Must be recognized by
1399 Set(@EmailInputEncodings, qw(utf-8 iso-8859-1 us-ascii));
1401 =item C<$EmailOutputEncoding>
1403 The charset for localized email. Must be recognized by Encode.
1407 Set($EmailOutputEncoding, 'utf-8');
1412 =head1 Date Handling Configuration
1416 =item C<$DateTimeFormat>
1418 You can choose date and time format. See "Output formatters"
1419 section in perldoc F<lib/RT/Date.pm> for more options. This option can
1420 be overridden by users in their preferences.
1423 C<Set($DateTimeFormat, 'LocalizedDateTime');>
1424 C<Set($DateTimeFormat, { Format => 'ISO', Seconds => 0 });>
1425 C<Set($DateTimeFormat, 'RFC2822');>
1426 C<Set($DateTimeFormat, { Format => 'RFC2822', Seconds => 0, DayOfWeek => 0 });>
1430 Set($DateTimeFormat, 'DefaultFormat');
1432 # Next two options are for Time::ParseDate
1434 =item C<$DateDayBeforeMonth>
1436 Set this to 1 if your local date convention looks like "dd/mm/yy" instead of
1437 "mm/dd/yy". Used only for parsing, not for displaying dates.
1441 Set($DateDayBeforeMonth , 1);
1443 =item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
1445 Should an unspecified day or year in a date refer to a future or a
1446 past value? For example, should a date of "Tuesday" default to mean
1447 the date for next Tuesday or last Tuesday? Should the date "March 1"
1448 default to the date for next March or last March?
1450 Set $<AmbiguousDayInPast> for the last date, or $<$AmbiguousDayInFuture> for the
1453 The default is usually good.
1457 Set($AmbiguousDayInPast, 0);
1458 Set($AmbiguousDayInFuture, 0);
1462 =head1 Approval Configuration
1464 Configration for the approvl system
1468 =item C<$ApprovalRejectionNotes>
1470 Should rejection notes be sent to the requestors? The default is true.
1474 Set($ApprovalRejectionNotes, 1);
1479 =head1 Miscellaneous Configuration
1483 =item C<@ActiveStatus>, C<@InactiveStatus>
1485 You can define new statuses and even reorder existing statuses here.
1486 WARNING. DO NOT DELETE ANY OF THE DEFAULT STATUSES. If you do, RT
1487 will break horribly. The statuses you add must be no longer than
1492 Set(@ActiveStatus, qw(new open stalled));
1493 Set(@InactiveStatus, qw(resolved rejected deleted));
1495 =item C<$LinkTransactionsRun1Scrip>
1497 RT-3.4 backward compatibility setting. Add/Delete Link used to record one
1498 transaction and run one scrip. Set this value to 1 if you want
1499 only one of the link transactions to have scrips run.
1503 Set($LinkTransactionsRun1Scrip, 0);
1505 =item C<$StrictLinkACL>
1507 When this feature is enabled a user needs I<ModifyTicket> rights on both
1508 tickets to link them together, otherwise he can have rights on either of
1513 Set($StrictLinkACL, 1);
1515 =item C<$PreviewScripMessages>
1517 Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
1518 reply page should include the content of the messages to be sent.
1522 Set($PreviewScripMessages, 0);
1524 =item C<$UseTransactionBatch>
1526 Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
1527 such that a resolve and comment (for example) would happen
1528 simultaneously, instead of as two transactions, unaware of each
1533 Set($UseTransactionBatch, 1);
1535 =item C<@CustomFieldValuesSources>
1537 Set C<@CustomFieldValuesSources> to a list of class names which extend
1538 L<RT::CustomFieldValues::External>. This can be used to pull lists of
1539 custom field values from external sources at runtime.
1543 Set(@CustomFieldValuesSources, ());
1545 =item C<$CanonicalizeRedirectURLs>
1547 Set C<$CanonicalizeRedirectURLs> to 1 to use $C<WebURL> when redirecting rather
1548 than the one we get from C<%ENV>.
1550 If you use RT behind a reverse proxy, you almost certainly want to
1555 Set($CanonicalizeRedirectURLs, 0);
1556 =item C<$EnableReminders>
1558 Hide links/portlets related to Reminders by setting this to 0
1562 Set($EnableReminders,1);
1567 Set C<@Plugins> to a list of external RT plugins that should be enabled (those
1568 plugins have to be previously downloaded and installed).
1571 C<Set(@Plugins, (qw(Extension::QuickDelete RT::FM)));>
1579 =head1 Development Configuration
1585 RT comes with a "Development mode" setting.
1586 This setting, as a convenience for developers, turns on
1587 all sorts of development options that you most likely don't want in
1590 * Turns off Mason's 'static_source' directive. By default, you can't
1591 edit RT's web ui components on the fly and have RT magically pick up
1592 your changes. (It's a big performance hit)
1598 Set($DevelMode, '0');
1603 =head1 Deprecated Options
1607 =item C<$AlwaysUseBase64>
1609 Encode blobs as base64 in DB (?)
1611 =item C<$TicketBaseURI>
1613 Base URI to tickets in this system; used when loading (?)
1615 =item C<$UseCodeTickets>
1617 This option is exists for backwards compatibility. Don't use it.