Further tweaks to the install doc
[eq/.git] / 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.tar
17
18    It can also be obtained via the GIT revision control system by pulling from here:
19    http://git.pippins.net/eq/
20
21 Installing
22
23    1) Download the eq.tar file and extract it or GIT pull the archive into 
24       your base phpgroupware directory (like /usr/share/phpgroupware/).
25    2) Setup the mysql table structures for the EQ application:
26       mysql -u <dbuser> -p <dbpass> < eq/sql/eq.sql
27    3) Point your browser to: http://www.yourdomain.com/phpgroupware/setup 
28       The setup prog will autodetect this application. From there you will 
29       need to assign this app to the users you want to have be able to use it.
30    4) Edit the LOCAL CONFIGURATION section of eq/inc/class.eq.inc.php
31       Make sure you update the path locations for your specific:
32       upload_target_path & script_path
33    5) A graphical representation of the mysql schema used by this application can 
34       be found here: eq/sql/eq.jpg
35    6) Click on the Admin tool and update the EQ Presidency Table appropriately.
36       The most important thing at this point is to get your district leaders added 
37       for each district you have in your quorum.
38    7) Click on the Admin tool in the EQ app to import your initial set of ward data
39       obtained from MLS into the EQ application.
40
41 Requirements
42
43    The following csv files must be obtained from MLS (or a stripped down version
44    of each csv with the fields indicated must be manually created). These files
45    should be placed in 1 .zip file and uplodaed to the application via the Admin
46    section of the EQ Tools application.
47
48    Membership.csv:
49      Preferred Name
50      Phone 1
51      Indiv ID
52      HofH ID
53      Street 1
54      Street 2
55      Birth
56      Full Name
57     
58    Hometeaching.csv:
59      Home Teacher 1
60      Home Teacher 2
61      Comp ID
62      HT District
63      Household
64        
65    Organization.csv:
66      Indiv ID
67      Indiv Name
68      Organization
69      Position
70      Org Seq
71      Sustained
72