Updated "Phone 1" field to be "Household Phone" to match MLS

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

diff --git a/doc/install.txt b/doc/install.txt
index 406126ed4872ebce2363d9e34a6ac741cb3bc493..114ebaa99135ee72374e7ed0fc5c83ba79752fec 100644 (file)
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -13,11 +13,18 @@ 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/.git
 
+Dependencies
+
+   phpgroupware
+   mysql
+   apache (or equivalent webserver)
+   MLS data dumps (required fields shown below)
+
 Installing
 
    1) Download the eq.tar file and extract it or GIT pull the archive into 
@@ -30,9 +37,11 @@ Installing
       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.
@@ -55,13 +64,15 @@ Requirements
 
    Membership.csv:
      Preferred Name
-     Phone 1
+     Household Phone
      Indiv ID
      HofH ID
      Street 1
      Street 2
      Birth
      Full Name
+     Priesthood
+     HH Position
     
    Hometeaching.csv:
      Home Teacher 1
@@ -69,6 +80,8 @@ Requirements
      Comp ID
      HT District
      Household
+     Quorum
+     Supervisor
        
    Organization.csv:
      Indiv ID
@@ -78,3 +91,5 @@ Requirements
      Org Seq
      Sustained
    
+   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.