Improved documentation comments across multiple applications.
[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       Enable it for each user by going to Site Admin -> User Accounts -> <username> -> edit
31       Make sure the "eq" application has a checkmark next to it under "Permissions this user has"
32    4) Edit the LOCAL CONFIGURATION section of eq/inc/class.eq.inc.php
33       Make sure you update the path locations for your specific:
34       upload_target_path & script_path
35    5) A graphical representation of the mysql schema used by this application can 
36       be found here: eq/sql/eq.jpg
37    6) Click on the Admin tool in the EQ app to import your initial set of ward data
38       obtained from MLS into the EQ application.
39    7) Click on the Admin tool and update the EQ Presidency Table appropriately.
40       The most important thing at this point is to get your district leaders added 
41       for each district you have in your quorum.
42
43 Requirements
44
45    The following csv files must be obtained from MLS (or a stripped down version
46    of each csv with the fields indicated must be manually created). These files
47    should be placed in 1 .zip file and uplodaed to the application via the Admin
48    section of the EQ Tools application.
49
50    Membership.csv:
51      Preferred Name
52      Phone 1
53      Indiv ID
54      HofH ID
55      Street 1
56      Street 2
57      Birth
58      Full Name
59     
60    Hometeaching.csv:
61      Home Teacher 1
62      Home Teacher 2
63      Comp ID
64      HT District
65      Household
66        
67    Organization.csv:
68      Indiv ID
69      Indiv Name
70      Organization
71      Position
72      Org Seq
73      Sustained
74