Added installation instructions

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

1 files changed, 65 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 00000000..ae2ba808
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,65 @@
+Installing LedgerSMB 1.2 
+
+
+This document contains information on how to upgrade from earlier versions of 
+LedgerSMB or SQL-Ledger.  This upgrade is a major revision and may not go 
+smoothly.  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.
+
+MANUAL UPGRADE:
+===============================================================================
+
+1)  Untar in desired location.
+
+2)  Check New 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 "perl Build.PL" from the command line.
+Missing dependencies can generally be installed via a Linux distributor's
+package manager or by CPAN.
+
+Once this is done and dependencies are satisfied, you can check to see whether
+the installation nominally works by running "./Build test" from the command
+line.  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
+
+3)  Install database
+
+  a) cd to the sql/legacy/ directory of the new ledger directory
+  b) run "psql" with appropriate options to connect to your database.
+  c) Note the db version by running the following query:
+     "SELECT version FROM defaults;"
+  d) Run the SQL upgrade scripts in order starting with the one whose name
+     begins with "Pg-database" (each of these scripts will upgrade to
+     the next database version which is also identified in the file name).
+
+Note that this will create three tables that may not actually be used depending
+on your setup:  users, users_conf, and session.  In general if you have multiple
+datasets, these tables will only be used in one.
+
+4)  Decide where to put the user/session management tables.  In general, we
+recommend as follows:
+  a)  Single dataset installations should use the user tables in the dataset.
+  b)  Multicompany installations should use user tables in a separate dataset
+      from any accounting data.
+
+If you need to create another dataset, you can create the db and import the
+sql/Pg-central.sql file into it.
+
+5)  Set the admin password:
+  a)  From psql, determine what admin password you wish to use.  Then type:
+      "update users_conf set password = md5('my_password');"
+      Naturally you would use your password instead of my_password.
+
+Congratulations, you have manually installed LedgerSMB 1.2.
+