doc/install.txt

   1
   2 Elders Quorum Installation Guide
   3
   4 Alan Pippin <apippin@pippins.net>
   5
   6    v1.0, 05 Jan 2008
   7
   8    Steps for installing Elders Quroum app
   9    _________________________________________________________________
  10
  11 Getting and Installing
  12
  13 Downloading
  14
  15    Can be downloaded from:
  16    https://eq.pippins.net/eq.zip
  17
  18    It can also be obtained via the GIT revision control system by pulling from here:
  19    http://git.pippins.net/eq/.git
  20
  21 Dependencies
  22
  23    phpgroupware
  24    mysql
  25    apache (or equivalent webserver)
  26    MLS data dumps (required fields shown below)
  27    Python 2.6 or .Net 3.5 (for trimming MLS data dumps)
  28
  29 Installing
  30
  31    1) Download the eq.tar file and extract it or GIT pull the archive into
  32       your base phpgroupware directory (like /usr/share/phpgroupware/).
  33    2) Setup the mysql table structures for the EQ application:
  34       mysql -u <dbuser> -p <dbpass> < eq/sql/eq.sql
  35    3) Point your browser to: http://www.yourdomain.com/phpgroupware/setup
  36       The setup prog will autodetect this application. From there you will
  37       need to assign this app to the users you want to have be able to use it.
  38       Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
  39       Make sure the "eq" application has a checkmark next to it under "Permissions this user has"
  40    4) Copy the setup/db_config to setup/db_config.local and change the values in .local appropriately.
  41       Check for syntax errors by running eq/bin/check_config_syntax
  42    5) Copy the setup/eq_config to setup/eq_config.local and change the values in .local appropriately.
  43       Make sure you update the path locations for your specific installation locations:
  44       upload_target_path & application_path
  45       Check for syntax errors by running eq/bin/check_config_syntax
  46    6) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
  47       to check for any missing perl library dependencies and mysql connection.
  48       Just run them without command line args.
  49       Install the right perl modules until the scripts run without any errors.
  50    7) A graphical representation of the mysql schema used by this application can
  51       be found here: eq/sql/eq.jpg
  52    8) Run mls/mlstrimmer.py or MLSFileTrimmer.exe to trim down the csv files and combine them
  53       into a zip file.  If you run mls/mlstrimmer.py, you'll need to point it to
  54       mls/windowsGUI/MLSFileTrimmer/MLSRequiredFields.xml.  If you choose to not use
  55       EQ\ Prospective\ Elders.mls or Home\ Teacher\ per\ Companionship.mls, you'll need to
  56       remove them from MLSRequiredFields.xml (probably best to just comment them out in case you
  57       decide to use them later)
  58    8) Click on the Admin tool in the EQ app to import your initial set of ward data
  59       obtained from MLS into the EQ application.
  60    9) Click on the Admin tool and update the EQ Presidency Table appropriately.
  61       The most important thing at this point is to get your district leaders added
  62       for each district you have in your quorum.
  63   10) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
  64
  65 Requirements
  66
  67    The following csv files must be obtained from MLS (or a stripped down version
  68    of each csv with the fields indicated must be manually created). These files
  69    should be placed in 1 .zip file and uploaded to the application via the Admin
  70    section of the EQ Tools application.
  71
  72    Membership.csv:
  73      Preferred Name
  74      Household Phone
  75      Indiv ID
  76      HofH ID
  77      Street 1
  78      Street 2
  79      Birth
  80      Full Name
  81      Priesthood
  82      HH Position
  83      Household E-mail
  84      Individual E-mail
  85
  86    Hometeaching.csv:
  87      Home Teacher 1
  88      Home Teacher 2
  89      Comp ID
  90      HT District
  91      Household
  92      Quorum
  93      Supervisor
  94
  95    Organization.csv:
  96      Indiv ID
  97      Indiv Name
  98      Organization
  99      Position
 100      Org Seq
 101      Sustained
 102
 103    EQ Prospective Elders.csv
 104       Optional file that lists the prospective elders for which  the EQ has stewardship.
 105       Use this file if you want them listed in the PPI/attendence/etc lists
 106       import mls/EQ\ Prospective\ Elders.mls as a new report into MLS to create the csv file.
 107
 108    Home Teacher per Companionship.csv  (optional file that lists home teaching stats - use all fields)
 109      import mls/Home\ Teacher\ per\ Companionship.mls as a new report into MLS to create the csv file.
 110