Perldoc contents of RT_Config.pm RTConfig382 for version 3.8.2

* NAME
  * WARNING
  * Base Configuration
  * Database Configuration
  * Incoming Mail Gateway Configuration
  * Outgoing Mail Configuration
  * Sendmail Configuration
  * SMTP Configuration
  * Other Mailer Configuration
  * GnuPG Configuration
  
  * NAME
  * WARNING
  * Base Configuration
  * Database Configuration
  * Incoming Mail Gateway Configuration
  * Outgoing Mail Configuration
  * Sendmail Configuration
  * SMTP Configuration
  * Other Mailer Configuration
  * GnuPG Configuration
  * Logging Configuration
  * Web Interface Configuration
  * the Net::Server manpage (rt-server) Configuration
  * UTF-8 Configuration
  * Date Handling Configuration
  * Miscellaneous Configuration
  * Development Configuration
  * Deprecated Options
  
  

NAME

RT::Config

use RT::Config;

WARNING

NEVER EDIT RT_Config.pm.

Instead, copy any sections you want to change to RT_SiteConfig.d/ and edit them there.

Base Configuration

$rtname

$rtname is the string that RT will look for in mail messages to figure out what ticket a new piece of mail belongs to.

Your domain name is recommended, so as not to pollute the namespace. once you start using a given tag, you should probably never change it. (otherwise, mail for existing tickets won't get put in the right place)

$EmailSubjectTagRegex

This regexp controls what subject tags RT recognizes as its own. If you're not dealing with historical $rtname values, you'll likely never have to enable this feature.
  
  Be VERY CAREFUL with it. Note that it overrides $rtname for subject token matching and that you should use only ``non-capturing'' parenthesis grouping. For example:
  
  Set($EmailSubjectTagRegex, qr/(?:example.com|example.org)/i );
  
  and NOT
  
  Set($EmailSubjectTagRegex, qr/(example.com|example.org)/i );
  
  This setting would make RT behave exactly as it does without the setting enabled.
  

$Organization

You should set this to your organization's DNS domain. For example, fsck.com or asylum.arkham.ma.us. It's used by the linking interface to guarantee that ticket URIs are unique and easy to construct.

$MinimumPasswordLength

$MinimumPasswordLength defines the minimum length for user passwords. Setting it to 0 disables this check.

$Timezone

$Timezone is used to convert times entered by users into GMT and back again It should be set to a timezone recognized by your local unix box.

Database Configuration

$DatabaseType

Database driver being used; case matters.
  
  Valid types are ``mysql'', ``Oracle'' and ``Pg''
  

$DatabaseHost, $DatabaseRTHost

The domain name of your database server.

If you're running mysql and it's on localhost, leave it blank for enhanced performance

$DatabasePort

The port that your database server is running on. Ignored unless it's a positive integer. It's usually safe to leave this blank

$DatabaseUser

The name of the database user (inside the database)

$DatabasePassword

Password the $DatabaseUser should use to access the database

$DatabaseName

The name of the RT's database on your database server

$DatabaseRequireSSL

If you're using Postgres and have compiled in SSL support, set $DatabaseRequireSSL to 1 to turn on SSL communication

$UseSQLForACLChecks

In RT for ages ACL are checked after search what in some situtations result in empty search pages and wrong count of tickets.

Set $UseSQLForACLChecks to 1 to use SQL and get rid of these problems.

However, this option is beta. In some cases it result in performance improvements, but some setups can not handle it.

Incoming Mail Gateway Configuration

$OwnerEmail

$OwnerEmail is the address of a human who manages RT. RT will send errors generated by the mail gateway to this address. This address should _not_ be an address that's managed by your RT instance.

$LoopsToRTOwner

If $LoopsToRTOwner is defined, RT will send mail that it believes might be a loop to $OwnerEmail

$StoreLoops

If $StoreLoops is defined, RT will record messages that it believes to be part of mail loops.

As it does this, it will try to be careful not to send mail to the sender of these messages

$MaxAttachmentSize

$MaxAttachmentSize sets the maximum size (in bytes) of attachments stored in the database.

For mysql and oracle, we set this size at 10 megabytes. If you're running a postgres version earlier than 7.1, you will need to drop this to 8192. (8k)

$TruncateLongAttachments

$TruncateLongAttachments: if this is set to a non-undef value, RT will truncate attachments longer than $MaxAttachmentSize.

$DropLongAttachments

$DropLongAttachments: if this is set to a non-undef value, RT will silently drop attachments longer than MaxAttachmentSize.

$ParsenewMessageForTicketCcs

If $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 _any_ addresses which forward mail to RT automatically and you enable this option without modifying $RTAddressRegexp below, you will get yourself into a heap of trouble.

$RTAddressRegexp

$RTAddressRegexp is used to make sure RT doesn't add itself as a ticket CC if the setting above is enabled.

$CanonicalizeEmailAddressMatch, $CanonicalizeEmailAddressReplace

RT provides functionality which allows the system to rewrite incoming email addresses. In its simplest form, you can substitute the value in $<CanonicalizeEmailAddressReplace> for the value in $<CanonicalizeEmailAddressMatch> (These values are passed to the $<CanonicalizeEmailAddress> subroutine in RT/User.pm)

By default, that routine performs a s/$Match/$Replace/gi on any address passed to it.

$CanonicalizeEmailAddressMatch

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 RT/User_Local.pm

$SenderMustExistInExternalDatabase

If $SenderMustExistInExternalDatabase is true, RT will refuse to create non-privileged accounts for unknown users if you are using the $LookupSenderInExternalDatabase option. Instead, an error message will be mailed and RT will forward the message to $RTOwner.

If you are not using $LookupSenderInExternalDatabase, this option has no effect.

If you define an AutoRejectRequest template, RT will use this template for the rejection message.

@MailPlugins

@MailPlugins is a list of auth plugins for the RT::Interface::Email manpage to use; see rt-mailgate

$UnsafeEmailCommands

$UnsafeEmailCommands, if set to true, enables 'take' and 'resolve' as possible actions via the mail gateway. As its name implies, this is very unsafe, as it allows email with a forged sender to possibly resolve arbitrary tickets!

$ExtractSubjectTagMatch, $ExtractSubjectTagNoMatch

The default ``extract remote tracking tags'' scrip settings; these detect when your RT is talking to another RT, and adjusts the subject accordingly.
  
  

Outgoing Mail Configuration

$MailCommand

$MailCommand defines which method RT will use to try to send mail. 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 $SendmailArguments if you use 'sendmail' rather than 'sendmailpipe'

Sendmail Configuration

These options only take effect if $MailCommand is 'sendmail' or 'sendmailpipe'

$SendmailArguments

$SendmailArguments defines what flags to pass to $SendmailPath If you picked 'sendmailpipe', you MUST add a -t flag to $SendmailArguments These options are good for most sendmail wrappers and workalikes

These arguments are good for sendmail brand sendmail 8 and newer Set($SendmailArguments,"-oi -t -ODeliveryMode=b -OErrorMode=m");

$SendmailBounceArguments

$SendmailBounceArguments defines what flags to pass to $Sendmail assuming RT needs to send an error (ie. bounce).

$SendmailPath

If you selected 'sendmailpipe' above, you MUST specify the path to your sendmail binary in $SendmailPath.

SMTP Configuration

These options only take effect if $MailCommand is 'smtp'

$SMTPServer

$SMTPServer should be set to the hostname of the SMTP server to use

$SMTPFrom

$SMTPFrom should be set to the 'From' address to use, if not the email's 'From'

$SMTPDebug

$SMTPDebug should be set to true to debug SMTP mail sending

Other Mailer Configuration

@MailParams

@MailParams defines a list of options passed to $MailCommand if it is not 'sendmailpipe', 'sendmail', or 'smtp'

$CorrespondAddress, $CommentAddress

RT is designed such that any mail which already has a ticket-id associated with it will get to the right place automatically.

$CorrespondAddress and $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.

$DashboardAddress

The email address from which RT will send dashboards. If none is set, then $OwnerEmail will be used.

$UseFriendlyFromLine

By default, RT sets the outgoing mail's ``From:'' header to ``SenderName via RT''. Setting $UseFriendlyFromLine to 0 disables it.
  

$FriendlyFromLineFormat

sprintf() format of the friendly 'From:' header; its arguments are SenderName and SenderEmailAddress.

$UseFriendlyToLine

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.
  

$FriendlyToLineFormat

sprintf() format of the friendly 'From:' header; its arguments are WatcherType and TicketId.

$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 behaviour, Set $NotifyActor to 1

$RecordOutgoingEmail

By default, RT records each message it sends out to its own internal database. To change this behavior, set $RecordOutgoingEmail to 0

$VERPPrefix, $VERPPrefix

VERP support (http://cr.yp.to/proto/verp.txt)

uncomment the following two directives to generate envelope senders of the form ${VERPPrefix}${originaladdress}@${VERPDomain} (i.e. rt-jesse=fsck.com@rt.example.com ).

This currently only works with sendmail and sendmailppie.

$ForwardFromUser

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.

To change this behavior, set $ForwardFromUser to true value and RT will use address of the current user and leave subject without RT's tag.

$ShowBccHeader

By default RT hides from the web UI information about blind copies user sent on reply or comment.

To change this set the following option to true value.

$DashboardSubject

Lets you set the subject of dashboards. Arguments are the frequency (Daily, Weekly, Monthly) of the dashboard and the dashboard's name. [_1] for the name of the dashboard.