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
  28 Installing
  29
  30    1) Download the eq.tar file and extract it or GIT pull the archive into
  31       your base phpgroupware directory (like /usr/share/phpgroupware/).
  32    2) Setup the mysql table structures for the EQ application:
  33       mysql -u <dbuser> -p <dbpass> < eq/sql/eq.sql
  34    3) Point your browser to: http://www.yourdomain.com/phpgroupware/setup
  35       The setup prog will autodetect this application. From there you will
  36       need to assign this app to the users you want to have be able to use it.
  37       Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
  38       Make sure the "eq" application has a checkmark next to it under "Permissions this user has"
  39    4) Copy the setup/db_config to setup/db_config.local and change the values in .local appropriately.
  40       Check for syntax errors by running eq/bin/check_config_syntax
  41    5) Copy the setup/eq_config to setup/eq_config.local and change the values in .local appropriately.
  42       Make sure you update the path locations for your specific installation locations:
  43       upload_target_path & application_path
  44       Check for syntax errors by running eq/bin/check_config_syntax
  45    6) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
  46       to check for any missing perl library dependencies and mysql connection.
  47       Just run them without command line args.
  48       Install the right perl modules until the scripts run without any errors.
  49    7) A graphical representation of the mysql schema used by this application can
  50       be found here: eq/sql/eq.jpg
  51    8) Click on the Admin tool in the EQ app to import your initial set of ward data
  52       obtained from MLS into the EQ application.
  53    9) Click on the Admin tool and update the EQ Presidency Table appropriately.
  54       The most important thing at this point is to get your district leaders added
  55       for each district you have in your quorum.
  56   10) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
  57
  58 Requirements
  59
  60    The following csv files must be obtained from MLS (or a stripped down version
  61    of each csv with the fields indicated must be manually created). These files
  62    should be placed in 1 .zip file and uplodaed to the application via the Admin
  63    section of the EQ Tools application.
  64
  65    Membership.csv:
  66      Preferred Name
  67      Household Phone
  68      Indiv ID
  69      HofH ID
  70      Street 1
  71      Street 2
  72      Birth
  73      Full Name
  74      Priesthood
  75      HH Position
  76
  77    Hometeaching.csv:
  78      Home Teacher 1
  79      Home Teacher 2
  80      Comp ID
  81      HT District
  82      Household
  83      Quorum
  84      Supervisor
  85
  86    Organization.csv:
  87      Indiv ID
  88      Indiv Name
  89      Organization
  90      Position
  91      Org Seq
  92      Sustained
  93
  94    Home Teacher per Companionship.csv  (optional file that lists home teaching stats - use all fields)
  95      import mls/Home\ Teacher\ per\ Companionship.mls as a new report into MLS to create the csv file.