Tweaked installation notes
[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       cd eq/setup/ and run mysql -u <dbuser> -p <dbpass> < 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:
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 in the EQ app to import your initial set of ward data
36
37 Requirements
38
39    The following csv files must be obtained from MLS (or a stripped down version
40    of each csv with the fields indicated must be manually created). These files
41    should be placed in 1 .zip file and uplodaed to the application via the Admin
42    section of the EQ Tools application.
43
44    Membership.csv:
45      Preferred Name
46      Phone 1
47      Indiv ID
48      HofH ID
49      Street 1
50      Street 2
51      Birth
52      Full Name
53     
54    Hometeaching.csv:
55      Home Teacher 1
56      Home Teacher 2
57      Comp ID
58      HT District
59      Household
60        
61    Organization.csv:
62      Indiv ID
63      Indiv Name
64      Organization
65      Position
66      Org Seq
67      Sustained
68