Numerous bug fixes from Brett's turn-on experience.
[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) Edit the GLOBALS section of the eq/bin/import_ward_data script
36    6) Edit the GLOBALS section of the eq/bin/parse_ward_data script
37    7) Try to run eq/bin/import_ward_data & parse_ward_data scripts from the commandline
38       to check for any missing perl library dependencies and mysql connection. 
39       Just run them without command line args.
40       Install the right perl modules until the scripts run without any errors.
41    8) A graphical representation of the mysql schema used by this application can 
42       be found here: eq/sql/eq.jpg
43    9) Click on the Admin tool in the EQ app to import your initial set of ward data
44       obtained from MLS into the EQ application.
45   10) Click on the Admin tool and update the EQ Presidency Table appropriately.
46       The most important thing at this point is to get your district leaders added 
47       for each district you have in your quorum.
48   11) I highly recommend installing phpmyadmin to view/edit/debug mysql tables related to this tool.
49
50 Requirements
51
52    The following csv files must be obtained from MLS (or a stripped down version
53    of each csv with the fields indicated must be manually created). These files
54    should be placed in 1 .zip file and uplodaed to the application via the Admin
55    section of the EQ Tools application.
56
57    Membership.csv:
58      Preferred Name
59      Phone 1
60      Indiv ID
61      HofH ID
62      Street 1
63      Street 2
64      Birth
65      Full Name
66     
67    Hometeaching.csv:
68      Home Teacher 1
69      Home Teacher 2
70      Comp ID
71      HT District
72      Household
73        
74    Organization.csv:
75      Indiv ID
76      Indiv Name
77      Organization
78      Position
79      Org Seq
80      Sustained
81