changed from email address, import email addresses to eq_elder, flush temp files...

[eq/.git] / doc / install.txt

diff --git a/doc/install.txt b/doc/install.txt
index 7ccd814cd4037b9feef45568070e68892730bfe0..11f272801c159f03a40062a14f5f042af456dd3a 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -3,7 +3,7 @@ Elders Quorum Installation Guide
 
 Alan Pippin <apippin@pippins.net>
 
-   v1.0, 19 May 2005
+   v1.0, 05 Jan 2008
    
    Steps for installing Elders Quroum app
    _________________________________________________________________
@@ -13,24 +13,47 @@ Getting and Installing
 Downloading
 
    Can be downloaded from:
-   https://eq.pippins.net/eq.tar
+   https://eq.pippins.net/eq.zip
 
    It can also be obtained via the GIT revision control system by pulling from here:
-   http://git.pippins.net/eq/
+   http://git.pippins.net/eq/.git
+
+Dependencies
+
+   phpgroupware
+   mysql
+   apache (or equivalent webserver)
+   MLS data dumps (required fields shown below)
 
 Installing
 
-   1) Setup the mysql table structures for the EQ application
-      cd eq/setup/ and run mysql -u <dbuser> -p <dbpass> < eq.sql
-   2) Point your browser to: http://www.yourdomain.com/phpgroupware/setup 
+   1) Download the eq.tar file and extract it or GIT pull the archive into 
+      your base phpgroupware directory (like /usr/share/phpgroupware/).
+   2) Setup the mysql table structures for the EQ application:
+      mysql -u <dbuser> -p <dbpass> < eq/sql/eq.sql
+   3) Point your browser to: http://www.yourdomain.com/phpgroupware/setup 
       The setup prog will autodetect this application. From there you will 
       need to assign this app to the users you want to have be able to use it.
-   3) Edit the LOCAL CONFIGURATION section of eq/inc/class.eq.inc.php
-      Make sure you update the path locations for:
-      upload_target_path & script_path
-   4) A graphical representation of the mysql schema used by this application can 
+      Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
+      Make sure the "eq" application has a checkmark next to it under "Permissions this user has"
+   4) Copy the setup/db_config to setup/db_config.local and change the values in .local appropriately. 
+      Check for syntax errors by running eq/bin/check_config_syntax
+   5) Copy the setup/eq_config to setup/eq_config.local and change the values in .local appropriately.
+      Make sure you update the path locations for your specific installation locations: 
+      upload_target_path & application_path
+      Check for syntax errors by running eq/bin/check_config_syntax
+   6) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
+      to check for any missing perl library dependencies and mysql connection. 
+      Just run them without command line args.
+      Install the right perl modules until the scripts run without any errors.
+   7) A graphical representation of the mysql schema used by this application can 
       be found here: eq/sql/eq.jpg
-   5) Click on the Admin tool in the EQ app to import your initial set of ward data
+   8) Click on the Admin tool in the EQ app to import your initial set of ward data
+      obtained from MLS into the EQ application.
+   9) Click on the Admin tool and update the EQ Presidency Table appropriately.
+      The most important thing at this point is to get your district leaders added 
+      for each district you have in your quorum.
+  10) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
 
 Requirements
 
@@ -41,13 +64,17 @@ Requirements
 
    Membership.csv:
      Preferred Name
-     Phone 1
+     Household Phone
      Indiv ID
      HofH ID
      Street 1
      Street 2
      Birth
      Full Name
+     Priesthood
+     HH Position
+     Household E-mail
+     Individual E-mail
     
    Hometeaching.csv:
      Home Teacher 1
@@ -55,6 +82,8 @@ Requirements
      Comp ID
      HT District
      Household
+     Quorum
+     Supervisor
        
    Organization.csv:
      Indiv ID
@@ -64,3 +93,11 @@ Requirements
      Org Seq
      Sustained
    
+   EQ Prospective Elders.csv  
+      (optional file that lists the prospective elders for which  the EQ has stewardship.
+      Use this file if you want them listed in the PPI list
+      import mls/EQ\ Prospective\ Elders.mls as a new report into MLS to create the csv file.)
+
+   Home Teacher per Companionship.csv  (optional file that lists home teaching stats - use all fields)
+     import mls/Home\ Teacher\ per\ Companionship.mls as a new report into MLS to create the csv file.
+