Applying Jeffk's patch to the install.

git-svn-id: https://ledger-smb.svn.sourceforge.net/svnroot/ledger-smb/branches/1.2@1101 4979c152-3d1c-0410-bac9-87ea11338e46

1 files changed, 105 insertions, 110 deletions

diff --git a/INSTALL b/INSTALL
index f90ec25b..5abb54d4 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,127 +1,124 @@
 Installing LedgerSMB 1.2
 ========================
- 
+
 This document contains information on how to install LedgerSMB. We
 recommend that the reader start by reading the section on manual
 installation and then start by trying the automated means mentioned
 later.
- 
+
 Also this document assumes that the reader is already familiar with the
 release notes. If you have not already done so, please read the
 release_notes file in the doc/ directory.
- 
+
+
 DISTRO AND OS-SPECIFIC NOTES
 ============================
- 
+
 Debian users should read README.debian
 
 OpenBSD users, please consult the README.OpenBSD
- 
-For Unix systems, '$' signifies the bash prompt, '=>' the psql prompt. 
- 
+
+For Unix systems, '$' signifies the bash prompt, '=>' the psql prompt.
+
+
 MANUAL INSTALL
 ==============
- 
-1) Untar in desired location (for example, /usr/local/ledger-smb,
+
+1) Untar in desired location (for example, /usr/local/ledgersmb,
 refered to as LEDGERPATH for the remainder of this INSTALL file).
 LedgerSMB files should be owned by the apache user, apache:apache on
 many systems.
- 
+
+
 2) Create a postgresql admin database role, by convention named
 'ledgersmb':
- 
+
 $ createuser --no-superuser --createdb --no-createrole \
 -U postgres --pwprompt --encrypted ledgersmb
- 
+
 (\ is a bash line continuation character, this is a single command)
- 
+
 The prompted password (referred to as MYROLEPASSWORD) will later be
 used in the DBConnect: string in the configuration file
-'ledger-smb.conf'
- 
-The equivalent SQL statement to create the ledgersmb role is:
+'ledgersmb.conf'
+
+If you prefer to work in postgresql's psql console, the equivalent SQL
+statement to create the ledgersmb role is:
 
 => CREATE ROLE ledgersmb LOGIN PASSWORD 'MYROLEPASSWORD' NOINHERIT
 CREATEDB;
- 
+
 Further commands and database interaction should be conducted using
 the new LedgerSMB admin role 'ledgersmb'.
- 
+
+
 3) Create a central user database, owned by the LedgerSMB admin role,
 'ledgersmb':
- 
+
 $ createdb -U ledgersmb -O ledgersmb ledgersmb
- 
+
 The equivalent SQL statement is:
 
 => CREATE DATABASE ledgersmb WITH ENCODING='SQL_ASCII'
 OWNER=ledgersmb;
- 
+
+
 4) On the database that will store your user and session information,
 run the included Pg-central.sql SQL commands to configure the user
 and session tables and functions:
- 
+
 $ psql -U ledgersmb -d ledgersmb -f LEDGERPATH/sql/Pg-central.sql
- 
+
 (LEDGERPATH is in the location you expanded the release
 tarball file. If you untarred in '/usr/local' then LEDGERPATH will
-be '/usr/local/ledger-smb').
-
+be '/usr/local/ledgersmb').
 
 NOTE: LedgerSMB's preferred configuration is to store the user and
 session management tables in a separate database from the company
 databases (aka 'datasets', created in admin.pl). If you are already
 working with or prefer to have your user and session tables in one
-company dataset, see further information in the manual.  You must have 
+company dataset, see further information in the manual.  You must have
 PLPGSQL installed in the dataset as well.  However that is beyond the
 scope of these instructions.
 
- 
+
 5) The SQL commands in step 4) created an LedgerSMB-managed admin user,
 e.g. a row in the users and users_conf table. You must now update the
 'admin' user's password in users_conf from the default password.
- 
+
 $ psql -U ledgersmb -d ledgersmb
- 
+
 ledgersmb=> UPDATE users_conf SET password = md5('MYPASSWORD')
 WHERE id = 1;
 
 (Change MYPASSWORD to your preferred administrative password, which
 is separate, but can be the same spelling as MYROLEPASSWORD).
- 
+
 ledgersmb=> \q
- 
- 
-6) Edit the LEDGERPATH/ledger-smb.conf file:
- 
-a) Copy 'ledger-smb.conf.default' to 'ledger-smb.conf'
+
+
+6) Edit the LEDGERPATH/ledgersmb.conf file:
+
+a) Copy 'ledgersmb.conf.default' to 'ledgersmb.conf'
 
 b) Make sure to set the section under [globaldbh] to point to the
 central user and session database, using password MYROLEPASSWORD:
 
 [globaldb]
-<<<<<<< .mine
-DBname       = ledgersmb
-DBhost       = localhost
-DBport       = 5432
-DBUserName   = ledgersmb
-DBPassword   = <set me to correct password>
-
-=======
 DBname       = ledgersmb
 DBhost       = localhost
 DBport       = 5432
 DBUserName   = ledgersmb
 DBPassword   = MYROLEPASSWORD
->>>>>>> .r1061
- 
+
+
 7) Add configuration to Apache:
- 
+
 $ sh configure_apache.sh
- 
- 
+
+
 8) Check Dependencies:
- 
+
 The Build.PL script can be used to test for unmet dependencies and
 run other tests. It doesn't install anything yet, but it will tell
 you what you are missing. To check for dependencies, run:
@@ -132,7 +129,7 @@ Missing dependencies can generally be installed via a Linux
 distribution's package manager, or by CPAN. (Build.PL itself uses
 Module::Build, which is available in packages like perl-Module-Build
 or libmodule-build-perl.)
