import sql-ledger 2.4.4SQL_LEDGER

1 files changed, 102 insertions, 99 deletions

diff --git a/sql-ledger/doc/README b/sql-ledger/doc/README
index 7585f5357..2050e8500 100644
--- a/sql-ledger/doc/README
+++ b/sql-ledger/doc/README
@@ -1,14 +1,14 @@
                 SQL-Ledger Accounting
-                     Version 2.0
+                     Version 2.4
 
 
 DESCRIPTION:
 ------------
-SQL-Ledger is a double-entry accounting program written
-in perl. It has been tested with PostgreSQL, Oracle,
-Apache, Netscape, Mozilla, Galeon, Explorer, Links, Lynx,
-Konqueror, Voyager, W3M and Opera clients on Linux, FreeBSD,
-Solaris, Windows and Mac computers.
+SQL-Ledger is a double-entry accounting system written
+in perl. It has been tested with PostgreSQL, Apache,
+Netscape, Mozilla, Galeon, Explorer, Links, Lynx,
+Konqueror, Voyager, W3M and Opera clients on Linux,
+FreeBSD, Solaris, Windows, Mac computers and PDA's.
 
 Data is stored in a SQL server, either locally or remote,
 the display is through a text or GUI web browser. The system
@@ -21,12 +21,9 @@ Configuration files let you specify to which SQL server
 to connect to, personal preferences such as company name,
 language, number and date format, etc.
 
-The admin script can be used to create, edit or delete users
-and to create and delete datasets and to setup the Chart
-of Accounts and templates needed for the system.
-It can be used for PostgreSQL and Oracle. If you want to
-use another SQL server the tables and chart of accounts
-must be created by hand.
+With the admin script you can create, edit or delete users,
+create and delete datasets and setup the Chart of Accounts
+and templates needed for the system.
 
 You can have a group of users using the same dataset and
 templates for generating Invoices, Income Statements and
@@ -34,15 +31,12 @@ Balance Sheets or a different set altogether.
 
 Templates are supplied in html and tex format to generate
 most of the forms. Forms can be printed to screen, sent
-to a printer or to a mailer agent. To use the tex forms
-latex must be installed. Most systems have a latex binary
-installed by default. Latex is also available for Windows
-and the Mac so we stay compatible across all major platforms.
+to a printer or e-mailed.
 
 
 COPYRIGHT:
 ----------
-You may distribute under the terms of the GNU License.
+Licensed under the terms of the GPL.
 
 
 LATEST VERSION:
@@ -58,27 +52,46 @@ Non specific, see requirements.
 REQUIREMENTS:
 -------------
 1 - Perl, 5+
-2 - http server (Apache, NCSA, httpi, ...)
-3 - SQL Server with transaction support (PostgreSQL 7.0+, Oracle)
-4 - DBD (DBD-Pg, DBD-Oracle)
+2 - http server (Apache, NCSA, httpi, thttpd, ...)
+3 - SQL Server (PostgreSQL 7.1+)
+4 - DBD (DBD-Pg)
 5 - DBI
 6 - LaTeX (optional)
 
 
 FOREIGN LANGUAGE SUPPORT:
 -------------------------
-All the required files are in locale/country_code
-The main files are 'all' and 'missing'. You can enter
-translated strings in either file. When you are done
-run locales.pl from the command line to rebuild the
-required files.
+25 languages are supported. Language files are
+ordinary text files, no special software is
+required to change or add new translations.
 
 Some of the translation files are not 100% complete.
 If strings are missing, English is used instead.
 
 
-INSTALLATION:
--------------
+INSTALLATION WITH setup.pl:
+---------------------------
+Make a directory
+
+  mkdir /usr/local/sql-ledger
+
+Copy setup.pl to /usr/local/sql-ledger
+
+run setup.pl as root and follow the prompts.
+
+  perl setup.pl
+
+Go to the next step, "PREPARE YOUR SQL SERVER".
+
+NOTE: If you are behind a firewall and cannot download
+the code with setup.pl, download the source code file
+and specify the filename on the command line.
+
+  perl setup.pl sql-ledger-2.4.0.tar.gz
+
+
+INSTALLATION WITHOUT setup.pl:
+------------------------------
 unpack the tar.gz file in /usr/local
 
   tar xzvf sql-ledger-x.x.x.tar.gz
@@ -94,8 +107,11 @@ where your httpd.conf is and copy the next section into the file
 
   Alias /sql-ledger/ /usr/local/sql-ledger/
   <Directory /usr/local/sql-ledger>
+    AllowOverride All
     AddHandler cgi-script .pl
     Options ExecCGI Includes FollowSymlinks
+    Order Allow,Deny
+    Allow from All
   </Directory>
 
   <Directory /usr/local/sql-ledger/users>
@@ -106,38 +122,28 @@ where your httpd.conf is and copy the next section into the file
 edit httpd.conf and add
 
   # SQL-Ledger
-  Include <ServerRoot>/sql-ledger-httpd.conf
+  Include /config_directory/sql-ledger-httpd.conf
 
-Note: Replace <ServerRoot> with the server's root directory!
+Note: use an absolute or relative path to include
+the configuration in your httpd.conf file.
 
+i.e. /etc/httpd/sql-ledger-httpd.conf
+     etc/apache2/sql-ledger-httpd.conf
+     
 restart your web server.
 
-
 Note: /usr/local/sql-ledger is only a suggested
-path, you can install in any directory.
-
-
-INSTALLATION WITH setup.pl:
----------------------------
-Make a directory
-
-  mkdir /usr/local/sql-ledger
-
-Copy setup.pl to /usr/local/sql-ledger
-
-run setup.pl as root and follow the prompts.
-
-Go to the next step, "PREPARE YOUR SQL SERVER".
+path, you may install in any directory.
 
 
 SET PERMISSION:
 ---------------
 change directory to /usr/local/sql-ledger
 
