[Rt-commit] rt branch, 4.0/config-copyedit, updated. rt-4.0.0rc5-22-g789b382
Alex Vandiver
alexmv at bestpractical.com
Wed Mar 2 15:23:15 EST 2011
The branch, 4.0/config-copyedit has been updated
via 789b382cd157cd156ec9ffcf18fb08b9e885ff2c (commit)
via f18eb75f248651d39f76209d07732316986fcec0 (commit)
via b3668cf1b029116233fabd80216dbefcb2b4b1de (commit)
via a9aba21812b92e20053a06d3ba3b36c63fcb50c0 (commit)
from 0c825098e41841d16eb7dd2919937c2199e5c0fd (commit)
Summary of changes:
etc/RT_Config.pm.in | 2190 ++++++++++++++++++++++++++-------------------------
1 files changed, 1126 insertions(+), 1064 deletions(-)
- Log -----------------------------------------------------------------
commit a9aba21812b92e20053a06d3ba3b36c63fcb50c0
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Tue Mar 1 13:35:47 2011 -0500
Document which of AmbiguousDayInPast and ..InFuture takes precedence
This was determined by looking at the source of Time::ParseDate, which
doesn't actually document it itself.
diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 20bf5b0..41cdc90 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -1810,7 +1810,7 @@ default to the date for next March or last March?
Set C<$AmbiguousDayInPast> for the last date, or
C<$AmbiguousDayInFuture> for the next date; the default is usually
-correct.
+correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
=cut
commit b3668cf1b029116233fabd80216dbefcb2b4b1de
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Wed Mar 2 12:56:53 2011 -0500
Remove last remaining vestiges of inline tests, missed during the great purge of 3.7
diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 41cdc90..541e68e 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -10,12 +10,6 @@ package RT;
RT::Config
-=for testing
-
-use RT::Config;
-
-=cut
-
=head1 WARNING
NEVER EDIT RT_Config.pm.
commit f18eb75f248651d39f76209d07732316986fcec0
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Wed Mar 2 13:20:42 2011 -0500
"Never edit this" is not strictly documentation, and need not be in POD
It is also much more visible when formatted as a comment.
diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index 541e68e..b599b62 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -6,18 +6,20 @@
package RT;
+############################# WARNING #############################
+# #
+# NEVER EDIT RT_Config.pm ! #
+# #
+# Instead, copy any sections you want to change to #
+# F<RT_SiteConfig.pm> and edit them there. Otherwise, #
+# your changes will be lost when you upgrade RT. #
+# #
+############################# WARNING #############################
+
=head1 NAME
RT::Config
-=head1 WARNING
-
-NEVER EDIT RT_Config.pm.
-
-Instead, copy any sections you want to change to F<RT_SiteConfig.pm> and edit them there.
-
-=cut
-
=head1 Base Configuration
=over 4
commit 789b382cd157cd156ec9ffcf18fb08b9e885ff2c
Author: Alex Vandiver <alexmv at bestpractical.com>
Date: Wed Mar 2 14:44:26 2011 -0500
Reorder and regroup config entries, re-wrapping at 70 columns
diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index b599b62..9fc5e9d 100755
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -20,7 +20,7 @@ package RT;
RT::Config
-=head1 Base Configuration
+=head1 Base configuration
=over 4
@@ -37,52 +37,70 @@ otherwise, mail for existing tickets won't get put in the right place.
Set($rtname, "example.com");
+=item C<$Organization>
-=item C<$EmailSubjectTagRegex>
-
-This regexp controls what subject tags RT recognizes as its own.
-If you're not dealing with historical C<$rtname> values, you'll likely
-never have to change this configuration.
+You should set this to your organization's DNS domain. For example,
+I<fsck.com> or I<asylum.arkham.ma.us>. It is used by the linking
+interface to guarantee that ticket URIs are unique and easy to
+construct. Changing it after you have created tickets in the system
+will B<break> all existing ticket links!
-Be VERY CAREFUL with it. Note that it overrides C<$rtname> for subject
-token matching and that you should use only "non-capturing" parenthesis
-grouping. For example:
+=cut
-C<Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );>
+Set($Organization, "example.com");
-and NOT
+=item C<$CorrespondAddress>, C<$CommentAddress>
-C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
+RT is designed such that any mail which already has a ticket-id
+associated with it will get to the right place automatically.
-The setting below would make RT behave exactly as it does without the
-setting enabled.
+C<$CorrespondAddress> and C<$CommentAddress> are the default addresses
+that will be listed in From: and Reply-To: headers of correspondence
+and comment mail tracked by RT, unless overridden by a queue-specific
+address. They should be set to email addresses which have been
+configured as aliases for F<rt-mailgate>.
=cut
-# Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
+Set($CorrespondAddress, "");
+
+Set($CommentAddress, "");
+=item C<$WebDomain>
+Domain name of the RT server, e.g. 'www.example.com'. It should not
+contain anything except the server name.
-=item C<$Organization>
+=cut
-You should set this to your organization's DNS domain. For example,
-I<fsck.com> or I<asylum.arkham.ma.us>. It is used by the linking
-interface to guarantee that ticket URIs are unique and easy to
-construct. Changing it after you have created tickets in the system
-will B<break> all existing ticket links!
+Set($WebDomain, "localhost");
+
+=item C<$WebPort>
+
+If we're running as a superuser, run on port 80. Otherwise, pick a
+high port for this user.
+
+443 is default port for https protocol.
=cut
-Set($Organization, "example.com");
+Set($WebPort, 80);# + ($< * 7274) % 32766 + ($< && 1024));
-=item C<$MinimumPasswordLength>
+=item C<$WebPath>
-C<$MinimumPasswordLength> defines the minimum length for user
-passwords. Setting it to 0 disables this check.
+If you're putting the web UI somewhere other than at the root of your
+server, you should set C<$WebPath> to the path you'll be serving RT
+at.
+
+C<$WebPath> requires a leading / but no trailing /, or it can be
+blank.
+
+In most cases, you should leave C<$WebPath> set to '' (an empty
+value).
=cut
-Set($MinimumPasswordLength, 5);
+Set($WebPath, "");
=item C<$Timezone>
@@ -95,17 +113,33 @@ your server.
Set($Timezone, "US/Eastern");
+=item C<@Plugins>
+
+Set C<@Plugins> to a list of external RT plugins that should be
+enabled (those plugins have to be previously downloaded and
+installed).
+
+Example:
+
+C<Set(@Plugins, (qw(Extension::QuickDelete RT::Extension::CommandByMail)));>
+
+=cut
+
+Set(@Plugins, ());
+
=back
-=head1 Database Configuration
+
+
+
+=head1 Database connection
=over 4
=item C<$DatabaseType>
-Database driver being used; case matters.
-
-Valid types are "mysql", "Oracle" and "Pg"
+Database driver being used; case matters. Valid types are "mysql",
+"Oracle" and "Pg".
=cut
@@ -113,11 +147,11 @@ Set($DatabaseType, "@DB_TYPE@");
=item C<$DatabaseHost>, C<$DatabaseRTHost>
-The domain name of your database server. If you're running mysql and
+The domain name of your database server. If you're running MySQL and
on localhost, leave it blank for enhanced performance.
C<DatabaseRTHost> is the fully-qualified hostname of your RT server,
-for use in granting ACL rights on mysql.
+for use in granting ACL rights on MySQL.
=cut
@@ -153,7 +187,7 @@ Set($DatabasePassword, q{@DB_RT_PASS@});
=item C<$DatabaseName>
The name of the RT database on your database server. For Oracle, the
-SID and database objects are created in L<$DatabaseUser>'s schema.
+SID and database objects are created in C<$DatabaseUser>'s schema.
=cut
@@ -161,7 +195,7 @@ Set($DatabaseName, q{@DB_DATABASE@});
=item C<$DatabaseRequireSSL>
-If you're using Postgres and have compiled in SSL support, set
+If you're using PostgreSQL and have compiled in SSL support, set
C<$DatabaseRequireSSL> to 1 to turn on SSL communication with the
database.
@@ -169,41 +203,108 @@ database.
Set($DatabaseRequireSSL, undef);
-=item C<$UseSQLForACLChecks>
+=back
-Historically, ACLs were checked on display, which could lead to empty
-search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
-to limit search results in SQL instead, which eliminates these problems.
-This option is still relatively new; it may result in performance
-problems in some cases, or significant speedups in others.
+
+
+=head1 Logging
+
+The default is to log anything except debugging information to syslog.
+Check the L<Log::Dispatch> POD for information about how to get things
+by syslog, mail or anything else, get debugging info in the log, etc.
+
+It might generally make sense to send error and higher by email to
+some administrator. If you do this, be careful that this email isn't
+sent to this RT instance. Mail loops will generate a critical log
+message.
+
+=over 4
+
+=item C<$LogToSyslog>, C<$LogToScreen>
+
+The minimum level error that will be logged to the specific device.
+From lowest to highest priority, the levels are:
+
+ debug info notice warning error critical alert emergency
=cut
-Set($UseSQLForACLChecks, undef);
+Set($LogToSyslog, "info");
+Set($LogToScreen, "info");
-=item C<$TicketsItemMapSize>
+=item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
-On the display page of a ticket from search results, RT provides links
-to the first, next, previous and last ticket from the results. In
-order to build these links, RT needs to fetch the full result set from
-the database, which can be resource-intensive.
+Logging to a standalone file is also possible, but note that the file
+should needs to both exist and be writable by all direct users of the
+RT API. This generally includes the web server and whoever
+rt-crontool runs as. Note that rt-mailgate and the RT CLI go through
+the webserver, so their users do not need to have write permissions to
+this file. If you expect to have multiple users of the direct API,
+Best Practical recommends using syslog instead of direct file logging.
-Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
-to build these links. If the full result set is larger than this
-number, RT will omit the "last" link in the menu. Set this to zero to
-always examine all results.
+=cut
+
+Set($LogToFile, undef);
+Set($LogDir, q{@RT_LOG_PATH@});
+Set($LogToFileNamed, "rt.log"); #log to rt.log
+
+=item C<$LogStackTraces>
+
+If set to a log level then logging will include stack traces for
+messages with level equal to or greater than specified.
+
+NOTICE: Stack traces include parameters supplied to functions or
+methods. It is possible for stack trace logging to reveal sensitive
+information such as passwords or ticket content in your logs.
=cut
-Set($TicketsItemMapSize, 1000);
+Set($LogStackTraces, "");
+
+=item C<@LogToSyslogConf>
+
+On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
+override any other options RT passes to L<Log::Dispatch::Syslog>.
+Other interesting flags include facility and logopt. (See the
+L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
+ident too, if you have multiple RT installations.)
+
+=cut
+
+Set(@LogToSyslogConf, ());
=back
-=head1 Incoming Mail Gateway Configuration
+
+
+=head1 Incoming mail gateway
=over 4
+=item C<$EmailSubjectTagRegex>
+
+This regexp controls what subject tags RT recognizes as its own. If
+you're not dealing with historical C<$rtname> values, you'll likely
+never have to change this configuration.
+
+Be B<very careful> with it. Note that it overrides C<$rtname> for
+subject token matching and that you should use only "non-capturing"
+parenthesis grouping. For example:
+
+C<Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );>
+
+and NOT
+
+C<Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );>
+
+The setting below would make RT behave exactly as it does without the
+setting enabled.
+
+=cut
+
+# Set($EmailSubjectTagRegex, qr/\Q$rtname\E/i );
+
=item C<$OwnerEmail>
C<$OwnerEmail> is the address of a human who manages RT. RT will send
@@ -238,8 +339,8 @@ Set($StoreLoops, undef);
C<$MaxAttachmentSize> sets the maximum size (in bytes) of attachments
stored in the database.
-For mysql and oracle, we set this size to 10 megabytes. If you're
-running a Postgres version earlier than 7.1, you will need to drop
+For MySQL and Oracle, we set this size to 10 megabytes. If you're
+running a PostgreSQL version earlier than 7.1, you will need to drop
this to 8192. (8k)
=cut
@@ -266,19 +367,6 @@ takes priority over this.
Set($DropLongAttachments, undef);
-=item C<$ParseNewMessageForTicketCcs>
-
-If C<$ParseNewMessageForTicketCcs> is true, RT will attempt to divine
-Ticket 'Cc' watchers from the To and Cc lines of incoming messages.
-Be forewarned that if you have I<any> addresses which forward mail to
-RT automatically and you enable this option without modifying
-C<$RTAddressRegexp> below, you will get yourself into a heap of
-trouble.
-
-=cut
-
-Set($ParseNewMessageForTicketCcs, undef);
-
=item C<$RTAddressRegexp>
C<$RTAddressRegexp> is used to make sure RT doesn't add itself as a
@@ -303,15 +391,14 @@ Set($RTAddressRegexp, undef);
=item C<$CanonicalizeEmailAddressMatch>, C<$CanonicalizeEmailAddressReplace>
-RT provides functionality which allows the system to rewrite
-incoming email addresses. In its simplest form,
-you can substitute the value in C<CanonicalizeEmailAddressReplace>
-for the value in C<CanonicalizeEmailAddressMatch>
-(These values are passed to the C<CanonicalizeEmailAddress> subroutine in
- F<RT/User.pm>)
+RT provides functionality which allows the system to rewrite incoming
+email addresses. In its simplest form, you can substitute the value
+in C<CanonicalizeEmailAddressReplace> for the value in
+C<CanonicalizeEmailAddressMatch> (These values are passed to the
+C<CanonicalizeEmailAddress> subroutine in F<RT/User.pm>)
-By default, that routine performs a C<s/$Match/$Replace/gi> on any address
-passed to it.
+By default, that routine performs a C<s/$Match/$Replace/gi> on any
+address passed to it.
=cut
@@ -320,8 +407,8 @@ passed to it.
=item C<$CanonicalizeOnCreate>
-Set this to true and the create new user page will use the values that you
-enter in the form but use the function CanonicalizeUserInfo in
+Set this to true and the create new user page will use the values that
+you enter in the form but use the function CanonicalizeUserInfo in
F<RT/User_Local.pm>
=cut
@@ -330,9 +417,9 @@ Set($CanonicalizeOnCreate, 0);
=item C<$ValidateUserEmailAddresses>
-If C<$ValidateUserEmailAddresses> is true, RT will refuse to create users with
-an invalid email address (as specified in RFC 2822) or with an email address
-made of multiple email addresses.
+If C<$ValidateUserEmailAddresses> is true, RT will refuse to create
+users with an invalid email address (as specified in RFC 2822) or with
+an email address made of multiple email addresses.
=cut
@@ -340,8 +427,8 @@ Set($ValidateUserEmailAddresses, undef);
=item C<@MailPlugins>
-C<@MailPlugins> is a list of authentication plugins for L<RT::Interface::Email>
-to use; see L<rt-mailgate>
+C<@MailPlugins> is a list of authentication plugins for
+L<RT::Interface::Email> to use; see L<rt-mailgate>
=cut
@@ -357,8 +444,8 @@ resolve arbitrary tickets!
=item C<$ExtractSubjectTagMatch>, C<$ExtractSubjectTagNoMatch>
The default "extract remote tracking tags" scrip settings; these
-detect when your RT is talking to another RT, and adjust the
-subject accordingly.
+detect when your RT is talking to another RT, and adjust the subject
+accordingly.
=cut
@@ -369,7 +456,9 @@ Set($ExtractSubjectTagNoMatch, ( ${RT::EmailSubjectTagRegex}
=back
-=head1 Outgoing Mail Configuration
+
+
+=head1 Outgoing mail
=over 4
@@ -380,13 +469,13 @@ We know that 'sendmailpipe' works fairly well. If 'sendmailpipe'
doesn't work well for you, try 'sendmail'. Other options are 'smtp'
or 'qmail'.
-Note that you should remove the '-t' from C<$SendmailArguments>
-if you use 'sendmail' rather than 'sendmailpipe'
+Note that you should remove the '-t' from C<$SendmailArguments> if you
+use 'sendmail' rather than 'sendmailpipe'
-For testing purposes, or to simply disable sending mail out into the world, you
-can set C<$MailCommand> to 'testfile' which writes all mail to a temporary
-file. RT will log the location of the temporary file so you can extract mail
-from it afterwards.
+For testing purposes, or to simply disable sending mail out into the
+world, you can set C<$MailCommand> to 'testfile' which writes all mail
+to a temporary file. RT will log the location of the temporary file
+so you can extract mail from it afterward.
=cut
@@ -394,11 +483,11 @@ Set($MailCommand, "sendmailpipe");
=item C<$SetOutgoingMailFrom>
-C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the Correspond
-mail address of the ticket's queue.
+C<$SetOutgoingMailFrom> tells RT to set the sender envelope to the
+Correspond mail address of the ticket's queue.
-Warning: If you use this setting, bounced mails will appear to be incoming
-mail to the system, thus creating new tickets.
+Warning: If you use this setting, bounced mails will appear to be
+incoming mail to the system, thus creating new tickets.
=cut
@@ -424,17 +513,15 @@ Set($OverrideOutgoingMailFrom, {
# 'General' => 'general at rt.example.com',
});
-=back
-
=item C<$DefaultMailPrecedence>
-C<$DefaultMailPrecedence> is used to control the default
-Precedence level of outgoing mail where none is specified.
-By default it is C<bulk>, but if you only send mail to
-your staff, you may wish to change it.
+C<$DefaultMailPrecedence> is used to control the default Precedence
+level of outgoing mail where none is specified. By default it is
+C<bulk>, but if you only send mail to your staff, you may wish to
+change it.
-Note that you can set the precedence of individual templates
-by including an explicit Precedence header.
+Note that you can set the precedence of individual templates by
+including an explicit Precedence header.
If you set this value to C<undef> then we do not set a default
Precedence header to outgoing mail. However, if there already is a
@@ -444,14 +531,12 @@ Precedence header, it will be preserved.
Set($DefaultMailPrecedence, "bulk");
-=back
-
=item C<$DefaultErrorMailPrecedence>
C<$DefaultErrorMailPrecedence> is used to control the default
-Precedence level of outgoing mail that indicates some kind of
-error condition. By default it is C<bulk>, but if you only send
-mail to your staff, you may wish to change it.
+Precedence level of outgoing mail that indicates some kind of error
+condition. By default it is C<bulk>, but if you only send mail to your
+staff, you may wish to change it.
If you set this value to C<undef> then we do not add a Precedence
header to error mail.
@@ -460,391 +545,236 @@ header to error mail.
Set($DefaultErrorMailPrecedence, "bulk");
-=back
-
=item C<$UseOriginatorHeader>
C<$UseOriginatorHeader> is used to control the insertion of an
-RT-Originator Header in every outgoing mail, containing the
-mail address of the transaction creator.
+RT-Originator Header in every outgoing mail, containing the mail
+address of the transaction creator.
=cut
Set($UseOriginatorHeader, 1);
-=back
-
-=head1 Sendmail Configuration
+=item C<$UseFriendlyFromLine>
-These options only take effect if C<$MailCommand> is 'sendmail' or
-'sendmailpipe'
+By default, RT sets the outgoing mail's "From:" header to "SenderName
+via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
-=over 4
+=cut
-=item C<$SendmailArguments>
+Set($UseFriendlyFromLine, 1);
-C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
-If you picked 'sendmailpipe', you MUST add a -t flag to C<$SendmailArguments>
-These options are good for most sendmail wrappers and work-a-likes.
+=item C<$FriendlyFromLineFormat>
-These arguments are good for sendmail brand sendmail 8 and newer:
-C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
+C<sprintf()> format of the friendly 'From:' header; its arguments are
+SenderName and SenderEmailAddress.
=cut
-Set($SendmailArguments, "-oi -t");
+Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
+=item C<$UseFriendlyToLine>
-=item C<$SendmailBounceArguments>
+RT can optionally set a "Friendly" 'To:' header when sending messages
+to Ccs or AdminCcs (rather than having a blank 'To:' header.
-C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
-assuming RT needs to send an error (i.e. bounce).
+This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL. If you
+are using sendmail, rather than postfix, qmail, exim or some other
+MTA, you _must_ disable this option.
=cut
-Set($SendmailBounceArguments, '-f "<>"');
+Set($UseFriendlyToLine, 0);
-=item C<$SendmailPath>
+=item C<$FriendlyToLineFormat>
-If you selected 'sendmailpipe' above, you MUST specify the path to
-your sendmail binary in C<$SendmailPath>.
+C<sprintf()> format of the friendly 'To:' header; its arguments are
+WatcherType and TicketId.
=cut
-Set($SendmailPath, "/usr/sbin/sendmail");
-
+Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
-=back
+=item C<$NotifyActor>
-=head1 SMTP Configuration
+By default, RT doesn't notify the person who performs an update, as
+they already know what they've done. If you'd like to change this
+behavior, Set C<$NotifyActor> to 1
-These options only take effect if C<$MailCommand> is 'smtp'
+=cut
-=over 4
+Set($NotifyActor, 0);
-=item C<$SMTPServer>
+=item C<$RecordOutgoingEmail>
-C<$SMTPServer> should be set to the hostname of the SMTP server to use
+By default, RT records each message it sends out to its own internal
+database. To change this behavior, set C<$RecordOutgoingEmail> to 0
=cut
-Set($SMTPServer, undef);
-
-=item C<$SMTPFrom>
-
-C<$SMTPFrom> should be set to the 'From' address to use, if not the
-email's 'From'
+Set($RecordOutgoingEmail, 1);
-=cut
+=item C<$VERPPrefix>, C<$VERPDomain>
-Set($SMTPFrom, undef);
+Setting these options enables VERP support
+L<http://cr.yp.to/proto/verp.txt>.
-=item C<$SMTPDebug>
+Uncomment the following two directives to generate envelope senders
+of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
+(i.e. rt-jesse=fsck.com at rt.example.com ).
-C<$SMTPDebug> should be set to true to debug SMTP mail sending
+This currently only works with sendmail and sendmailpipe.
=cut
-Set($SMTPDebug, 0);
-
-=back
+# Set($VERPPrefix, "rt-");
+# Set($VERPDomain, $RT::Organization);
-=head1 Other Mailer Configuration
-=over 4
+=item C<$ForwardFromUser>
-=item C<@MailParams>
+By default, RT forwards a message using queue's address and adds RT's
+tag into subject of the outgoing message, so recipients' replies go
+into RT as correspondents.
-C<@MailParams> defines a list of options passed to $MailCommand if it
-is not 'sendmailpipe', 'sendmail', or 'smtp'
+To change this behavior, set C<$ForwardFromUser> to true value and RT
+will use address of the current user and leave subject without RT's
+tag.
=cut
-Set(@MailParams, ());
-
-=item C<$CorrespondAddress>, C<$CommentAddress>
-
-RT is designed such that any mail which already has a ticket-id associated
-with it will get to the right place automatically.
-
-C<$CorrespondAddress> and C<$CommentAddress> are the default addresses
-that will be listed in From: and Reply-To: headers of correspondence
-and comment mail tracked by RT, unless overridden by a queue-specific
-address.
+Set($ForwardFromUser, 0);
-=cut
+=back
-Set($CorrespondAddress, "");
+=head2 Email dashboards
-Set($CommentAddress, "");
+=over 4
=item C<$DashboardAddress>
-The email address from which RT will send dashboards. If none is set, then
-C<$OwnerEmail> will be used.
+The email address from which RT will send dashboards. If none is set,
+then C<$OwnerEmail> will be used.
=cut
Set($DashboardAddress, "");
-=item C<$UseFriendlyFromLine>
+=item C<$DashboardSubject>
-By default, RT sets the outgoing mail's "From:" header to
-"SenderName via RT". Setting C<$UseFriendlyFromLine> to 0 disables it.
+Lets you set the subject of dashboards. Arguments are the frequency (Daily,
+Weekly, Monthly) of the dashboard and the dashboard's name.
=cut
-Set($UseFriendlyFromLine, 1);
+Set($DashboardSubject, "%s Dashboard: %s");
-=item C<$FriendlyFromLineFormat>
+=item C<@EmailDashboardRemove>
-C<sprintf()> format of the friendly 'From:' header; its arguments
-are SenderName and SenderEmailAddress.
+A list of regular expressions that will be used to remove content from
+mailed dashboards.
=cut
-Set($FriendlyFromLineFormat, "\"%s via RT\" <%s>");
+Set(@EmailDashboardRemove, ());
-=item C<$UseFriendlyToLine>
+=back
-RT can optionally set a "Friendly" 'To:' header when sending messages to
-Ccs or AdminCcs (rather than having a blank 'To:' header.
-This feature DOES NOT WORK WITH SENDMAIL[tm] BRAND SENDMAIL
-If you are using sendmail, rather than postfix, qmail, exim or some other MTA,
-you _must_ disable this option.
-=cut
+=head2 Sendmail configuration
-Set($UseFriendlyToLine, 0);
-
-=item C<$FriendlyToLineFormat>
-
-C<sprintf()> format of the friendly 'To:' header; its arguments
-are WatcherType and TicketId.
-
-=cut
-
-Set($FriendlyToLineFormat, "\"%s of ". RT->Config->Get('rtname') ." Ticket #%s\":;");
-
-=item C<$NotifyActor>
-
-By default, RT doesn't notify the person who performs an update, as they
-already know what they've done. If you'd like to change this behavior,
-Set C<$NotifyActor> to 1
-
-=cut
-
-Set($NotifyActor, 0);
-
-=item C<$RecordOutgoingEmail>
-
-By default, RT records each message it sends out to its own internal database.
-To change this behavior, set C<$RecordOutgoingEmail> to 0
-
-=cut
-
-Set($RecordOutgoingEmail, 1);
-
-=item C<$VERPPrefix>, C<$VERPPrefix>
-
-VERP support (http://cr.yp.to/proto/verp.txt)
-
-Uncomment the following two directives to generate envelope senders
-of the form C<${VERPPrefix}${originaladdress}@${VERPDomain}>
-(i.e. rt-jesse=fsck.com at rt.example.com ).
-
-This currently only works with sendmail and sendmailpipe.
-
-=cut
-
-# Set($VERPPrefix, "rt-");
-# Set($VERPDomain, $RT::Organization);
+These options only take effect if C<$MailCommand> is 'sendmail' or
+'sendmailpipe'
+=over 4
-=item C<$ForwardFromUser>
+=item C<$SendmailArguments>
-By default, RT forwards a message using queue's address and adds RT's tag into
-subject of the outgoing message, so recipients' replies go into RT as correspondents.
+C<$SendmailArguments> defines what flags to pass to C<$SendmailPath>
+If you picked 'sendmailpipe', you MUST add a -t flag to
+C<$SendmailArguments> These options are good for most sendmail
+wrappers and work-a-likes.
-To change this behavior, set C<$ForwardFromUser> to true value and RT will use
-address of the current user and leave subject without RT's tag.
+These arguments are good for sendmail brand sendmail 8 and newer:
+C<Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");>
=cut
-Set($ForwardFromUser, 0);
+Set($SendmailArguments, "-oi -t");
-=item C<$ShowBccHeader>
-By default RT hides from the web UI information about blind copies user sent on
-reply or comment.
+=item C<$SendmailBounceArguments>
-To change this set the following option to true value.
+C<$SendmailBounceArguments> defines what flags to pass to C<$Sendmail>
+assuming RT needs to send an error (i.e. bounce).
=cut
-Set($ShowBccHeader, 0);
+Set($SendmailBounceArguments, '-f "<>"');
-=item C<$DashboardSubject>
+=item C<$SendmailPath>
-Lets you set the subject of dashboards. Arguments are the frequency (Daily,
-Weekly, Monthly) of the dashboard and the dashboard's name.
+If you selected 'sendmailpipe' above, you MUST specify the path to
+your sendmail binary in C<$SendmailPath>.
=cut
-Set($DashboardSubject, "%s Dashboard: %s");
-
-=item C<@EmailDashboardRemove>
-
-A list of regular expressions that will be used to remove content from mailed
-dashboards.
-
-=cut
+Set($SendmailPath, "/usr/sbin/sendmail");
-Set(@EmailDashboardRemove, ());
=back
-=head1 GnuPG Configuration
+=head2 SMTP configuration
-A full description of the (somewhat extensive) GnuPG integration can be found
-by running the command `perldoc L<RT::Crypt::GnuPG>` (or `perldoc
- lib/RT/Crypt/GnuPG.pm` from your RT install directory).
+These options only take effect if C<$MailCommand> is 'smtp'
=over 4
-=item C<%GnuPG>
-
-Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
-signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
-
-If you want to allow people to encrypt attachments inside the DB then
-set C<AllowEncryptDataInDB> to true.
-
-Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
-emails encrypted for key RT doesn't have and can not decrypt.
+=item C<$SMTPServer>
-Set C<RejectOnBadData> to false if you don't want to reject letters
-with incorrect GnuPG data.
+C<$SMTPServer> should be set to the hostname of the SMTP server to use
=cut
-Set(%GnuPG,
- Enable => @RT_GPG@,
- OutgoingMessagesFormat => "RFC", # Inline
- AllowEncryptDataInDB => 0,
-
- RejectOnMissingPrivateKey => 1,
- RejectOnBadData => 1,
-);
-
-=item C<%GnuPGOptions>
-
-Options of GnuPG program.
+Set($SMTPServer, undef);
-If you override this in your RT_SiteConfig, you should be sure
-to include a homedir setting.
+=item C<$SMTPFrom>
-NOTE that options with '-' character MUST be quoted.
+C<$SMTPFrom> should be set to the 'From' address to use, if not the
+email's 'From'
=cut
-Set(%GnuPGOptions,
- homedir => q{@RT_VAR_PATH@/data/gpg},
+Set($SMTPFrom, undef);
-# URL of a keyserver
-# keyserver => 'hkp://subkeys.pgp.net',
+=item C<$SMTPDebug>
-# enables the automatic retrieving of keys when encrypting
-# 'auto-key-locate' => 'keyserver',
+C<$SMTPDebug> should be set to true to debug SMTP mail sending
-# enables the automatic retrieving of keys when verifying signatures
-# 'auto-key-retrieve' => undef,
-);
+=cut
+Set($SMTPDebug, 0);
=back
-=head1 Logging Configuration
-
-The default is to log anything except debugging
-information to syslog. Check the L<Log::Dispatch> POD for
-information about how to get things by syslog, mail or anything
-else, get debugging info in the log, etc.
-
-It might generally make sense to send error and higher by email to
-some administrator. If you do this, be careful that this email
-isn't sent to this RT instance. Mail loops will generate a critical
-log message.
+=head2 Other mailers
=over 4
-=item C<$LogToSyslog>, C<$LogToScreen>
-
-The minimum level error that will be logged to the specific device.
-From lowest to highest priority, the levels are:
- debug info notice warning error critical alert emergency
-
-=cut
-
-Set($LogToSyslog, "info");
-Set($LogToScreen, "info");
-
-=item C<$LogToFile>, C<$LogDir>, C<$LogToFileNamed>
-
-Logging to a standalone file is also possible, but note that the
-file should needs to both exist and be writable by all direct users
-of the RT API. This generally includes the web server and whoever
-rt-crontool runs as. Note that rt-mailgate and the RT CLI go
-through the webserver, so their users do not need to have write
-permissions to this file. If you expect to have multiple users of
-the direct API, Best Practical recommends using syslog instead of
-direct file logging.
-
-=cut
-
-Set($LogToFile, undef);
-Set($LogDir, q{@RT_LOG_PATH@});
-Set($LogToFileNamed, "rt.log"); #log to rt.log
-
-=item C<$LogStackTraces>
-
-If set to a log level then logging will include stack traces for
-messages with level equal to or greater than specified.
-
-NOTICE: Stack traces include parameters supplied to functions or
-methods. It is possible for stack trace logging to reveal sensitive
-information such as passwords or ticket content in your logs.
-
-=cut
-
-Set($LogStackTraces, "");
-
-=item C<@LogToSyslogConf>
-
-On Solaris or UnixWare, set to ( socket => 'inet' ). Options here
-override any other options RT passes to L<Log::Dispatch::Syslog>.
-Other interesting flags include facility and logopt. (See the
-L<Log::Dispatch::Syslog> documentation for more information.) (Maybe
-ident too, if you have multiple RT installations.)
-
-=cut
-
-Set(@LogToSyslogConf, ());
-
-=item C<$StatementLog>,
+=item C<@MailParams>
-RT has rudimentary SQL statement logging support; simply set
-C<$StatementLog> to be the level that you wish SQL statements to be
-logged at.
+C<@MailParams> defines a list of options passed to $MailCommand if it
+is not 'sendmailpipe', 'sendmail', or 'smtp'
=cut
-Set($StatementLog, undef);
+Set(@MailParams, ());
=back
-=head1 Web Interface Configuration
+
+=head1 Web interface
=over 4
@@ -858,126 +788,134 @@ RT ships with several themes by default:
ballard Theme which doesn't rely on JavaScript for menuing
This value actually specifies a directory in F<share/html/NoAuth/css/>
-from which RT will try to load the file main.css (which should
- at import any other files the stylesheet needs). This allows you to
-easily and cleanly create your own stylesheets to apply to RT. This
-option can be overridden by users in their preferences.
+from which RT will try to load the file main.css (which should @import
+any other files the stylesheet needs). This allows you to easily and
+cleanly create your own stylesheets to apply to RT. This option can
+be overridden by users in their preferences.
=cut
Set($WebDefaultStylesheet, "aileron");
-=item C<$UsernameFormat>
+=item C<$DefaultQueue>
-This determines how user info is displayed. 'concise' will show one of
-either NickName, RealName, Name or EmailAddress, depending on what exists
-and whether the user is privileged or not. 'verbose' will show RealName and
-EmailAddress.
+Use this to select the default queue name that will be used for
+creating new tickets. You may use either the queue's name or its
+ID. This only affects the queue selection boxes on the web interface.
=cut
-Set($UsernameFormat, "concise");
+# Set($DefaultQueue, "General");
-=item C<$ShowMoreAboutPrivilegedUsers>
+=item C<$RememberDefaultQueue>
-This determines if the 'More about requestor' box on Ticket/Display.html is
-shown for Privileged Users.
+When a queue is selected in the new ticket dropdown, make it the new
+default for the new ticket dropdown.
=cut
-Set($ShowMoreAboutPrivilegedUsers, 0);
+# Set($RememberDefaultQueue, 1);
-=item C<$MoreAboutRequestorTicketList>
+=item C<$EnableReminders>
-This can be set to Active, Inactive, All or None. It controls what ticket
-list will be displayed in the 'More about requestor' box on Ticket/Display.html.
-This option can be controlled by users also.
+Hide all links and portlets related to Reminders by setting this to 0
=cut
-Set($MoreAboutRequestorTicketList, "Active");
+Set($EnableReminders, 1);
-=item C<$MoreAboutRequestorExtraInfo>
+=item C<@CustomFieldValuesSources>
-By default, the 'More about requestor' box on Ticket/Display.html shows
-the Requestor's name and ticket list. If you would like to see extra information
-about the user, this expects a Format string of user attributes. Please note that
-not all the attributes are supported in this display because we're not building a table.
+Set C<@CustomFieldValuesSources> to a list of class names which extend
+L<RT::CustomFieldValues::External>. This can be used to pull lists of
+custom field values from external sources at runtime.
=cut
-Set($MoreAboutRequestorExtraInfo, "");
-
-=item C<$MoreAboutRequestorGroupsLimit>
+Set(@CustomFieldValuesSources, ());
-By default, the 'More about requestor' box on Ticket/Display.html
-shows all the groups of the Requestor. Use this to limit the number
-of groups; a value of undef removes the group display entirely.
+=item C<$CanonicalizeRedirectURLs>
-e.g.
+Set C<$CanonicalizeRedirectURLs> to 1 to use $C<WebURL> when
+redirecting rather than the one we get from C<%ENV>.
-Set($MoreAboutRequestorGroupsLimit, 10);
+If you use RT behind a reverse proxy, you almost certainly want to
+enable this option.
=cut
-Set($MoreAboutRequestorGroupsLimit, 0);
+Set($CanonicalizeRedirectURLs, 0);
-=item C<$AutocompleteOwners>
+=item C<@JSFiles>
-If true, the owner dropdowns for ticket update/modify and the query builder are
-replaced by text fields that autocomplete. This can alleviate the sometimes
-huge owner list for installations where many users have the OwnTicket right.
+A list of JavaScript files to be included in head. Removing any of
+the default entries is not suggested.
=cut
-Set($AutocompleteOwners, 0);
+Set(@JSFiles, qw/
+ jquery-1.4.2.min.js
+ jquery_noconflict.js
+ jquery-ui-1.8.4.custom.min.js
+ jquery.tablesorter.min.js
+ jquery-ui-patch-datepicker.js
+ ui.timepickr.js
+ titlebox-state.js
+ util.js
+ userautocomplete.js
+ jquery.event.hover-1.0.js
+ superfish.js
+ supersubs.js
+ jquery.supposition.js
+ history-folding.js
+ late.js
+/);
-=item C<$WebDomain>
+=item C<$JSMinPath>
-Domain name of the RT server, e.g. 'www.example.com'. It should not contain
-anything else, but server name.
+Path to the jsmin binary, available from
+http://www.crockford.com/javascript/jsmin.html
-=cut
+If specified, it will be used to minify C<JSFiles>. If it cannot be
+found, RT will fall back to the L<JavaScript::Minifier> module;
+failing that, RT will will simply concatenate the files.
-Set($WebDomain, "localhost");
+=cut
-=item C<$WebPort>
+# Set($JSMinPath, "/path/to/jsmin");
-If we're running as a superuser, run on port 80
-Otherwise, pick a high port for this user.
+=item C<@CSSFiles>
-443 is default port for https protocol.
+A list of additional CSS files to be included in head.
=cut
-Set($WebPort, 80);# + ($< * 7274) % 32766 + ($< && 1024));
-
-=item C<$WebPath>
-
-If you're putting the web UI somewhere other than at the root of
-your server, you should set C<$WebPath> to the path you'll be
-serving RT at.
+Set(@CSSFiles, qw//);
-C<$WebPath> requires a leading / but no trailing /, or it can be blank.
+=item C<$UsernameFormat>
-In most cases, you should leave C<$WebPath> set to '' (an empty value).
+This determines how user info is displayed. 'concise' will show one of
+either NickName, RealName, Name or EmailAddress, depending on what
+exists and whether the user is privileged or not. 'verbose' will show
+RealName and EmailAddress.
=cut
-Set($WebPath, "");
+Set($UsernameFormat, "concise");
=item C<$WebBaseURL>, C<$WebURL>
-Usually you don't want to set these options. The only obvious reason is if
-RT is accessible via https protocol on a non standard port, e.g.
-'https://rt.example.com:9999'. In all other cases these options are computed
-using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
+Usually you don't want to set these options. The only obvious reason
+is if RT is accessible via https protocol on a non standard port, e.g.
+'https://rt.example.com:9999'. In all other cases these options are
+computed using C<$WebDomain>, C<$WebPort> and C<$WebPath>.
-C<$WebBaseURL> is the scheme, server and port (e.g. 'http://rt.example.com')
-for constructing URLs to the web UI. C<$WebBaseURL> doesn't need a trailing /.
+C<$WebBaseURL> is the scheme, server and port
+(e.g. 'http://rt.example.com') for constructing URLs to the web
+UI. C<$WebBaseURL> doesn't need a trailing /.
-C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for example:
-'http://www.example.com/rt/'.
+C<$WebURL> is the C<$WebBaseURL>, C<$WebPath> and trailing /, for
+example: 'http://www.example.com/rt/'.
=cut
@@ -993,8 +931,7 @@ Set($WebURL, RT->Config->Get('WebBaseURL') . RT->Config->Get('WebPath') . "/");
=item C<$WebImagesURL>
C<$WebImagesURL> points to the base URL where RT can find its images.
-Define the directory name to be used for images in RT web
-documents.
+Define the directory name to be used for images in RT web documents.
=cut
@@ -1056,567 +993,609 @@ Set($WebNoAuthRegex, qr{^ (?:/+NoAuth/ | /+REST/\d+\.\d+/NoAuth/) }x );
=item C<$SelfServiceRegex>
-What portion of RT's URLspace should be accessible to Unprivileged users
-This does not override the redirect from F</Ticket/Display.html> to
-F</SelfService/Display.html> when Unprivileged users attempt to access
-ticked displays.
+What portion of RT's URLspace should be accessible to Unprivileged
+users This does not override the redirect from F</Ticket/Display.html>
+to F</SelfService/Display.html> when Unprivileged users attempt to
+access ticked displays.
=cut
Set($SelfServiceRegex, qr!^(?:/+SelfService/)!x );
-=item C<$UseSideBySideLayout>
+=item C<$WebFlushDbCacheEveryRequest>
-Should the ticket create and update forms use a more space efficient
-two column layout. This layout may not work in narrow browsers if you
-set a MessageBoxWidth (below).
+By default, RT clears its database cache after every page view. This
+ensures that you've always got the most current information when
+working in a multi-process (mod_perl or FastCGI) Environment. Setting
+C<$WebFlushDbCacheEveryRequest> to '0' will turn this off, which will
+speed RT up a bit, at the expense of a tiny bit of data accuracy.
=cut
-Set($UseSideBySideLayout, 1);
-
-=item C<$MessageBoxWidth>, C<$MessageBoxHeight>
+Set($WebFlushDbCacheEveryRequest, 1);
-For message boxes, set the entry box width, height and what type of
-wrapping to use. These options can be overridden by users in their
-preferences.
+=item C<%ChartFont>
-When the width is set to undef, no column count is specified and the
-message box will take up 100% of the available width. Combining this
-with HARD messagebox wrapping (below) is not recommended, as it will
-lead to inconsistent width in transactions between browsers.
+The L<GD> module (which RT uses for graphs) ships with a built-in font
+that doesn't have full Unicode support. You can use a given TrueType
+font for a specific language by setting %ChartFont to (language =E<gt>
+the absolute path of a font) pairs. Your GD library must have support
+for TrueType fonts to use this option. If there is no entry for a
+language in the hash then font with 'others' key is used.
-These settings only apply to the non-RichText message box.
-See below for Rich Text settings.
+RT comes with two TrueType fonts covering most available languages.
=cut
-Set($MessageBoxWidth, undef);
-Set($MessageBoxHeight, 15);
-
-=item C<$MessageBoxWrap>
-
-Wrapping is disabled when using MessageBoxRichText because
-of a bad interaction between IE and wrapping with the Rich
-Text Editor.
-
-=cut
+Set(
+ %ChartFont,
+ 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
+ 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
+ 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
+ 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
+);
-Set($MessageBoxWrap, "SOFT");
+=item C<$ChartsTimezonesInDB>
-=item C<$MessageBoxRichText>
+RT stores dates using the UTC timezone in the DB, so charts grouped by
+dates and time are not representative. Set C<$ChartsTimezonesInDB> to
+a true value to enable timezone conversions using your DB's
+capabilities. You may need to do some work on the DB side to use this
+feature, read more in F<docs/timezones_in_charts.pod>.
-Should "rich text" editing be enabled? This option lets your users
-send HTML email messages from the web interface.
+At this time, this feature only applies to MySQL and PostgreSQL.
=cut
-Set($MessageBoxRichText, 1);
+Set($ChartsTimezonesInDB, 0);
-=item C<$MessageBoxRichTextHeight>
+=back
-Height of rich text JavaScript enabled editing boxes (in pixels)
-=cut
-Set($MessageBoxRichTextHeight, 200);
+=head2 Home page
-=item C<$MessageBoxIncludeSignature>
+=over 4
-Should your users' signatures (from their Preferences page) be
-included in Comments and Replies.
+=item C<$DefaultSummaryRows>
+
+C<$DefaultSummaryRows> is default number of rows displayed in for
+search results on the front page.
=cut
-Set($MessageBoxIncludeSignature, 1);
+Set($DefaultSummaryRows, 10);
-=item C<$MessageBoxIncludeSignatureOnComment>
+=item C<$HomePageRefreshInterval>
-Should your users' signatures (from their Preferences page) be
-included in Comments. Setting this to false overrides
-C<$MessageBoxIncludeSignature>.
+C<$HomePageRefreshInterval> is default number of seconds to refresh
+the RT home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
=cut
-Set($MessageBoxIncludeSignatureOnComment, 1);
+Set($HomePageRefreshInterval, 0);
-=item C<$WikiImplicitLinks>
+=item C<$HomepageComponents>
-Support implicit links in WikiText custom fields? A true value
-causes InterCapped or ALLCAPS words in WikiText fields to
-automatically become links to searches for those words. If used on
-Articles, it links to the Article with that name.
+C<$HomepageComponents> is an arrayref of allowed components on a
+user's customized homepage ("RT at a glance").
=cut
-Set($WikiImplicitLinks, 0);
-
-=item C<$TrustHTMLAttachments>
+Set($HomepageComponents, [qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
-If C<TrustHTMLAttachments> is not defined, we will display them
-as text. This prevents malicious HTML and JavaScript from being
-sent in a request (although there is probably more to it than that)
+=back
-=cut
-Set($TrustHTMLAttachments, undef);
-=item C<$AlwaysDownloadAttachments>
-Always download attachments, regardless of content type. If set,
-this overrides C<TrustHTMLAttachments>.
+=head2 Ticket search
-=cut
+=over 4
-Set($AlwaysDownloadAttachments, undef);
+=item C<$UseSQLForACLChecks>
-=item C<$AttachmentUnits>
+Historically, ACLs were checked on display, which could lead to empty
+search pages and wrong ticket counts. Set C<$UseSQLForACLChecks> to 1
+to limit search results in SQL instead, which eliminates these
+problems.
-Controls the units (kilobytes or bytes) that attachment sizes use
-for display. The default is to display kilobytes if the attachment
-is larger than 1024 bytes, bytes otherwise. If you set
-C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
-displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
+This option is still relatively new; it may result in performance
+problems in some cases, or significant speedups in others.
=cut
-Set($AttachmentUnits, undef);
+Set($UseSQLForACLChecks, undef);
-=item C<$EditCustomFieldsSingleColumn>
+=item C<$TicketsItemMapSize>
+
+On the display page of a ticket from search results, RT provides links
+to the first, next, previous and last ticket from the results. In
+order to build these links, RT needs to fetch the full result set from
+the database, which can be resource-intensive.
-When displaying a list of Ticket Custom Fields for editing, RT defaults
-to a 2 column list. If you set this to 1, it will instead display the
-Custom Fields in a single column.
+Set C<$TicketsItemMapSize> to number of tickets you want RT to examine
+to build these links. If the full result set is larger than this
+number, RT will omit the "last" link in the menu. Set this to zero to
+always examine all results.
=cut
-Set($EditCustomFieldsSingleColumn, 0);
+Set($TicketsItemMapSize, 1000);
-=item C<$RedistributeAutoGeneratedMessages>
+=item C<$SearchResultsRefreshInterval>
-Should RT redistribute correspondence that it identifies as
-machine generated? A true value will do so; setting this to '0'
-will cause no such messages to be redistributed.
-You can also use 'privileged' (the default), which will redistribute
-only to privileged users. This helps to protect against malformed
-bounces and loops caused by auto-created requestors with bogus addresses.
+C<$SearchResultsRefreshInterval> is default number of seconds to
+refresh search results in RT. Choose from [0, 120, 300, 600, 1200,
+3600, 7200].
=cut
-Set($RedistributeAutoGeneratedMessages, "privileged");
+Set($SearchResultsRefreshInterval, 0);
-=item C<$PreferRichText>
+=item C<$DefaultSearchResultFormat>
-If C<$PreferRichText> is set to a true value, RT will show HTML/Rich text
-messages in preference to their plain-text alternatives. RT "scrubs" the
-HTML to show only a minimal subset of HTML to avoid possible contamination
-by cross-site-scripting attacks.
+C<$DefaultSearchResultFormat> is the default format for RT search
+results
=cut
-Set($PreferRichText, undef);
+Set ($DefaultSearchResultFormat, qq{
+ '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
+ '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
+ Status,
+ QueueName,
+ OwnerName,
+ Priority,
+ '__NEWLINE__',
+ '',
+ '<small>__Requestors__</small>',
+ '<small>__CreatedRelative__</small>',
+ '<small>__ToldRelative__</small>',
+ '<small>__LastUpdatedRelative__</small>',
+ '<small>__TimeLeft__</small>'});
-=item C<$WebExternalAuth>
+=item C<$DefaultSelfServiceSearchResultFormat>
-If C<$WebExternalAuth> is defined, RT will defer to the environment's
-REMOTE_USER variable.
+C<$DefaultSelfServiceSearchResultFormat> is the default format of
+searches displayed in the SelfService interface.
=cut
-Set($WebExternalAuth, undef);
+Set($DefaultSelfServiceSearchResultFormat, qq{
+ '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
+ '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
+ Status,
+ Requestors,
+ OwnerName});
-=item C<$WebExternalAuthContinuous>
+=item C<%FullTextSearch>
-If C<$WebExternalAuthContinuous> is defined, RT will check for the
-REMOTE_USER on each access. If you would prefer this to only happen
-once (at initial login) set this to a false value. The default setting
-will help ensure that if your external authentication system deauthenticates a
-user, RT notices as soon as possible.
+Full text search (FTS) without indexes is a very slow operation and by
+default is disabled at all. To enable FTS set key 'Enable' to true
+value.
+
+Setup of indexes and filling them with data requires additional steps
+that vary from DB to DB. Use F<sbin/rt-setup-fulltext-index> helper
+for quick start. This script creates required structures in the DB and
+gives some ideas on next steps. Use F<sbin/rt-fulltext-indexer> to
+keep the index in sync.
=cut
-Set($WebExternalAuthContinuous, 1);
+Set(%FullTextSearch,
+ Enable => 0,
+ Indexed => 0,
+# Table => 'AttachmentsIndex',
+# Column => 'ftsindex',
+);
-=item C<$WebFallbackToInternalAuth>
-If C<$WebFallbackToInternalAuth> is defined, the user is allowed a chance
-of fallback to the login screen, even if REMOTE_USER failed.
+=item C<$DontSearchFileAttachments>
+
+If C<$DontSearchFileAttachments> is set to a true value, then uploaded
+files (attachments with file names) are not searched during
+full-content ticket searches.
=cut
-Set($WebFallbackToInternalAuth, undef);
+Set($DontSearchFileAttachments, undef);
-=item C<$WebExternalGecos>
+=item C<$OnlySearchActiveTicketsInSimpleSearch>
-C<$WebExternalGecos> means to match 'gecos' field as the user identity);
-useful with mod_auth_pwcheck and IIS Integrated Windows logon.
+When query in simple search doesn't have status info, use this to only
+search active ones.
=cut
-Set($WebExternalGecos, undef);
+Set($OnlySearchActiveTicketsInSimpleSearch, 1);
-=item C<$WebExternalAuto>
+=item C<$SearchResultsAutoRedirect>
-C<$WebExternalAuto> will create users under the same name as REMOTE_USER
-upon login, if it's missing in the Users table.
+When only one ticket is found in search, use this to redirect to the
+ticket display page automatically.
=cut
-Set($WebExternalAuto, undef);
+Set($SearchResultsAutoRedirect, 0);
-=item C<$AutoCreate>
+=back
-If C<$WebExternalAuto> is true, C<$AutoCreate> will be passed to User's
-Create method. Use it to set defaults, such as creating
-Unprivileged users with C<{ Privileged => 0 }>
-( Must be a hashref of arguments )
-=cut
-Set($AutoCreate, undef);
+=head2 Ticket display
-=item C<$WebSessionClass>
+=over 4
+
+=item C<$ShowMoreAboutPrivilegedUsers>
-C<$WebSessionClass> is the class you wish to use for managing Sessions.
-It defaults to use your SQL database, but if you are using MySQL 3.x and
-plans to use non-ascii Queue names, uncomment and add this line to
-F<RT_SiteConfig.pm> to prevent session corruption.
+This determines if the 'More about requestor' box on
+Ticket/Display.html is shown for Privileged Users.
=cut
-# Set($WebSessionClass, "Apache::Session::File");
+Set($ShowMoreAboutPrivilegedUsers, 0);
-=item C<$AutoLogoff>
+=item C<$MoreAboutRequestorTicketList>
-By default, RT's user sessions persist until a user closes his or her
-browser. With the C<$AutoLogoff> option you can setup session lifetime in
-minutes. A user will be logged out if he or she doesn't send any requests
-to RT for the defined time.
+This can be set to Active, Inactive, All or None. It controls what
+ticket list will be displayed in the 'More about requestor' box on
+Ticket/Display.html. This option can be controlled by users also.
=cut
-Set($AutoLogoff, 0);
+Set($MoreAboutRequestorTicketList, "Active");
-=item C<$LogoutRefresh>
+=item C<$MoreAboutRequestorExtraInfo>
-The number of seconds to wait after logout before sending the user to the
-login page. By default, 1 second, though you may want to increase this if
-you display additional information on the logout page.
+By default, the 'More about requestor' box on Ticket/Display.html
+shows the Requestor's name and ticket list. If you would like to see
+extra information about the user, this expects a Format string of user
+attributes. Please note that not all the attributes are supported in
+this display because we're not building a table.
=cut
-Set($LogoutRefresh, 1);
+Set($MoreAboutRequestorExtraInfo, "");
-=item C<$WebSecureCookies>
+=item C<$MoreAboutRequestorGroupsLimit>
-By default, RT's session cookie isn't marked as "secure" Some web
-browsers will treat secure cookies more carefully than non-secure
-ones, being careful not to write them to disk, only sendine them over
-an SSL secured connection, and so on. To enable this behaviour, set
-C<$WebSecureCookies> to a true value. NOTE: You probably don't want
-to turn this on I<unless> users are only connecting via SSL encrypted
-HTTPS connections.
+By default, the 'More about requestor' box on Ticket/Display.html
+shows all the groups of the Requestor. Use this to limit the number
+of groups; a value of undef removes the group display entirely.
=cut
-Set($WebSecureCookies, 0);
+Set($MoreAboutRequestorGroupsLimit, 0);
-=item C<$WebFlushDbCacheEveryRequest>
+=item C<$UseSideBySideLayout>
-By default, RT clears its database cache after every page view.
-This ensures that you've always got the most current information
-when working in a multi-process (mod_perl or FastCGI) Environment.
-Setting C<$WebFlushDbCacheEveryRequest> to '0' will turn this off,
-which will speed RT up a bit, at the expense of a tiny bit of data
-accuracy.
+Should the ticket create and update forms use a more space efficient
+two column layout. This layout may not work in narrow browsers if you
+set a MessageBoxWidth (below).
=cut
-Set($WebFlushDbCacheEveryRequest, 1);
-
+Set($UseSideBySideLayout, 1);
-=item C<$MaxInlineBody>
+=item C<$EditCustomFieldsSingleColumn>
-C<$MaxInlineBody> is the maximum attachment size that we want to see
-inline when viewing a transaction. RT will inline any text if the
-value is undefined or 0. This option can be overridden by users in
-their preferences.
+When displaying a list of Ticket Custom Fields for editing, RT
+defaults to a 2 column list. If you set this to 1, it will instead
+display the Custom Fields in a single column.
=cut
-Set($MaxInlineBody, 12000);
+Set($EditCustomFieldsSingleColumn, 0);
-=item C<$DefaultSummaryRows>
+=item C<$ShowUnreadMessageNotifications>
-C<$DefaultSummaryRows> is default number of rows displayed in for search
-results on the front page.
+If set to a true value, RT will prompt users when there are new,
+unread messages on tickets they are viewing.
=cut
-Set($DefaultSummaryRows, 10);
+Set($ShowUnreadMessageNotifications, 0);
-=item C<$HomePageRefreshInterval>
+=item C<$AutocompleteOwners>
-C<$HomePageRefreshInterval> is default number of seconds to refresh the RT
-home page. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
+If true, the owner drop-downs for ticket update/modify and the query
+builder are replaced by text fields that autocomplete. This can
+alleviate the sometimes huge owner list for installations where many
+users have the OwnTicket right.
=cut
-Set($HomePageRefreshInterval, 0);
+Set($AutocompleteOwners, 0);
-=item C<$SearchResultsRefreshInterval>
+=item C<$UserAutocompleteFields>
-C<$SearchResultsRefreshInterval> is default number of seconds to refresh
-search results in RT. Choose from [0, 120, 300, 600, 1200, 3600, 7200].
+Specifies which fields of L<RT::User> to match against and how to
+match each field when autocompleting users. Valid match methods are
+LIKE, STARTSWITH, ENDSWITH, =, and !=.
+
+Not all User fields are publicly accessible and hence won't work for
+autocomplete unless you override their accessibility using a local
+overlay or a plugin. Out of the box the following fields are public:
+Name, EmailAddress, RealName, NickName, and Organization.
=cut
-Set($SearchResultsRefreshInterval, 0);
+Set($UserAutocompleteFields, {
+ EmailAddress => 'STARTSWITH',
+ Name => 'STARTSWITH',
+ RealName => 'LIKE',
+});
-=item C<$ResolveDefaultUpdateType>
+=item C<$AllowUserAutocompleteForUnprivileged>
-This option has been deprecated. You can configure this site-wide with L<%Lifecycles>
+Should unprivileged users be allowed to autocomplete users. Setting
+this option to a true value means unprivileged users will be able to
+search all your users.
=cut
-=item C<$OldestTransactionsFirst>
+Set($AllowUserAutocompleteForUnprivileged, 0);
-By default, RT shows newest transactions at the bottom of the ticket
-history page, if you want see them at the top set this to '0'. This
-option can be overridden by users in their preferences.
+=item C<$DisplayTicketAfterQuickCreate>
+
+Enable this to redirect to the created ticket display page
+automatically when using QuickCreate.
=cut
-Set($OldestTransactionsFirst, 1);
+Set($DisplayTicketAfterQuickCreate, 0);
-=item C<$DeferTransactionLoading>
+=item C<$WikiImplicitLinks>
-When set, defers loading ticket history until the user clicks a link.
-This should end up serving pages to users quicker, since generating
-all the HTML for transaction history can be slow for long tickets.
+Support implicit links in WikiText custom fields? A true value causes
+InterCapped or ALLCAPS words in WikiText fields to automatically
+become links to searches for those words. If used on Articles, it
+links to the Article with that name.
=cut
-# Set($DeferTransactionLoading, 1);
+Set($WikiImplicitLinks, 0);
-=item C<$ShowTransactionImages>
+=item C<$PreviewScripMessages>
-By default, RT shows images attached to incoming (and outgoing) ticket updates
-inline. Set this variable to 0 if you'd like to disable that behaviour
+Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
+reply page should include the content of the messages to be sent.
=cut
-Set($ShowTransactionImages, 1);
+Set($PreviewScripMessages, 0);
-=item C<$PlainTextPre>
+=back
-Normally plaintext attachments are displayed as HTML with line breaks
-preserved. This causes space- and tab-based formatting not to be
-displayed correctly. By setting $PlainTextPre messages will be
-displayed using <pre>; this option overrides C<$PlainTextMono>.
-=cut
-Set($PlainTextPre, 0);
+=head2 Articles
+=over 4
-=item C<$PlainTextMono>
+=item C<$ArticleOnTicketCreate>
-Set C<$PlainTextMono> to 1 to use monospaced font and preserve
-formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
-of the browser window.
+Set this to 1 to display the Articles interface on the Ticket Create
+page in addition to the Reply/Comment page.
=cut
-Set($PlainTextMono, 0);
-
-=item C<$ShowUnreadMessageNotifications>
+Set($ArticleOnTicketCreate, 0);
-RT will prompt users when there are new, unread messages on tickets they are viewing.
+=item C<$HideArticleSearchOnReplyCreate>
-Set C<$ShowUnreadMessageNotifications> to a true value to enable this feature.
+Set this to 1 to hide the search and include boxes from the Article
+UI. This assumes you have enabled Article Hotlist feature, otherwise
+you will have no access to Articles.
=cut
-Set($ShowUnreadMessageNotifications, 0);
+Set($HideArticleSearchOnReplyCreate, 0);
+=back
-=item C<$HomepageComponents>
-C<$HomepageComponents> is an arrayref of allowed components on a user's
-customized homepage ("RT at a glance").
-=cut
+=head2 Message box properties
-Set($HomepageComponents, [qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders RefreshHomepage Dashboards SavedSearches)]);
+=over 4
-=item C<@MasonParameters>
+=item C<$MessageBoxWidth>, C<$MessageBoxHeight>
-C<@MasonParameters> is the list of parameters for the constructor of
-HTML::Mason's Apache or CGI Handler. This is normally only useful
-for debugging, e.g. profiling individual components with:
+For message boxes, set the entry box width, height and what type of
+wrapping to use. These options can be overridden by users in their
+preferences.
- use MasonX::Profiler; # available on CPAN
- Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
+When the width is set to undef, no column count is specified and the
+message box will take up 100% of the available width. Combining this
+with HARD messagebox wrapping (below) is not recommended, as it will
+lead to inconsistent width in transactions between browsers.
+
+These settings only apply to the non-RichText message box. See below
+for Rich Text settings.
=cut
-Set(@MasonParameters, ());
+Set($MessageBoxWidth, undef);
+Set($MessageBoxHeight, 15);
-=item C<$DefaultSearchResultFormat>
+=item C<$MessageBoxWrap>
-C<$DefaultSearchResultFormat> is the default format for RT search results
+Wrapping is disabled when using MessageBoxRichText because of a bad
+interaction between IE and wrapping with the Rich Text Editor.
=cut
-Set ($DefaultSearchResultFormat, qq{
- '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__id__</a></B>/TITLE:#',
- '<B><A HREF="__WebPath__/Ticket/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
- Status,
- QueueName,
- OwnerName,
- Priority,
- '__NEWLINE__',
- '',
- '<small>__Requestors__</small>',
- '<small>__CreatedRelative__</small>',
- '<small>__ToldRelative__</small>',
- '<small>__LastUpdatedRelative__</small>',
- '<small>__TimeLeft__</small>'});
+Set($MessageBoxWrap, "SOFT");
-=item C<$DefaultSelfServiceSearchResultFormat>
+=item C<$MessageBoxRichText>
-C<$DefaultSelfServiceSearchResultFormat> is the default format of searches displayed in the
-SelfService interface.
+Should "rich text" editing be enabled? This option lets your users
+send HTML email messages from the web interface.
=cut
-Set($DefaultSelfServiceSearchResultFormat, qq{
- '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__id__</a></B>/TITLE:#',
- '<B><A HREF="__WebPath__/SelfService/Display.html?id=__id__">__Subject__</a></B>/TITLE:Subject',
- Status,
- Requestors,
- OwnerName});
+Set($MessageBoxRichText, 1);
-=item C<%AdminSearchResultFormat>
+=item C<$MessageBoxRichTextHeight>
-In the admin interface, format strings similar to tickets result
-formats are used. Use C<%AdminSearchResultFormat> to define the format
-strings used in the admin interface on a per-RT-class basis.
+Height of rich text JavaScript enabled editing boxes (in pixels)
=cut
-Set(%AdminSearchResultFormat,
- Queues =>
- q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
- .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__},
+Set($MessageBoxRichTextHeight, 200);
- Groups =>
- q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
- .q{,'__Description__'},
+=item C<$MessageBoxIncludeSignature>
- Users =>
- q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
- .q{,__RealName__, __EmailAddress__},
+Should your users' signatures (from their Preferences page) be
+included in Comments and Replies.
- CustomFields =>
- q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
- .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
+=cut
- Scrips =>
- q{'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
- .q{,__Stage__, __Condition__, __Action__, __Template__},
+Set($MessageBoxIncludeSignature, 1);
- Templates =>
- q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
- .q{,'__Description__'},
- Classes =>
- q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
- .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
- .q{,__Description__},
-);
+=item C<$MessageBoxIncludeSignatureOnComment>
-=item C<$SuppressInlineTextFiles>
+Should your users' signatures (from their Preferences page) be
+included in Comments. Setting this to false overrides
+C<$MessageBoxIncludeSignature>.
-If C<$SuppressInlineTextFiles> is set to a true value, then uploaded
-text files (text-type attachments with file names) are prevented
-from being displayed in-line when viewing a ticket's history.
+=cut
+
+Set($MessageBoxIncludeSignatureOnComment, 1);
+
+=back
+
+
+=head2 Transaction display
+
+=over 4
+
+=item C<$OldestTransactionsFirst>
+
+By default, RT shows newest transactions at the bottom of the ticket
+history page, if you want see them at the top set this to '0'. This
+option can be overridden by users in their preferences.
=cut
-Set($SuppressInlineTextFiles, undef);
+Set($OldestTransactionsFirst, 1);
-=item C<%FullTextSearch>
+=item C<$DeferTransactionLoading>
-Full text search (FTS) without indexes is a very slow operation and by
-default is disabled at all. To enable FTS set key 'Enable' to true value.
+When set, defers loading ticket history until the user clicks a link.
+This should end up serving pages to users quicker, since generating
+all the HTML for transaction history can be slow for long tickets.
-Setup of indexes and filling them with data requires additional steps that
-vary from DB to DB. Use F<sbin/rt-setup-fulltext-index> helper
-for quick start. This script creates required structures in the DB and
-gives some ideas on next steps. Use F<sbin/rt-fulltext-indexer> to keep
-the index in sync.
+=cut
+
+# Set($DeferTransactionLoading, 1);
+
+=item C<$ShowBccHeader>
+
+By default, RT hides from the web UI information about blind copies
+user sent on reply or comment.
=cut
-Set(%FullTextSearch,
- Enable => 0,
- Indexed => 0,
-# Table => 'AttachmentsIndex',
-# Column => 'ftsindex',
-);
+Set($ShowBccHeader, 0);
+=item C<$TrustHTMLAttachments>
-=item C<$DontSearchFileAttachments>
+If C<TrustHTMLAttachments> is not defined, we will display them as
+text. This prevents malicious HTML and JavaScript from being sent in a
+request (although there is probably more to it than that)
-If C<$DontSearchFileAttachments> is set to a true value, then uploaded
-files (attachments with file names) are not searched during full-content
-ticket searches.
+=cut
+
+Set($TrustHTMLAttachments, undef);
+
+=item C<$AlwaysDownloadAttachments>
+
+Always download attachments, regardless of content type. If set, this
+overrides C<TrustHTMLAttachments>.
=cut
-Set($DontSearchFileAttachments, undef);
+Set($AlwaysDownloadAttachments, undef);
-=item C<%ChartFont>
+=item C<$AttachmentUnits>
-The L<GD> module (which RT uses for graphs) ships with a builtin font
-that doesn't have full Unicode support. You can use a given TrueType font
-for a specific language by setting %ChartFont to (language =E<gt> the
-absolute path of a font) pairs. Your GD library must have support for
-TrueType fonts to use this option. If there is no entry for a language
-in the hash then font with 'others' key is used.
+Controls the units (kilobytes or bytes) that attachment sizes use for
+display. The default is to display kilobytes if the attachment is
+larger than 1024 bytes, bytes otherwise. If you set
+C<$AttachmentUnits> to C<'k'> then attachment sizes will always be
+displayed in kilobytes. If set to C<'b'>, then sizes will be bytes.
-RT comes with two TrueType fonts covering most available languages.
+=cut
+
+Set($AttachmentUnits, undef);
+
+=item C<$PreferRichText>
+
+If C<$PreferRichText> is set to a true value, RT will show HTML/Rich
+text messages in preference to their plain-text alternatives. RT
+"scrubs" the HTML to show only a minimal subset of HTML to avoid
+possible contamination by cross-site-scripting attacks.
=cut
-Set(
- %ChartFont,
- 'zh-cn' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
- 'zh-tw' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
- 'ja' => "$RT::BasePath/share/fonts/DroidSansFallback.ttf",
- 'others' => "$RT::BasePath/share/fonts/DroidSans.ttf",
-);
+Set($PreferRichText, undef);
-=item C<$ChartsTimezonesInDB>
+=item C<$MaxInlineBody>
-RT stores dates using the UTC timezone in the DB, so charts grouped
-by dates and time are not representative. Set C<$ChartsTimezonesInDB>
-to a true value to enable timezone conversions using your DB's
-capabilities. You may need to do some work on the DB side to use this
-feature, read more in F<docs/timezones_in_charts.pod>.
+C<$MaxInlineBody> is the maximum attachment size that we want to see
+inline when viewing a transaction. RT will inline any text if the
+value is undefined or 0. This option can be overridden by users in
+their preferences.
-At this time, this feature only applies to MySQL and PostgreSQL.
+=cut
+
+Set($MaxInlineBody, 12000);
+
+=item C<$ShowTransactionImages>
+
+By default, RT shows images attached to incoming (and outgoing) ticket
+updates inline. Set this variable to 0 if you'd like to disable that
+behavior.
=cut
-Set($ChartsTimezonesInDB, 0);
+Set($ShowTransactionImages, 1);
+
+=item C<$PlainTextPre>
+
+Normally plaintext attachments are displayed as HTML with line breaks
+preserved. This causes space- and tab-based formatting not to be
+displayed correctly. By setting $PlainTextPre messages will be
+displayed using <pre>; this option overrides C<$PlainTextMono>.
+
+=cut
+
+Set($PlainTextPre, 0);
+
+
+=item C<$PlainTextMono>
+
+Set C<$PlainTextMono> to 1 to use monospaced font and preserve
+formatting; unlike C<$PlainTextPre>, the text will wrap to fit width
+of the browser window.
+
+=cut
+
+Set($PlainTextMono, 0);
+
+=item C<$SuppressInlineTextFiles>
+
+If C<$SuppressInlineTextFiles> is set to a true value, then uploaded
+text files (text-type attachments with file names) are prevented from
+being displayed in-line when viewing a ticket's history.
+
+=cut
+
+Set($SuppressInlineTextFiles, undef);
+
=item C<@Active_MakeClicky>
@@ -1639,104 +1618,210 @@ your own styles of link detection.
Set(@Active_MakeClicky, qw());
-=item C<$DefaultQueue>
+=back
+
+
-Use this to select the default queue name that will be used for creating new
-tickets. You may use either the queue's name or its ID. This only affects the
-queue selection boxes on the web interface.
+=head1 Application logic
+
+=over 4
+
+=item C<$ParseNewMessageForTicketCcs>
+
+If C<$ParseNewMessageForTicketCcs> is true, RT will attempt to divine
+Ticket 'Cc' watchers from the To and Cc lines of incoming messages.
+Be forewarned that if you have I<any> addresses which forward mail to
+RT automatically and you enable this option without modifying
+C<$RTAddressRegexp> below, you will get yourself into a heap of
+trouble.
=cut
-# Set($DefaultQueue, "General");
+Set($ParseNewMessageForTicketCcs, undef);
-=item C<$RememberDefaultQueue>
+=item C<$UseTransactionBatch>
-When a queue is selected in the new ticket dropdown, make it the new default
-for the new ticket dropdown.
+Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
+such that a resolve and comment (for example) would happen
+simultaneously, instead of as two transactions, unaware of each
+others' existence.
=cut
-# Set($RememberDefaultQueue, 1);
+Set($UseTransactionBatch, 1);
-=item C<$DefaultTimeUnitsToHours>
+=item C<$StrictLinkACL>
-Use this to set the default units for time entry to hours instead of minutes.
+When this feature is enabled a user needs I<ModifyTicket> rights on
+both tickets to link them together; otherwise, I<ModifyTicket> rights
+on either of them is sufficient.
=cut
-Set($DefaultTimeUnitsToHours, 0);
+Set($StrictLinkACL, 1);
-=item C<$SearchResultsAutoRedirect>
+=item C<$RedistributeAutoGeneratedMessages>
-when only one ticket is found in search, use this to redirect to the ticket
-display page automatically.
+Should RT redistribute correspondence that it identifies as machine
+generated? A true value will do so; setting this to '0' will cause no
+such messages to be redistributed. You can also use 'privileged' (the
+default), which will redistribute only to privileged users. This helps
+to protect against malformed bounces and loops caused by auto-created
+requestors with bogus addresses.
=cut
-Set($SearchResultsAutoRedirect, 0);
+Set($RedistributeAutoGeneratedMessages, "privileged");
+
+=item C<$ApprovalRejectionNotes>
+
+Should rejection notes from approvals be sent to the requestors? The
+default is true.
+
+=cut
+
+Set($ApprovalRejectionNotes, 1);
=back
-=item C<$OnlySearchActiveTicketsInSimpleSearch>
-When query in simple search doesn't have status info,
-use this to only search active ones.
+
+
+
+=head1 Authorization and user configuration
+
+=over 4
+
+=item C<$WebExternalAuth>
+
+If C<$WebExternalAuth> is defined, RT will defer to the environment's
+REMOTE_USER variable.
=cut
-Set($OnlySearchActiveTicketsInSimpleSearch, 1);
+Set($WebExternalAuth, undef);
-=back
+=item C<$WebExternalAuthContinuous>
-=item C<$UserAutocompleteFields>
+If C<$WebExternalAuthContinuous> is defined, RT will check for the
+REMOTE_USER on each access. If you would prefer this to only happen
+once (at initial login) set this to a false value. The default
+setting will help ensure that if your external authentication system
+deauthenticates a user, RT notices as soon as possible.
-Specifies which fields of L<RT::User> to match against and how to match each
-field when autocompleting users. Valid match methods are LIKE, STARTSWITH,
-ENDSWITH, =, and !=.
+=cut
-Not all User fields are publicly accessible and hence won't work for
-autocomplete unless you override their accessibility using a local overlay or a
-plugin. Out of the box the following fields are public: Name, EmailAddress,
-RealName, NickName, and Organization.
+Set($WebExternalAuthContinuous, 1);
+
+=item C<$WebFallbackToInternalAuth>
+
+If C<$WebFallbackToInternalAuth> is defined, the user is allowed a
+chance of fallback to the login screen, even if REMOTE_USER failed.
=cut
-Set($UserAutocompleteFields, {
- EmailAddress => 'STARTSWITH',
- Name => 'STARTSWITH',
- RealName => 'LIKE',
-});
+Set($WebFallbackToInternalAuth, undef);
-=item C<$AllowUserAutocompleteForUnprivileged>
+=item C<$WebExternalGecos>
-Should unprivileged users be allowed to autocomplete users. Setting this
-option to a true value means unprivileged users will be able to search all your
-users.
+C<$WebExternalGecos> means to match 'gecos' field as the user
+identity); useful with mod_auth_pwcheck and IIS Integrated Windows
+logon.
=cut
-Set($AllowUserAutocompleteForUnprivileged, 0);
+Set($WebExternalGecos, undef);
-=item C<$DisplayTicketAfterQuickCreate>
+=item C<$WebExternalAuto>
-Enable this to redirect to the created ticket display page automatically
-when using QuickCreate.
+C<$WebExternalAuto> will create users under the same name as
+REMOTE_USER upon login, if it's missing in the Users table.
=cut
-Set($DisplayTicketAfterQuickCreate, 0);
+Set($WebExternalAuto, undef);
+
+=item C<$AutoCreate>
+
+If C<$WebExternalAuto> is true, C<$AutoCreate> will be passed to
+User's Create method. Use it to set defaults, such as creating
+Unprivileged users with C<{ Privileged => 0 }> This must be a hashref.
+
+=cut
+
+Set($AutoCreate, undef);
+
+=item C<$WebSessionClass>
+
+C<$WebSessionClass> is the class you wish to use for managing
+Sessions. It defaults to use your SQL database, but if you are using
+MySQL 3.x and plans to use non-ascii Queue names, uncomment and add
+this line to F<RT_SiteConfig.pm> to prevent session corruption.
+
+=cut
+
+# Set($WebSessionClass, "Apache::Session::File");
+
+=item C<$AutoLogoff>
+
+By default, RT's user sessions persist until a user closes his or her
+browser. With the C<$AutoLogoff> option you can setup session lifetime
+in minutes. A user will be logged out if he or she doesn't send any
+requests to RT for the defined time.
+
+=cut
+
+Set($AutoLogoff, 0);
+
+=item C<$LogoutRefresh>
+
+The number of seconds to wait after logout before sending the user to
+the login page. By default, 1 second, though you may want to increase
+this if you display additional information on the logout page.
+
+=cut
+
+Set($LogoutRefresh, 1);
+
+=item C<$WebSecureCookies>
+
+By default, RT's session cookie isn't marked as "secure" Some web
+browsers will treat secure cookies more carefully than non-secure
+ones, being careful not to write them to disk, only sending them over
+an SSL secured connection, and so on. To enable this behavior, set
+C<$WebSecureCookies> to a true value. NOTE: You probably don't want
+to turn this on I<unless> users are only connecting via SSL encrypted
+HTTPS connections.
+
+=cut
+
+Set($WebSecureCookies, 0);
+
+=item C<$MinimumPasswordLength>
+
+C<$MinimumPasswordLength> defines the minimum length for user
+passwords. Setting it to 0 disables this check.
+
+=cut
+
+Set($MinimumPasswordLength, 5);
=back
-=head1 UTF-8 Configuration
+
+
+
+
+=head1 Internationalization
=over 4
=item C<@LexiconLanguages>
-An array that contains languages supported by RT's internationalization
-interface. Defaults to all *.po lexicons; setting it to C<qw(en ja)> will make
-RT bilingual instead of multilingual, but will save some memory.
+An array that contains languages supported by RT's
+internationalization interface. Defaults to all *.po lexicons;
+setting it to C<qw(en ja)> will make RT bilingual instead of
+multilingual, but will save some memory.
=cut
@@ -1762,10 +1847,15 @@ The charset for localized email. Must be recognized by Encode.
Set($EmailOutputEncoding, "utf-8");
-
=back
-=head1 Date Handling Configuration
+
+
+
+
+
+
+=head1 Date and time handling
=over 4
@@ -1790,58 +1880,113 @@ Set($DateTimeFormat, "DefaultFormat");
=item C<$DateDayBeforeMonth>
-Set this to 1 if your local date convention looks like "dd/mm/yy" instead of
-"mm/dd/yy". Used only for parsing, not for displaying dates.
+Set this to 1 if your local date convention looks like "dd/mm/yy"
+instead of "mm/dd/yy". Used only for parsing, not for displaying
+dates.
+
+=cut
+
+Set($DateDayBeforeMonth, 1);
+
+=item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
+
+Should an unspecified day or year in a date refer to a future or a
+past value? For example, should a date of "Tuesday" default to mean
+the date for next Tuesday or last Tuesday? Should the date "March 1"
+default to the date for next March or last March?
+
+Set C<$AmbiguousDayInPast> for the last date, or
+C<$AmbiguousDayInFuture> for the next date; the default is usually
+correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
+
+=cut
+
+Set($AmbiguousDayInPast, 0);
+Set($AmbiguousDayInFuture, 0);
+
+=item C<$DefaultTimeUnitsToHours>
+
+Use this to set the default units for time entry to hours instead of
+minutes.
=cut
-Set($DateDayBeforeMonth, 1);
+Set($DefaultTimeUnitsToHours, 0);
+
+=back
+
+
+
+
+=head1 GnuPG integration
+
+A full description of the (somewhat extensive) GnuPG integration can
+be found by running the command `perldoc L<RT::Crypt::GnuPG>` (or
+`perldoc lib/RT/Crypt/GnuPG.pm` from your RT install directory).
+
+=over 4
+
+=item C<%GnuPG>
+
+Set C<OutgoingMessagesFormat> to 'inline' to use inline encryption and
+signatures instead of 'RFC' (GPG/MIME: RFC3156 and RFC1847) format.
-=item C<$AmbiguousDayInPast>, C<$AmbiguousDayInFuture>
+If you want to allow people to encrypt attachments inside the DB then
+set C<AllowEncryptDataInDB> to true.
-Should an unspecified day or year in a date refer to a future or a
-past value? For example, should a date of "Tuesday" default to mean
-the date for next Tuesday or last Tuesday? Should the date "March 1"
-default to the date for next March or last March?
+Set C<RejectOnMissingPrivateKey> to false if you don't want to reject
+emails encrypted for key RT doesn't have and can not decrypt.
-Set C<$AmbiguousDayInPast> for the last date, or
-C<$AmbiguousDayInFuture> for the next date; the default is usually
-correct. If both are set, C<$AmbiguousDayInPast> takes precedence.
+Set C<RejectOnBadData> to false if you don't want to reject letters
+with incorrect GnuPG data.
=cut
-Set($AmbiguousDayInPast, 0);
-Set($AmbiguousDayInFuture, 0);
-
-=back
+Set(%GnuPG,
+ Enable => @RT_GPG@,
+ OutgoingMessagesFormat => "RFC", # Inline
+ AllowEncryptDataInDB => 0,
-=head1 Approval Configuration
+ RejectOnMissingPrivateKey => 1,
+ RejectOnBadData => 1,
+);
-Configuration for the approval system
+=item C<%GnuPGOptions>
-=over 4
+Options to pass to the GnuPG program.
-=item C<$ApprovalRejectionNotes>
+If you override this in your RT_SiteConfig, you should be sure to
+include a homedir setting.
-Should rejection notes be sent to the requestors? The default is true.
+Note that options with '-' character MUST be quoted.
=cut
-Set($ApprovalRejectionNotes, 1);
+Set(%GnuPGOptions,
+ homedir => q{@RT_VAR_PATH@/data/gpg},
+
+# URL of a keyserver
+# keyserver => 'hkp://subkeys.pgp.net',
+
+# enables the automatic retrieving of keys when encrypting
+# 'auto-key-locate' => 'keyserver',
+# enables the automatic retrieving of keys when verifying signatures
+# 'auto-key-retrieve' => undef,
+);
=back
-=head1 Miscellaneous Configuration
+
=head1 Lifecycles
=head2 Lifecycle definitions
-Each lifecycle is a list of possible statuses split into three logic sets:
-B<initial>, B<active> and B<inactive>. Each status in a lifecycle must be
-unique. (Statuses may not be repeated across sets.) Each set may have
-any number of statuses.
+Each lifecycle is a list of possible statuses split into three logic
+sets: B<initial>, B<active> and B<inactive>. Each status in a
+lifecycle must be unique. (Statuses may not be repeated across sets.)
+Each set may have any number of statuses.
For example:
@@ -1852,21 +1997,20 @@ For example:
...
},
-Status names can be from 1 to 64 ASCII characters. Statuses are localized
-using RT's standard internationalization and localization system.
-
-=head3 Status sets
+Status names can be from 1 to 64 ASCII characters. Statuses are
+localized using RT's standard internationalization and localization
+system.
=over 4
=item initial
-You can define multiple B<initial> statuses for tickets in a
-given lifecycle.
+You can define multiple B<initial> statuses for tickets in a given
+lifecycle.
-RT will automatically set its B<Started> date when you change
-a ticket's status from an B<initial> state to an B<active> or B<inactive>
-status.
+RT will automatically set its B<Started> date when you change a
+ticket's status from an B<initial> state to an B<active> or
+B<inactive> status.
=item active
@@ -1877,25 +2021,26 @@ being worked on and not yet complete.
B<Inactive> tickets are typically in their "final resting state".
-While you're free to implement a workflow that ignores that description,
-typically once a ticket enters an inactive state, it will never again
-enter an active state.
+While you're free to implement a workflow that ignores that
+description, typically once a ticket enters an inactive state, it will
+never again enter an active state.
-RT will automatically set the B<Resolved> date when a ticket's status is
-changed from an B<Initial> or B<Active> status to an B<Inactive> status.
+RT will automatically set the B<Resolved> date when a ticket's status
+is changed from an B<Initial> or B<Active> status to an B<Inactive>
+status.
-B<deleted> is still a special status and protected by the B<DeleteTicket>
-right, unless you re-defined rights (read below). If you don't want to
-allow ticket deletion at any time simply don't include it in your
-lifecycle.
+B<deleted> is still a special status and protected by the
+B<DeleteTicket> right, unless you re-defined rights (read below). If
+you don't want to allow ticket deletion at any time simply don't
+include it in your lifecycle.
=back
Statuses in each set are ordered and listed in the UI in the defined
order.
-Changes between statuses are constrained by transition rules,
-as described below.
+Changes between statuses are constrained by transition rules, as
+described below.
=head2 Default values
@@ -1918,21 +2063,21 @@ The following defaults are used.
=item on_create
-If you (or your code) doesn't specify a status when creating a
-ticket, RT will use the this status. See also L</Statuses available
-during ticket creation>.
+If you (or your code) doesn't specify a status when creating a ticket,
+RT will use the this status. See also L</Statuses available during
+ticket creation>.
=item on_merge
-When tickets are merged status of the ticket that merged
-is changed by force to this. It should be one of inactive
-statuses. 'resolved' or its equivalent is the best candidate.
+When tickets are merged status of the ticket that merged is changed by
+force to this. It should be one of inactive statuses; 'resolved' or
+its equivalent is most probably the best candidate.
=back
=head2 Transitions between statuses and UI actions
-A B<Transition> - is a change of status from A to B. You should define
+A B<Transition> is a change of status from A to B. You should define
all possible transitions in each lifecycle using the following format:
default => {
@@ -1951,13 +2096,15 @@ all possible transitions in each lifecycle using the following format:
=head3 Statuses available during ticket creation
-By default users can create tickets with any status, except deleted. If
-you want to restrict statuses available during creation then describe
-transition from '' (empty string), like in the example above.
+By default users can create tickets with any status, except
+deleted. If you want to restrict statuses available during creation
+then describe transition from '' (empty string), like in the example
+above.
=head3 Protecting status changes with rights
-A transition or group of transitions can be protected by a specific right.
+A transition or group of transitions can be protected by a specific
+right.
For example:
@@ -1978,25 +2125,28 @@ On the left hand side you can have the following variants:
'<from> -> *'
'* -> *'
-Valid transitions are listed in order of priority. If a user attempts to change
-a ticket's status from B<new> to B<open> then the lifecycle is checked for
-presence of an exact match, then for 'any to B<open>', 'B<new> to any' and
-finally 'any to any'.
+Valid transitions are listed in order of priority. If a user attempts
+to change a ticket's status from B<new> to B<open> then the lifecycle
+is checked for presence of an exact match, then for 'any to B<open>',
+'B<new> to any' and finally 'any to any'.
-If you don't define any rights or there is no match for a
-transition RT will use B<DeleteTicket> or B<ModifyTicket> as
-appropriate.
+If you don't define any rights, or there is no match for a transition,
+RT will use the B<DeleteTicket> or B<ModifyTicket> as appropriate.
=head3 Labeling and defining actions
-For each transition you can define an action that will be shown in the UI.
+For each transition you can define an action that will be shown in the
+UI; each action annotated with a label and an update type.
-Each action annotated with label and update type.
+Each action may provide a default update type, which can be
+B<Comment>, B<Respond>, or absent. For example, you may want your
+staff to write a reply to the end user when they change status from
+B<new> to B<open>, and thus set the update to B<Respond>. Neither
+B<Comment> nor B<Respond> are mandatory, and user may leave the
+message empty, regardless of the update type.
-Update type can be B<Comment>, B<Respond> or absent. For example, you may
-want your staff to write a reply to the end user when they change status
-from B<new> to B<open>. Neither B<Comment> nor B<Respond> are mandatory
-and user may leave message empty.
+This configuration can be used to accomplish what
+$ResolveDefaultUpdateType was used for in RT 3.8.
Use the following format to define labels and actions of transitions:
@@ -2021,8 +2171,8 @@ Use the following format to define labels and actions of transitions:
...
},
-In addition you can define multiple actions for the same transition.
-Also, it's possible to use '* -> x' to match more than one transition.
+In addition, you may define multiple actions for the same transition.
+Alternately, you may use '* -> x' to match more than one transition.
For example:
default => {
@@ -2040,8 +2190,9 @@ For example:
=head2 Moving tickets between queues with different lifecycles
-Unless there is a mapping between statuses in two lifecycles,
-you can not move tickets between queues with these lifecycles.
+Unless there is an explicit mapping between statuses in two different
+lifecycles, you can not move tickets between queues with these
+lifecycles. Such a mapping is defined as follows:
__maps__ => {
'from lifecycle -> to lifecycle' => {
@@ -2051,8 +2202,6 @@ you can not move tickets between queues with these lifecycles.
...
},
-=back
-
=cut
Set(%Lifecycles,
@@ -2100,178 +2249,82 @@ Set(%Lifecycles,
},
);
-=head1 Ticket Relationships
-
-=item C<$LinkTransactionsRun1Scrip>
-
-RT-3.4 backward compatibility setting. Add/Delete Link used to record one
-transaction and run one scrip. Set this value to 1 if you want
-only one of the link transactions to have scrips run.
-
-=cut
-
-Set($LinkTransactionsRun1Scrip, 0);
-
-=item C<$StrictLinkACL>
-
-When this feature is enabled a user needs I<ModifyTicket> rights on
-both tickets to link them together; otherwise, I<ModifyTicket> rights
-on either of them is sufficient.
-
-=cut
-
-Set($StrictLinkACL, 1);
-
-=head1 Sending messages
-
-=item C<$PreviewScripMessages>
-
-Set C<$PreviewScripMessages> to 1 if the scrips preview on the ticket
-reply page should include the content of the messages to be sent.
-
-=cut
-
-Set($PreviewScripMessages, 0);
-
-=item C<$UseTransactionBatch>
-
-Set C<$UseTransactionBatch> to 1 to execute transactions in batches,
-such that a resolve and comment (for example) would happen
-simultaneously, instead of as two transactions, unaware of each
-others' existence.
-
-=cut
-
-Set($UseTransactionBatch, 1);
-
-=item C<@CustomFieldValuesSources>
-
-Set C<@CustomFieldValuesSources> to a list of class names which extend
-L<RT::CustomFieldValues::External>. This can be used to pull lists of
-custom field values from external sources at runtime.
-
-=cut
-
-Set(@CustomFieldValuesSources, ());
-
-=item C<$CanonicalizeRedirectURLs>
-
-Set C<$CanonicalizeRedirectURLs> to 1 to use $C<WebURL> when redirecting rather
-than the one we get from C<%ENV>.
-
-If you use RT behind a reverse proxy, you almost certainly want to
-enable this option.
-
-=cut
-
-Set($CanonicalizeRedirectURLs, 0);
-
-=item C<$EnableReminders>
-
-Hide all links and portlets related to Reminders by setting this to 0
-
-=cut
-
-Set($EnableReminders, 1);
-
-
-=item C<@Plugins>
-
-Set C<@Plugins> to a list of external RT plugins that should be enabled (those
-plugins have to be previously downloaded and installed).
-
-Example:
-
-C<Set(@Plugins, (qw(Extension::QuickDelete RT::Extension::CommandByMail)));>
-
-=cut
-
-Set(@Plugins, ());
-
-=item C<@JSFiles>
-
-A list of JavaScript files to be included in head. Removing any of
-the default entries is not suggested.
-Example:
-Set(@JSFiles, qw/jquery-1.4.2.min.js jquery_noconflict.js jquery-ui-1.8.4.custom.min.js jquery.tablesorter.min.js ui.timepickr.js titlebox-state.js util.js userautocomplete.js history-folding.js/);
-=cut
-Set(@JSFiles, qw/
- jquery-1.4.2.min.js
- jquery_noconflict.js
- jquery-ui-1.8.4.custom.min.js
- jquery.tablesorter.min.js
- jquery-ui-patch-datepicker.js
- ui.timepickr.js
- titlebox-state.js
- util.js
- userautocomplete.js
- jquery.event.hover-1.0.js
- superfish.js
- supersubs.js
- jquery.supposition.js
- history-folding.js
- late.js
-/);
+=head1 Administrative interface
-=item C<$JSMinPath>
+=over 4
-Path to the jsmin binary, available from http://www.crockford.com/javascript/jsmin.html
+=item C<$ShowRTPortal>
-If specified, it will be used to minify C<JSFiles>. If it cannot be
-found, RT will fall back to the L<JavaScript::Minifier> module;
-failing that, RT will will simply concatenate the files.
+RT can show administrators a feed of recent RT releases and other
+related announcements and information from Best Practical on the top
+level Configuration page. This feature helps you stay up to date on
+RT security announcements and version updates.
-Example:
+RT provides this feature using an "iframe" on C</Admin/index.html>
+which asks the administrator's browser to show an inline page from
+Best Practical's website.
-C<Set($JSMinPath, "/path/to/jsmin");>
+If you'd rather not make this feature available to your
+administrators, set C<$ShowRTPortal> to a false value.
=cut
-=item C<@CSSFiles>
-
-A list of additional CSS files to be included in head.
+Set($ShowRTPortal, 1);
-Example:
+=item C<%AdminSearchResultFormat>
-Set(@CSSFiles, qw/foo.css/);
+In the admin interface, format strings similar to tickets result
+formats are used. Use C<%AdminSearchResultFormat> to define the format
+strings used in the admin interface on a per-RT-class basis.
=cut
-Set(@CSSFiles, qw//);
-
-=back
-
-=head1 Administrative Interface
+Set(%AdminSearchResultFormat,
+ Queues =>
+ q{'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/Admin/Queues/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
+ .q{,__Description__,__Address__,__Priority__,__DefaultDueIn__,__Disabled__},
-=over 4
+ Groups =>
+ q{'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/Admin/Groups/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
+ .q{,'__Description__'},
-=item C<$ShowRTPortal>
+ Users =>
+ q{'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/Admin/Users/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
+ .q{,__RealName__, __EmailAddress__},
-RT can show administrators a feed of recent RT releases and other
-related announcements and information from Best Practical on the top
-level Configuration page. This feature helps you stay up to date on
-RT security announcements and version updates.
+ CustomFields =>
+ q{'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/Admin/CustomFields/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
+ .q{,__AppliedTo__, __FriendlyType__, __FriendlyPattern__},
-RT provides this feature using an "iframe" on C</Admin/index.html>
-which asks the administrator's browser to show an inline page from
-Best Practical's website.
+ Scrips =>
+ q{'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/__WebRequestPathDir__/Scrip.html?id=__id__&Queue=__QueueId__">__Description__</a>/TITLE:Description'}
+ .q{,__Stage__, __Condition__, __Action__, __Template__},
-If you'd rather not make this feature available to
-your administrators, set C<$ShowRTPortal> to a false
-value.
+ Templates =>
+ q{'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/__WebRequestPathDir__/Template.html?Queue=__QueueId__&Template=__id__">__Name__</a>/TITLE:Name'}
+ .q{,'__Description__'},
+ Classes =>
+ q{ '<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__id__</a>/TITLE:#'}
+ .q{,'<a href="__WebPath__/Admin/Articles/Classes/Modify.html?id=__id__">__Name__</a>/TITLE:Name'}
+ .q{,__Description__},
+);
=back
-=cut
-Set($ShowRTPortal, 1);
-=head1 Development Configuration
+=head1 Development options
=over 4
@@ -2314,53 +2367,66 @@ Set($DevelMode, "@RT_DEVEL_MODE@");
=item C<$RecordBaseClass>
-What abstract base class should RT use for its records. You should never change this.
+What abstract base class should RT use for its records. You should
+probably never change this.
+
+Valid values are C<DBIx::SearchBuilder::Record> or
+C<DBIx::SearchBuilder::Record::Cachable>
-Valid values are:
+=cut
-=over
+Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
-=item DBIx::SearchBuilder::Record
-=item DBIx::SearchBuilder::Record::Cachable
+=item C<@MasonParameters>
-=back
+C<@MasonParameters> is the list of parameters for the constructor of
+HTML::Mason's Apache or CGI Handler. This is normally only useful for
+debugging, e.g. profiling individual components with:
+
+ use MasonX::Profiler; # available on CPAN
+ Set(@MasonParameters, (preamble => 'my $p = MasonX::Profiler->new($m, $r);'));
=cut
-Set($RecordBaseClass, "DBIx::SearchBuilder::Record::Cachable");
+Set(@MasonParameters, ());
-=back
+=item C<$StatementLog>
-=head1 Articles
+RT has rudimentary SQL statement logging support; simply set
+C<$StatementLog> to be the level that you wish SQL statements to be
+logged at.
-=item C<$ArticleOnTicketCreate>
+=cut
-Set this to 1 to display the Articles interface on the Ticket Create page
-in addition to the Reply/Comment page.
+Set($StatementLog, undef);
=back
-=cut
-Set($ArticleOnTicketCreate, 0);
-=item C<$HideArticleSearchOnReplyCreate>
-Set this to 1 to hide the search and include boxes from the Article UI.
-This assumes you have enabled Article Hotlist feature, otherwise you
-will have no access to Articles.
+=head1 Deprecated options
-=back
+=over 4
+
+=item C<$LinkTransactionsRun1Scrip>
+
+RT-3.4 backward compatibility setting. Add/Delete Link used to record
+one transaction and run one scrip. Set this value to 1 if you want
+only one of the link transactions to have scrips run.
=cut
-Set($HideArticleSearchOnReplyCreate, 0);
+Set($LinkTransactionsRun1Scrip, 0);
-=head1 DON'T MESS WITH THE STUFF BELOW
+=item C<$ResolveDefaultUpdateType>
-=cut
+This option has been deprecated. You can configure this site-wide
+with L</Lifecycles> (see L</Labeling and defining actions>).
+=back
+=cut
1;
-----------------------------------------------------------------------
More information about the Rt-commit
mailing list