- 
+
 Once this is done and dependencies are satisfied, you can check to
 see whether the installation nominally works by running:
 
@@ -140,28 +137,28 @@ $ ./Build test
 
 The test suites currently check to make sure all the perl modules
 load and that a number of numeric tests are passed.
- 
+
 Dependencies which are recommended are needed only for specific
 functionality and may not be required in all circumstances. These
 include:
- 
+
 * Net::TCLink for credit card processing in a POS environment
- 
+
 * Parse::RecDescent for the CLI script host
- 
- 
+
+
 9) Restart Apache (instructions vary with your Linux distro or operating
 system).
- 
- 
+
+
 Create Datasets and Users
 =========================
- 
+
 1) Create Datasets:
- 
+
 Browse to:
 
-http://hostname/ledger-smb/admin.pl
+http://hostname/ledgersmb/admin.pl
 
 login with 'MYPASSWORD'
 
@@ -179,13 +176,13 @@ company which will use LedgerSMB for accounting, e.g.:
 ledgeracme
 ledgerbigco
 (...)
- 
- 
-1) Create User(s) pointing to specific datasets:
- 
+
+
+2) Create User(s) pointing to specific datasets:
+
 Browse to:
 
-http://hostname/ledger-smb/admin.pl
+http://hostname/ledgersmb/admin.pl
 
 login with 'MYPASSWORD'
 
@@ -194,115 +191,113 @@ with database login information:
 
 User: ledgersmb
 Password: MYPASSWORD
- 
- 
-Congratulations, you have manually installed LedgerSMB 1.2.
- 
- 
+
+Congratulations, you have installed and configured LedgerSMB 1.2
+
+
 FTP INSTALLATION
 ================
- 
+
 If you control the server and have shell access, the instructions above
 are preferred over those given here. instead of those given here. This
 is simply a set of notes for those who must install on a shared server.
- 
+
 If you do not have access to the server's configuration files install
 LedgerSMB in userspace by ftp'ing all the files to your server.
- 
-1) Untar ledger-smb in your private_html directory.
- 
-2) turn on script execution for the folder ledger-smb. You can control
+
+1) Untar ledgersmb in your private_html directory.
+
+2) turn on script execution for the folder ledgersmb. You can control
 this with an .htaccess file:
- 
+
 Options +ExecCGI
 DirectoryIndex login.pl
- 
+
 3) Protect the users directory with an .htpasswd file:
- 
+
 order allow,deny
 deny from all
- 
+
 4) Protect the templates directory with an .htpasswd file:
- 
+
 order allow,deny
 deny from all
- 
+
 5) Set up your PostgreSQL database and the tables. The procedure is
 specified above.
- 
+
 You will most likely only have access to PostgreSQL with some other
 tools like pgadmin.
- 
- 
+
+
 TROUBLESHOOTING
 ===============
- 
+
 Error: Access Denied in admin.pl
 ---------------------------------
- 
+
 Likely causes:
- 
+
 1) The password entered may not match the password set in Manual Install
 step 5). You can repreat that step as often as you need to get login
 to admin.pl working, but in case your 'admin' user is not id=1, try
 using the expanded version of the SQL:
- 
+
 ledgersmb==> UPDATE users_conf SET password=mp5('MYPASSWORD')
 WHERE id = (SELECT id FROM user
 WHERE username = 'admin');
- 
+
 (Substitute 'MYPASSWORD' for your chosen password).
- 
- 
+
 2) The central database may have been created with a different postgres
 user (role) than you are using for the connection. In this case, you
 may not have permission to access the required database entities.
 
 To correct this, assuming that the admin database role is ledgersmb,
 issue the following commands from psql:
- 
+
 ledgersmb==> GRANT ALL ON users TO ledgersmb;
 ledgersmb==> GRANT ALL ON users_id_seq TO ledgersmb;
 ledgersmb==> GRANT ALL ON users_conf TO ledgersmb;
 ledgersmb==> GRANT ALL ON session TO ledgersmb;
 ledgersmb==> GRANT ALL ON session_session_id_seq TO ledgersmb;
- 
- 
+
+
 Error: "No GlobalDBH Configured or Could not Connect"
 -----------------------------------------------------
- 
+
 LedgerSMB 1.2 uses a dedicated connection to the central database for
 user authentication. When the attempt to connect to that database fails,
 the error message above is displayed. In this case, check the following
-parameters under the [globaldbh] of the ledger-smb.conf file.
- 
+parameters under the [globaldbh] of the ledgersmb.conf file.
+
 1) DBUserName should match the database user you imported Pg-central
 as (if you followed the instructions above, that would be ledgersmb).
- 
+
 2) DBPassword needs to match the database password to used to connect
 to.
- 
+
 You can test the above causes by running (from the command line):
- 
+
 $ psql -U [DBUserName]
 password: [DBPassword]
- 
+
 When you enter the password, it will not show up on the screen.
- 
+
 The other line that you should pay attention to is the DBConnect
 line. Parameters in the form of name=value need to match those for
 your host. The following parameters need to be set correctly in that
 line:
- 
-dbname=ledgersmb (the database you imported Pg-Central.sql into).
-host=localhost (don't change unless you know what you are doing!)
-port=5432 (don't change unless you know what you are doing!)
- 
+
+dbname=ledgersmb  (the database you imported Pg-Central.sql into).
+host=localhost    (don't change unless you know what you are doing!)
+port=5432         (don't change unless you know what you are doing!)
+
 The full line should then be something like:
 
 DBConnect: dbi:Pg:dbname=ledgersmb;host=localhost;port=5432
- 
-And that section of ledger-smb.conf looks like:
+
+And that section of ledgersmb.conf looks like:
 
 [globaldb]
 DBname     = ledgersmb