-# chown nobody:nobody users templates
+# chown -R nobody:nogroup users templates css spool
 
-replace nobody:nobody with the web server
-user of your system. Some systems use
+replace nobody:nogroup with the web server
+user and group of your system. Some systems use
 apache:apache, www, www-data, ...
 
 
@@ -146,52 +152,51 @@ PREPARE YOUR SQL SERVER:
 
   PostgreSQL:
   -----------
-  add one database user with create database privileges
-  to manage the datasets and tables for SQL-Ledger
+  add one database user with create database and
+  create user privileges to manage the datasets
+  and tables for SQL-Ledger
   
   # su postgres
   $ createuser -d sql-ledger
+  Shall the new user be allowed to create databases? (y/n) y
+  Shall the new user be allowed to create more new users? (y/n) y
   
-  if you use passwords to access postgres set the user up with a password 
+  if you use passwords to access postgres use this command
   $ createuser -d -P sql-ledger
 
-  Answer no to the following question.
-  Shall the new user be allowed to create more new users? (y/n) n
+  Install PL/PGSQL in template1
 
-  You can add more database users to keep datasets
-  separated. Each dataset belongs to one company.
+  # su postgres
+  $ createlang plpgsql template1
   
   
   ORACLE:
   -------
-  add one user and one tablespace
-  all datasets share the same tablespace
-  
+  not supported yet
+
+  DB2:
+  ----
+  not supported yet
+
 
 SETUP A DATABASE AND THE TABLES:
 --------------------------------
 Load your web browser and connect to
 http://localhost/sql-ledger/admin.pl
 
-Tables are created with the "Database
-Administration" function.
-
 Select the "Database Administration" link,
-enter a host, port and user you created in the
-previous step.
+enter a host, port and the user you created
+in the previous step.
 
 The "Create Dataset" link queries the server
 for existing datasets and displays them in a
-column. Then you enter a name for the new
-dataset and select one of the Chart of Accounts
-and click on Continue.
+table. Enter a name for the new dataset (use
+lowercase letters only!) and select one of the
+Chart of Accounts and click on Continue.
 Your new dataset and the tables will be created
 and the selected Chart of Accounts loaded. The
-owner of the tables is the user you entered in
-the previous screen.
-
-NOTE: Be patient, some of the charts are really
-big and take some time to create.
+owner of the tables will be the user you entered
+in the previous screen as the "User".
 
 The "Delete Dataset" link queries the server
 for datasets which are in use by SQL-Ledger
@@ -199,11 +204,14 @@ and are not used by any members. This may
 take a while to figure out. "Be patient".
 If there are any datasets not in use, you get
 a screen with the datasets listed where you
-can select the one you want to delete.
+select the one you want to delete.
+
+You cannot manage any other datasets from this
+interface, only the datasets used by SQL-Ledger.
 
-NOTE: you cannot manage any other datasets
-from this interface, only the datasets used
-by SQL-Ledger.
+POSTGRESQL: template1 is only used to query
+the server, none of the information stored
+in template1 is manipulated in any way.
 
 
 SETUP A USER:
@@ -224,13 +232,16 @@ http://localhost/sql-ledger/login.pl
 
 UPGRADING TO A NEWER VERSION:
 -----------------------------
-1. unpack the new version over top
-2. check the doc directory for specific notes
-3. load admin.pl
-   click on "Database Administration"
-   enter the dba in the "Connect to" field
-   click on "Update Dataset"
-   select the datasets and click "Continue"
+1. load admin.pl and lock the system
+2. untar the new version over top
+3. check the doc directory for specific notes
+4. load admin.pl and unlock the system
+5. log in
+
+NOTE: datasets are upgraded when you log in for
+the first time. If an error occurs the system
+will remain locked. Track down the error, fix it,
+load admin.pl, unlock the system and log in again.
 
 
 UPGRADING WITH setup.pl:
@@ -242,11 +253,10 @@ the prompts.
 INSTALLATION CHECKLIST:
 -----------------------
 1. untar SL somewhere
-2. change permissions for the users and templates directory
+2. change permission for the users, templates, css and spool directory
 3. edit httpd.conf
 4. edit sql-ledger.conf
-5. a) add the database user sql-ledger in PostgreSQL
-   b) add a tablespace and the database user sql-ledger in Oracle
+5. add the database user sql-ledger
 6. load admin.pl
 7. create datasets for the companies
 8. add users
@@ -255,33 +265,26 @@ INSTALLATION CHECKLIST:
    
    a) PostgreSQL
    
-      Host:     for local connections leave empty
+      Host:     for local connections leave blank
       Dataset:  the dataset created in step 7
-      Port:     for local connections leave empty
+      Port:     for local connections leave blank
       User:     sql-ledger
       Password: password for sql-ledger
-      
-   b) Oracle
-   
-      SID:      system ID
-      Port:     the port Oracle is listening on
-      Dataset:  the dataset created in step 7
-      Password: password for connection
-   
+
 
 IF SOMETHING DOESN'T WORK:
 --------------------------
-There is a FAQ online which addresses various questions.
-see http://www.sql-ledger.org/misc/faq.html
+There is a FAQ at http://www.sql-ledger.org/misc/faq.html
+or read the one included in the doc directory.
 
 There are also several mailing lists at
 http://www.sql-ledger.org/misc/mailinglist.html
-where you can go for help.
+where you can seek free help.
 
-If you require support you can order online at
+To order commercial support see
 http://www.sql-ledger.com/misc/support.html
 
 
 =====================================================================
-December 4, 2002
+September 4, 2004