[Rt-commit] [rtir] 02/07: Clean up confused references to RT_SiteConfig.pm

Kevin Falcone falcone at bestpractical.com
Wed Sep 17 17:14:13 EDT 2014


This is an automated email from the git hooks/post-receive script.

falcone pushed a commit to branch master
in repository rtir.

commit ba45878a88abf4310037cded84a7ada6f94dc95b
Author: Kevin Falcone <falcone at bestpractical.com>
Date:   Thu Aug 28 17:29:57 2014 -0500

    Clean up confused references to RT_SiteConfig.pm
    
    You don't update things in RT_SiteConfig.pm to override RTIR_Config.pm,
    you set them in RTIR_SiteConfig.pm.  This has been true (and confusingly
    documented) for a while.  I'd love to ship an RTIR_SiteConfig.pm, but it
    would conflict with one created in /opt/rt/etc/ and it might overwrite
    user changes.  Better to have users create one.
---
 README                          |  4 ++--
 docs/AdministrationTutorial.pod | 11 +++++++----
 etc/RTIR_Config.pm              |  3 ++-
 3 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/README b/README
index 7d80b7c..fd8421c 100644
--- a/README
+++ b/README
@@ -93,8 +93,8 @@ Configuring RTIR
 4) Add staff members who handle incidents to the DutyTeam group.
    RT -> Configuration -> Groups -> DutyTeam -> Members.
 
-5) You can override values in the RTIR_Config.pm in your
-   RT_SiteConfig.pm file. Just add your customizations.
+5) You can override values defined in RTIR_Config.pm by creating
+   RTIR_SiteConfig.pm in /opt/rt4/etc/ and adding your customizations.
 
 
 SETTING UP THE MAIL GATEWAY 
diff --git a/docs/AdministrationTutorial.pod b/docs/AdministrationTutorial.pod
index 1af4733..4c11719 100644
--- a/docs/AdministrationTutorial.pod
+++ b/docs/AdministrationTutorial.pod
@@ -8,16 +8,19 @@ F<RT_Config.pm> and F<RTIR_Config.pm> provide documentation on all available
 configuration options and also set system defaults. You can view these
 files to see what configuration options are available, but don't edit
 these files to change configuration values. The F<RT_SiteConfig.pm> file
-is specifically provided to store your site-specific configurations.
+is specifically provided to store your core site-specific configurations
+and you may create F<RTIR_SiteConfig.pm> for customizations to configuration
+declared in F<RTIR_Config.pm>.  F<RTIR_SiteConfig.pm> is normally
+created in /opt/rt4/etc/.
 
 To change a configuration value, copy the Set code from F<RT_Config.pm>
-or F<RTIR_Config.pm> and add it to your F<RT_SiteConfig.pm>. Then set
+or F<RTIR_Config.pm> and add it to the relevant Site Config. Then set
 your custom configuration values there.
 
 =head2 Blocks Queue
 
 You may disable the Blocks queue by putting the following into your
-RT_SiteConfig.pm config:
+F<RTIR_SiteConfig.pm> config:
 
     Set($RTIR_DisableBlocksQueue, 1);
 
@@ -376,7 +379,7 @@ it will detect this and avoid sending any email. The user will be asked to
 notify a system administrator.
 
 A missing passphrase occurs when GPG Agent is unresponsive or the passphrase
-is wrong in F<RTIR_SiteConfig.pm>. Note that you can use either GPG Agent or
+is wrong in F<RT_SiteConfig.pm>. Note that you can use either GPG Agent or
 set the passphrase in the site config, you need not do both.
 
 =head2 Service Level Agreements (SLAs)
diff --git a/etc/RTIR_Config.pm b/etc/RTIR_Config.pm
index 3e3b43e..d5bf761 100644
--- a/etc/RTIR_Config.pm
+++ b/etc/RTIR_Config.pm
@@ -6,7 +6,8 @@ RT::IR::Config - RTIR specific options and defaults for RT
 
 NEVER EDIT RTIR_Config.pm.
 
-Instead, copy any sections you want to change to F<RT_SiteConfig.pm> and edit them there.
+Instead, create RTIR_SiteConfig.pm in /opt/rt4/etc and edit anything
+you wish to change there.
 
 =head1 Base Configuration
 

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the rt-commit mailing list