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