diff options
Diffstat (limited to 'doc')
-rwxr-xr-x | doc/COPYING | 355 | ||||
-rwxr-xr-x | doc/COPYRIGHT | 21 | ||||
-rwxr-xr-x | doc/README | 343 | ||||
-rwxr-xr-x | doc/README.DB2 | 82 | ||||
-rwxr-xr-x | doc/UPGRADE-1.6-1.8 | 61 | ||||
-rwxr-xr-x | doc/UPGRADE-1.8-1.8.3 | 23 | ||||
-rwxr-xr-x | doc/UPGRADE-1.8.3-1.8.4 | 10 | ||||
-rwxr-xr-x | doc/UPGRADE-1.8.4-1.8.5 | 18 | ||||
-rwxr-xr-x | doc/UPGRADE-1.8.5-1.8.7 | 6 | ||||
-rwxr-xr-x | doc/UPGRADE-1.8.7-2.0.0 | 20 | ||||
-rwxr-xr-x | doc/UPGRADE-2.0-2.0.8 | 8 | ||||
-rwxr-xr-x | doc/UPGRADE-2.0.8-2.0.9 | 6 | ||||
-rwxr-xr-x | doc/UPGRADE-2.0.9-2.2.0 | 12 | ||||
-rwxr-xr-x | doc/UPGRADE-2.2.0-2.2.7 | 11 | ||||
-rwxr-xr-x | doc/UPGRADE-2.2.7-2.4.0 | 84 | ||||
-rwxr-xr-x | doc/UPGRADE-2.4.0-2.4.2 | 12 | ||||
-rwxr-xr-x | doc/UPGRADE-2.4.16-2.6.0 | 19 | ||||
-rwxr-xr-x | doc/UPGRADE-2.4.2-2.4.3 | 22 | ||||
-rwxr-xr-x | doc/UPGRADE-2.4.3-2.4.16 | 12 | ||||
-rwxr-xr-x | doc/UPGRADE-2.6.0-2.6.17 | 14 | ||||
-rwxr-xr-x | doc/faq.html | 707 |
21 files changed, 1846 insertions, 0 deletions
diff --git a/doc/COPYING b/doc/COPYING new file mode 100755 index 00000000..083bb415 --- /dev/null +++ b/doc/COPYING @@ -0,0 +1,355 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<HTML> +<HEAD> +<TITLE>GNU General Public License</TITLE> +</HEAD> + +<BODY BGCOLOR=ffffff> + + +<pre> + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. + + +</BODY> +</HTML> + diff --git a/doc/COPYRIGHT b/doc/COPYRIGHT new file mode 100755 index 00000000..f41ecdf5 --- /dev/null +++ b/doc/COPYRIGHT @@ -0,0 +1,21 @@ +###################################################################### +# LedgerSMB Small Medium Business Accounting +# Copyright (c) 1999 - 2005, DWS Systems Inc. +# +# Web: http://sourceforge.net/projects/ledger-smb/ +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +# +####################################################################### + diff --git a/doc/README b/doc/README new file mode 100755 index 00000000..d5aea879 --- /dev/null +++ b/doc/README @@ -0,0 +1,343 @@ + LedgerSMB Small Medium Business Accounting + Version 2.6 + + +DESCRIPTION: +------------ +LedgerSMB 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 database server, either locally or +remote, the display is through a text or GUI web browser. +The system is linked by a chart of accounts. All transactions +for AR, AP and GL are stored in a transaction table. Hyper-links +from the chart of accounts let you view transactions posted +through AR, AP and GL. + +Configuration files let you specify to which SQL database server +to connect to, personal preferences such as company name, +language, number and date format, etc. + +With the admin script you can create, edit or delete users, +create and delete datasets and set up 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 +Balance Sheets or a different set altogether. + +Templates are supplied in html, text and tex format to +generate most of the forms. Forms can be printed to screen, +sent to a printer or e-mailed. + + +COPYRIGHT: +---------- +Licensed under the terms of the GPL. + + +LATEST VERSION: +--------------- +available from http://sourceforge.net/projects/ledger-smb/ + + +PLATFORMS: +---------- +Non specific, see requirements. + + +REQUIREMENTS: +------------- +1 - Perl, 5+ +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: +------------------------- +28 languages are supported. Language files are +ordinary text files, no special software is +needed to change or add new translations. + +Some of the translation files are not 100% complete. +If strings are missing, English is used instead. + + +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 DATABASE SERVER". + +NOTE: If you are behind a firewall and cannot download +the code with setup.pl, download the source code and +pass the filename as an argument on the command line. + + perl setup.pl sql-ledger-2.6.x.tar.gz + +VERY IMPORTANT: setup.pl tries to figure out your system +but it will not succeed if your distribution decided +to "hide" configuration files for your web server in some +other file. + + +INSTALLATION WITHOUT setup.pl: +------------------------------ +unpack the tar.gz file in /usr/local + + tar xzvf sql-ledger-2.6.x.tar.gz + +you should now have everything in /usr/local/sql-ledger + +rename ledger-smb.conf.default to ledger-smb.conf + +edit ledger-smb.conf + +create a file sql-ledger-httpd.conf in the same location +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 + AddDefaultCharset On + Options ExecCGI Includes FollowSymlinks + Order Allow,Deny + Allow from All + </Directory> + + <Directory /usr/local/sql-ledger/users> + Order Deny,Allow + Deny from All + </Directory> + +edit httpd.conf and add + + # SQL-Ledger + Include /config_directory/sql-ledger-httpd.conf + +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. + +Some versions of Apache 2.0 use a conf directory for +configuration files. If this is the case copy +sql-ledger-httpd.conf into this directory and leave +httpd.conf as is. + + +SET PERMISSION: +--------------- +change directory to /usr/local/sql-ledger + +# chown -hR nobody:nogroup users templates css spool + +replace nobody:nogroup with the web server user and group. +Some systems use apache:apache, www, www-data, ... + + +FTP INSTALLATION: +----------------- +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. + +a) untar sql-ledger in your private_html directory +b) turn on script execution for the folder sql-ledger +You can control this with an .htaccess file + + Options +ExecCGI + DirectoryIndex login.pl + +c) protect the users directory with an .htpasswd file + +AuthGroupFile /dev/null +AuthName "Unauthorized" +AuthType Basic +AuthUserFile /home/host.domain/private_html/sql-ledger/users/.htpasswd +require valid-user + +d) protect the templates directory with an .htpasswd file + +AuthGroupFile /dev/null +AuthName "Templates" +AuthType Basic +AuthUserFile /home/host.domain/private_html/sql-ledger/templates/.htpasswd +require valid-user + +e) set up your PostgreSQL database and the tables. + +You will most likely only have access to PostgreSQL with +some other tools like pgadmin. + +1) create a database user or use an assigned database user +2) create a blank database or use one which was created for you +3) load your web browser and connect to +http://host.domain.com/private_html/sql-ledger/admin.pl +to create the tables. + +There is no password so just hit the Enter key or click +on "Continue". + +Select the "Database Administration" link + +Host [database host] Port [ ] +User [database user] Password [for your database] +Connect to [your database] + +click on "Create Dataset" + +The next screen is for choosing a Chart of Accounts + +Create Dataset [your database] +Multibyte Encoding [ ] + +Select a chart of accounts and click on "Continue". + +Your tables will now be created and the chart of accounts +will be loaded. + +Go to the next step, "SET UP A USER" + + +PREPARE YOUR SQL DATABASE SERVER: +--------------------------------- + + PostgreSQL: + ----------- + add one database user with create database 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) n + + if you use passwords to access postgres use this command + $ createuser -d -P sql-ledger + + Install PL/PGSQL in template1 if it has not been installed yet + + # su postgres + $ createlang plpgsql template1 + + +SET UP A DATABASE AND TABLES: +----------------------------- +Load your web browser and connect to +http://localhost/sql-ledger/admin.pl + +Select the "Database Administration" link, +enter the user you created in the previous step. + +The "Create Dataset" link queries the server +for existing datasets and displays them in a +table. Enter a name for the new dataset (use +lowercase letters only!) and select one of the +Chart of Accounts and click on Continue. + +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. +You can connect to any other database you +own, template1 is only a default. + + +SET UP A USER: +------------- +Load your web browser and connect to +http://localhost/sql-ledger/admin.pl + +Click on "Add User". In the Database +section select the driver and enter +the user you used to create the dataset. + + +LOAD THE ACCOUNTING PROGRAM: +---------------------------- +Load your web browser and connect to +http://localhost/sql-ledger/login.pl + + +UPGRADING TO A NEWER VERSION: +----------------------------- +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. During the upgrade process the +dataset is locked so nobody can do any work. +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: +------------------------ +run setup.pl from the command line and follow the prompts. + + +INSTALLATION CHECKLIST: +----------------------- +1. untar LedgerSMB somewhere (i.e /usr/local, /opt) +2. change permission for the users, templates, css and spool directory +3. edit httpd.conf +4. edit ledger-smb.conf +5. add the database user sql-ledger +6. load admin.pl +7. create datasets for companies +8. add users + + In the Database section enter + + a) PostgreSQL + + Host: for local connections leave blank + Dataset: the dataset created in step 7 + Port: for local connections leave blank + User: sql-ledger + Password: password for sql-ledger + + +IF SOMETHING DOESN'T WORK: +-------------------------- +There is a FAQ at http://sourceforge.net/projects/ledger-smb//misc/faq.html +or see the one included in the doc directory. + +There are also several mailing lists at +http://sourceforge.net/projects/ledger-smb//misc/mailinglist.html +where you can seek free help. + +For commercial support see http://www.sql-ledger.com + +===================================================================== +June 14, 2006 + diff --git a/doc/README.DB2 b/doc/README.DB2 new file mode 100755 index 00000000..9d143bef --- /dev/null +++ b/doc/README.DB2 @@ -0,0 +1,82 @@ +To build and install the DBD::DB2 module, you need the following: + +*Perl 5.004_04 or later +*DBI 0.93 or later +*DB2 Application Development Client +*A supported C compiler as documented under + 'Supported Operating Systems' + at the DB2 Application Development Web page: + +http://www-3.ibm.com/software/data/db2/udb/ad/index.html + +Install Notes: + +http://www.perl.com/CPAN-local/modules/by-module/DBD/DBD-DB2-0.76.readme + +Module: + +http://www.perl.com/CPAN-local/modules/by-module/DBD/DBD-DB2-0.76.tar.gz + +Notes: +----------------------------- + +LedgerSMB tested with IBM DB2 v7.2 and v8.1. +Compiled for use with DBI 1.18 for all testing. + +DB2 Application Development Client used was with +the DB2 Personal Developer's Edition (PDE). All +databases and application code tested under RedHat +Linux 7.2 kernel 2.4.7-10. + +ADDITIONAL NOTES: DB2 specific +------------------------------ + +1. DB2 installed under default owner, and group: + db2inst1 and db2grp1. + +2. LedgerSMB app owner (ledger) was added to DB2 group db2grp1 + thereby given SYSADM authority. + +3. LedgerSMB app owner has same ENV variables as the db2inst1 user. + This can be added, or have: + . $DB_HOME/sqllib/db2profile in the LedgerSMB app owner .(bash_)profile. + +4. LedgerSMB app owner must have environment variable + DB2INSTANCE set. + +5. LedgerSMB app owner, now with SYSADM authority and PATH + containing DB2's bin should run the following: + + prompt>: db2set -all # To view instance and registry variables + prompt>: db2set DB2DBDFT=your_default_database_name i.e. LEDGER + prompt>: db2set DB2CLIINIPATH=set_to_usually $DB_HOME/sqllib/cfg + + Now, cd to the DB2CLIINIPATH directory and edit the db2cli.ini + file. Continuing with our use of LEDGER as the database that + will be created and used, add: + + [LEDGER] + AUTOCOMMIT=1 + LONGDATACOMPAT=1 + DBALIAS=LEDGER + DEFERREDPREPARE=1 + + If DEFERREDPREPARE=1 is the last line, add a blank line. A blank + line must be the last line. + +6. Create the database, objects, and initialize by moving to the directory: + /where_you_installed_SQL-Ledger/sql , and review the file + DB2-sql-ledger.order. The commands outlined are in the required order, + create a database called LEDGER using default SMS tablespaces. The + last command-line creates the "Default" Chart-of-Accounts. + + *Modify the files at will to: + create a different named database (make sure you review the + step where you -> db2set DB2DBDFT=your_default_database_name) + + create DMS tablespaces + + different Chart-of-Accounts. + + If a 'gifi' sql script needs to be run, make sure the + "db2 -tvf" is used so the ';' are accepted as command terminators. diff --git a/doc/UPGRADE-1.6-1.8 b/doc/UPGRADE-1.6-1.8 new file mode 100755 index 00000000..cc965849 --- /dev/null +++ b/doc/UPGRADE-1.6-1.8 @@ -0,0 +1,61 @@ +Upgrading from version 1.6 to 1.8 + +1. make a backup copy of your databases and SQL-Ledger, just in case! + $ cd /usr/local/www/sql-ledger + $ pg_dump database > db.out + $ tar cvf ~/sql-ledger.tar . + +2. install LedgerSMB over top of your old installation + $ cd /usr/local/www + $ tar zxvf sql-ledger-1.8.0.tar.gz + +3. change the tables to the new layout + $ cd sql-ledger/sql + $ psql database < upgrade-1.6-1.8.sql + +4. copy the new master templates to your template directory + $ cd ../templates + + $ cp Default-email_purchase_order.html your_template_dir/email_purchase_order.html + $ cp Default-purchase_order.html your_template_dir/purchase_order.html + $ cp Default-email_sales_order.html your_template_dir/email_sales_order.html + $ cp Default-sales_order.html your_template_dir/sales_order.html + +5. Two new accounts were hopefully added to your chart of accounts + One account for Foreign Exchange Gains and one for + Foreign Exchange Losses + edit and change to suit your COA. You can safely change + the account number too. + +6. Edit your preferences + + In field 'Stylesheet' enter -> sql-ledger.css + Stylesheet is in the css directory + + Add your foreign currencies in the Currencies field + The first currency in the list is your default + i.e CDN:USD:EUR:YEN + If you used a nativecurr than it should be listed in the + new currencies field. + +7. <%nativecurr%> has changed to <%currency%> + edit all your templates and change nativecurr to currency + +8. I also added four more variables which can be used in your templates. + <%contact%>, <%shiptocontact%>, <%shiptophone%>, <%shiptofax%> + +9. Nameing convention for templates has changed from an + underscore to a minus sign. If you designed your own + master templates rename the templates from + industry_invoice.html to industry-invoice.html, + industry_packing_list.html to industry-packing_list.html, etc. + The minus sign is used to separate the name and list them in + the setup screen. + + This change only applies to the master templates in the + templates root directory NOT the individual templates which + are used by users. + +It looks more than it really is. Steps 1 to 4 are important, +the rest is for fine tuning and info. + diff --git a/doc/UPGRADE-1.8-1.8.3 b/doc/UPGRADE-1.8-1.8.3 new file mode 100755 index 00000000..10522d14 --- /dev/null +++ b/doc/UPGRADE-1.8-1.8.3 @@ -0,0 +1,23 @@ +Upgrading from version 1.8.(0-2) to 1.8.3 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-1.8.3.tar.gz + +2. copy ledger-smb.conf.default to ledger-smb.conf + $ cp ledger-smb.conf.default ledger-smb.conf + + if you modified ledger-smb.conf merge the changes from the + .default file rather than copying over top. + +3. copy the new master templates to your template directory + $ cd ../templates + + $ cp Default-invoice.tex your_template_dir/invoice.tex + $ cp Default-packing_list.tex your_template_dir/packing_list.tex + $ cp Default-purchase_order.tex your_template_dir/purchase_order.tex + $ cp Default-sales_order.tex your_template_dir/sales_order.tex + +4. edit ledger-smb.conf + instructions are in the file + diff --git a/doc/UPGRADE-1.8.3-1.8.4 b/doc/UPGRADE-1.8.3-1.8.4 new file mode 100755 index 00000000..c4e9beaf --- /dev/null +++ b/doc/UPGRADE-1.8.3-1.8.4 @@ -0,0 +1,10 @@ +Upgrading from version 1.8.3 to 1.8.4 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-1.8.4.tar.gz + +2. update the tables with the admin script + + You will not be able to log in until you upgraded the tables. + diff --git a/doc/UPGRADE-1.8.4-1.8.5 b/doc/UPGRADE-1.8.4-1.8.5 new file mode 100755 index 00000000..68e1fbc6 --- /dev/null +++ b/doc/UPGRADE-1.8.4-1.8.5 @@ -0,0 +1,18 @@ +Upgrading from version 1.8.4 to 1.8.5 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-1.8.5.tar.gz + +2. update the tables with the admin script + + You will not be able to log in until you upgraded the tables. + + +There are two new variables (<%customernumber%> and <%vendornumber%>) +which can be used in the forms. These may be used instead of the +internally generated customer_id and vendor_id. + +Typically these numbers are used to retrieve a customer, vendor +by some ID. In most counter operations the phone number is used. + diff --git a/doc/UPGRADE-1.8.5-1.8.7 b/doc/UPGRADE-1.8.5-1.8.7 new file mode 100755 index 00000000..2c328609 --- /dev/null +++ b/doc/UPGRADE-1.8.5-1.8.7 @@ -0,0 +1,6 @@ +Upgrading from version 1.8.5 to 1.8.7 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-1.8.7.tar.gz + diff --git a/doc/UPGRADE-1.8.7-2.0.0 b/doc/UPGRADE-1.8.7-2.0.0 new file mode 100755 index 00000000..184f2605 --- /dev/null +++ b/doc/UPGRADE-1.8.7-2.0.0 @@ -0,0 +1,20 @@ +Upgrading to Version 2.0.0 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-2.0.0.tar.gz + +2. load admin.pl and update the tables + + You will not be able to log in until the tables are up to date. + +3. copy the new templates to your personal template directory + + $ cd templates + $ cp Default-check.tex dir/check.tex + $ cp Default-receipt.tex dir/receipt.tex + $ cp Default-statement.html dir/statement.html + $ cp Default-statement.tex dir/statement.tex + + replace 'dir' with your directory name + diff --git a/doc/UPGRADE-2.0-2.0.8 b/doc/UPGRADE-2.0-2.0.8 new file mode 100755 index 00000000..ae592d8a --- /dev/null +++ b/doc/UPGRADE-2.0-2.0.8 @@ -0,0 +1,8 @@ +Upgrading from version 2.0.[0-7] to 2.0.8 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-2.0.8.tar.gz + +2. update your datasets with the admin script + diff --git a/doc/UPGRADE-2.0.8-2.0.9 b/doc/UPGRADE-2.0.8-2.0.9 new file mode 100755 index 00000000..a18f1038 --- /dev/null +++ b/doc/UPGRADE-2.0.8-2.0.9 @@ -0,0 +1,6 @@ +Upgrading from version 2.0.8 to 2.0.9 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-2.0.9.tar.gz + diff --git a/doc/UPGRADE-2.0.9-2.2.0 b/doc/UPGRADE-2.0.9-2.2.0 new file mode 100755 index 00000000..f7386a74 --- /dev/null +++ b/doc/UPGRADE-2.0.9-2.2.0 @@ -0,0 +1,12 @@ +Upgrading from version 2.0.9 to 2.2.0 + +1. backup your datasets. Always a good idea! + +2. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-2.2.0.tar.gz + +3. copy Default-pos_invoice.txt to + templates/your_private_directory/pos_invoice.txt + and edit to suit. + diff --git a/doc/UPGRADE-2.2.0-2.2.7 b/doc/UPGRADE-2.2.0-2.2.7 new file mode 100755 index 00000000..ae4ba8b1 --- /dev/null +++ b/doc/UPGRADE-2.2.0-2.2.7 @@ -0,0 +1,11 @@ +Upgrading to version 2.2.7 + +1. install LedgerSMB over top + # cd /usr/local + # tar zxvf sql-ledger-2.2.7.tar.gz + +2. fix permissions + # chown -R nobody:nogroup * + # chmod 711 templates users + +Note: replace nobody:nogroup with your web server user and group diff --git a/doc/UPGRADE-2.2.7-2.4.0 b/doc/UPGRADE-2.2.7-2.4.0 new file mode 100755 index 00000000..b5c317b2 --- /dev/null +++ b/doc/UPGRADE-2.2.7-2.4.0 @@ -0,0 +1,84 @@ +Upgrading to version 2.4.0 + +1. install LedgerSMB over top + # cd /usr/local + # tar zxvf sql-ledger-2.4.0.tar.gz + +2. fix permissions + # chown -hR nobody:nogroup * + # chmod 711 templates users spool + +replace nobody:nogroup with your web server user and group + +3. install the plpgsql language compiler for PostgreSQL + # createlang plpgsql <dataset> + +4. install plpgsql in template1 + # createlang plpgsql template1 + +5. Edit your templates! The old address fields are obsolete. + +The new fields are: + address1 + address2 + city + state + zipcode + country + +The same applies to the "shipto" addresses. + +Before you log in edit Pg-upgrade-2.3.4-2.3.5.sql and change the +way addresses are rewritten if you don't want US style addresses. + +North-american addresses are usually in the form of + +Five Star Stables +123 Horsehoe Blvd. +Sweetgrass, MT 19867 +U.S.A + +addr1 --> address1 +addr2 --> city +addr3 --> country +addr4 --> state + +addr4 was put into the state field to bring the field forward +to the new layout. To check if there is something in the field run +a report and sort by the "State" field. + +Either edit the records or run the SQL queries below to take them apart. + +If you have anything in the "state" field change the records to match +the others before you run the following queries. + +dbname=# update customer set state = substr(city,strpos(city,' ')+1); +dbname=# update customer set zipcode = substr(state,strpos(state,' ')+1); +dbname=# update customer set state = substr(state,1,strpos(state,' ')-1); +dbname=# update customer set city = substr(city,1,strpos(city,',')-1); + +do the same with the vendor and shipto table. + +6. create a new set of templates + + * load admin.pl and edit one of the user's + * in the "New Templates" field enter "new" and save the user + * go back in your browser so you have the same screen again + as before + * change the template directory back to what it was before + the change and save the user + + * drop into a shell window + * cd to sql-ledger/templates/new + * copy the additional templates to your private template directory + +7. Printers + +printer setup has changed to multiple printers which allow +users to choose a printer. Printers can be defined in ledger-smb.conf + + +Oracle and DB2: +=============== +There is no upgrade available for Oracle and DB2 yet. + diff --git a/doc/UPGRADE-2.4.0-2.4.2 b/doc/UPGRADE-2.4.0-2.4.2 new file mode 100755 index 00000000..9172849e --- /dev/null +++ b/doc/UPGRADE-2.4.0-2.4.2 @@ -0,0 +1,12 @@ +Upgrading from version 2.4.(0-1) to 2.4.2 + +1. install LedgerSMB over top + # cd /usr/local + # tar zxvf sql-ledger-2.4.x.tar.gz + +2. fix permissions + # chown -hR nobody:nogroup * + # chmod 711 templates users css spool + +Note: replace nobody:nogroup with your web server user and group + diff --git a/doc/UPGRADE-2.4.16-2.6.0 b/doc/UPGRADE-2.4.16-2.6.0 new file mode 100755 index 00000000..86c9baff --- /dev/null +++ b/doc/UPGRADE-2.4.16-2.6.0 @@ -0,0 +1,19 @@ +Upgrading from version 2.4 to 2.6 + +1. install LedgerSMB over top + # cd /usr/local + # tar zxvf sql-ledger-2.6.x.tar.gz + +2. fix permissions + # chown -hR nobody:nogroup * + # chmod 711 templates users css spool + +Note: replace nobody:nogroup with your web server user and group + +3. Copy the new templates to your private template directory + + $ cp Default-timecard.html your_template_dir/timecard.html + $ cp Default-timecard.tex your_template_dir/timecard.tex + +4. log in + diff --git a/doc/UPGRADE-2.4.2-2.4.3 b/doc/UPGRADE-2.4.2-2.4.3 new file mode 100755 index 00000000..70a096d0 --- /dev/null +++ b/doc/UPGRADE-2.4.2-2.4.3 @@ -0,0 +1,22 @@ +Upgrading from version 2.4.2 to 2.4.3 + +1. install LedgerSMB over top of your old installation + $ cd /usr/local + $ tar zxvf sql-ledger-2.4.3.tar.gz + +2. fix permissions + # chown -hR nobody:nogroup * + # chmod 711 templates users css spool + + Note: replace nobody:nogroup with your web server user and group + +3. copy the following templates to your template directory + $ cd templates + + $ cp Default-ar_transaction.html your_template_dir/ar_transaction.html + $ cp Default-ar_transaction.tex your_template_dir/ar_transaction.tex + $ cp Default-ap_transaction.html your_template_dir/ap_transaction.html + $ cp Default-ap_transaction.tex your_template_dir/ap_transaction.tex + +4. log in + diff --git a/doc/UPGRADE-2.4.3-2.4.16 b/doc/UPGRADE-2.4.3-2.4.16 new file mode 100755 index 00000000..a0e24f4b --- /dev/null +++ b/doc/UPGRADE-2.4.3-2.4.16 @@ -0,0 +1,12 @@ +Upgrading from version 2.4.(3-15) to 2.4.16 + +1. install LedgerSMB over top + # cd /usr/local + # tar zxvf sql-ledger-2.4.x.tar.gz + +2. fix permissions + # chown -hR nobody:nogroup * + # chmod 711 templates users css spool + +Note: replace nobody:nogroup with your web server user and group + diff --git a/doc/UPGRADE-2.6.0-2.6.17 b/doc/UPGRADE-2.6.0-2.6.17 new file mode 100755 index 00000000..3965bb00 --- /dev/null +++ b/doc/UPGRADE-2.6.0-2.6.17 @@ -0,0 +1,14 @@ +Upgrading from version 2.6.(0-16) to 2.6.17 + +1. install LedgerSMB over top + # cd /usr/local + # tar zxvf sql-ledger-2.6.17.tar.gz + +2. fix permissions + # chown -hR nobody:nogroup * + # chmod 711 templates users css spool + +Note: replace nobody:nogroup with your web server user and group + +3. log in + diff --git a/doc/faq.html b/doc/faq.html new file mode 100755 index 00000000..ff0999ab --- /dev/null +++ b/doc/faq.html @@ -0,0 +1,707 @@ +<ul> +<p><li><h4>PostgreSQL 8.x</h4> +PostgreSQL added a restriction in v8.x that a sequence cannot be dropped +after if it is referenced by a table. However backups created with +LedgerSMB v2.6.13 and earlier have a DROP SEQUENCE step in the backup +which will fail. To fix this edit the backup before restoring on a 8.x +system. + +<p>This typically looks like this: +<pre> +DROP SEQUENCE id ; +CREATE SEQUENCE id START 10579; +-- +DROP SEQUENCE invoiceid ; +CREATE SEQUENCE invoiceid START 11096; +-- +DROP SEQUENCE orderitemsid ; +CREATE SEQUENCE orderitemsid START 178; +-- +DROP SEQUENCE jcitemsid ; +CREATE SEQUENCE jcitemsid START 53; +</pre> + +<p>Change it to: +<pre> +CREATE SEQUENCE id; +SELECT SETVAL('id', 10579); +CREATE SEQUENCE invoiceid; +SELECT SETVAL('invoiceid', 11096); +CREATE SEQUENCE orderitemsid; +SELECT SETVAL('orderitemsid', 178); +CREATE SEQUENCE jcitemsid; +SELECT SETVAL('jcitemsid', 53); +</pre> + + +<p><li><h4>PostgreSQL template1</h4> +template1 is a template to build new databases +from. Anything you put into template1 will be copied to a new database. +So when you try to create a new dataset, the tables are already created from +template1 and when LedgerSMB tries to create them you'll get an error that +the tables already exist. + + +<p><li><h4>PostgreSQL 8.0+</h4> +To use LedgerSMB with 8.0+ you have to modify Pg-tables.sql The file +is in the sql directory. + +<pre> +CREATE TABLE orderitems ( + trans_id int, + parts_id int, + description text, + qty float4, + sellprice float8, + discount float4, + unit varchar(5), + project_id int, + reqdate date, + ship float4, + serialnumber text, + id int default nextval('orderitemsid') +) WITH OIDS; + +CREATE TABLE inventory ( + warehouse_id int, + parts_id int, + trans_id int, + orderitems_id int, + qty float4, + shippingdate date, + employee_id int +) WITH OIDS; + +CREATE TABLE assembly ( + id int, + parts_id int, + qty float, + bom bool, + adj bool +) WITH OIDS; +</pre> + +This change is only required for LedgerSMB versions 2.6.3 and below. + +<p>If you already built a dataset without this change you will get +an error when you try to save a PO or assembly. +<p>"ERROR: column "oid" does not exist" + +<p>Drop the tables and rebuild WITH OIDS. + + +<p><li><h4>Japanese characters</h4> +modify apache so that EUC_JP is the main additional language. +<br>comment out all unrelated languages except, UTF_8 shift jis, EUC_JP +<br>restart apache +<br>Fire up psql and do the encoding as per the table:- +<br>Table 5-2. Postgres Client/Server Character Set Encodings + +<p>Server Encoding Available Client Encodings +<br>EUC_JP EUC_JP, SJIS +<br>EUC_TW EUC_TW, BIG5 +<br>LATIN2 LATIN2, WIN1250 +<br>LATIN5 LATIN5, WIN, ALT +<br>MULE_INTERNAL EUC_JP, SJIS, EUC_KR, EUC_CN, EUC_TW, BIG5, LATIN1 to LATIN5, WIN, ALT, WIN1250 + +<p>Create the dataset from admin.pl, now the Japanese shows up in multibyte encoding + +<p>Now you can write in Hiragana, Katakana, Kanji and English + + +<p><li><h4>Error posting a check/receipt</h4> +<pre> +DBD::Pg::db do failed: ERROR: syntax error at or near "," at character 114 +Error! +INSERT INTO acc_trans (trans_id, chart_id, transdate,amount) +VALUES (13314, , '03-22-2005',1.00 * 1) +ERROR: syntax error at or near "," at character 114 </pre> +This error is caused by a transaction which does not have links to +an AR/AP account. +<br>set up your chart of accounts properly and create at least one +AR and AP account. Then edit all your transactions and repost. + + +<p><li><h4>SELinux</h4> +<a href=http://fedora.redhat.com/docs/selinux-faq-fc3/index.html>http://fedora.redhat.com/docs/selinux-faq-fc3/index.html</a> + +<p>modify /etc/selinux/conf and set SELINUX=permissive + +<p>use audit2allow and add the following to policy.conf, +then run "make reload" + +<p>#line 83 +<br>allow httpd_sys_script_t port_type:{ tcp_socket udp_socket } { send_msg +recv_msg }; +<br>allow httpd_sys_script_t sysctl_kernel_t:dir search; +<br>allow httpd_sys_script_t sysctl_t:dir search; +<br>allow httpd_sys_script_t tmp_t:sock_file write; +<br>allow httpd_sys_script_t httpd_sys_content_t:lnk_file read; +<br>allow httpd_sys_script_t sysctl_kernel_t:file read; +<br>allow httpd_sys_script_t unconfined_t:unix_stream_socket connectto; + + +<p><li><h4>session timeouts</h4> +If you get frequent timeouts or can't even log in synchronize +the clocks from the server and workstation. + + +<p><li><h4>lineitems not printing</h4> +Templates designed on a UNIX platform don't work on a DOS platform. +To make them work load the template either with the builtin template editor +or a text editor and save. Templates designed on a Windows platform have the +same problem and won't work on a UNIX platform. Once you strip the ^M's +the'll work just fine. + + +<p><li><h4>UTF-8 character encoding</h4> +Most of the translations are in ISO format. To convert the translations +change directory to locale/cc and convert the files with iconv to UTF-8. +You should also convert the COAs too and make sure you select UTF-8 +encoding when you set up a new dataset. + + +<p><li><h4>characterset problems</h4> +If you have problems displaying the correct characterset try adding +<pre> + AddDefaultCharset On</pre> +in your httpd.conf file. + +<p><li><h4>About installation</h4> +The easiest is to use the setup.pl script as root. +You don't need to know very much about your system, just login as root, +run 'perl setup.pl' and follow the prompts. +<p>setup.pl does not check for missing software packages and it is your +responsibilite to make sure you have the required software +installed either from source or from a package. + +<p>Requirements are clearly indicated in the README file and on the +download page. + + +<p><li><h4>cannot create function</h4> +<ol> +<li>either run createlang and install the plpgsql language handler or +install yourself. For more information how to do that, visit +<a href=http://www.postgresql.org/docs/>PostgreSQL</a> and +read the interactive documentation for procedural languages. + +<li>load admin.pl +<li>unlock the system +<li>login +</ol> + + +<p><li><h4>The requested URL /sql-ledger/admin.pl was not found</h4> +Your webserver doesn't know where to find the script. Most commonly this +is from distributions hiding webserver configuration files in different +locations or files and setup.pl wasn't able to configure the location for +you. Find out which file (httpd.conf, httpdcommon.conf, ...) +controls your webserver configuration and add +<pre> + # SQL-Ledger + Include /etc/httpd/sql-ledger-httpd.conf</pre> + +Create a file 'sql-ledger-httpd.conf' in /etc/httpd and copy the next part +into the file. + +<pre> + AddHandler cgi-script .pl + AddDefaultCharset On + Alias /sql-ledger /var/www/sql-ledger/ + <Directory /var/www/sql-ledger> + Options ExecCGI Includes FollowSymlinks + </Directory> + + <Directory /var/www/sql-ledger/users> + Order Deny,Allow + Deny from All + </Directory></pre> +replace '/etc/httpd' and '/var/www' with the appropriate directories. + + +<p><li><h4>users/members : Permission denied</h4> +Your webserver must have write access to the users directory. +If your server runs as user/group 'apache:apache' then set the +users directory to owner/group apache:apache. +<pre> + # chown -R apache:apache users</pre> + + +<p><li><h4>Dataset newer than version</h4> +You are trying to use an older version with a dataset which was +created with a newer version. + + +<p><li><h4>PDF option not working</h4> +Check if you have latex and pdflatex installed. + + +<p><li><h4>Apache 2.0 "error 500"</h4> +Some of the early versions of Apache 2.0 (< patchlevel 44) had a rewrite engine +which decoded escaped strings. This created a lot of problems and I worked +around it by escaping strings twice. +If you get a server 500 error 'filename too long' or if collapsed menus +don't expand you may have to adjusted the following code in +SL/Form.pm and change the number (44) on line 84. +<pre> + # for Apache 2 we escape strings twice + if (($ENV{SERVER_SIGNATURE} =~ /Apache\/2\.(\d+)\.(\d+)/) && !$beenthere) { + $str = $self->escape($str, 1) if $2 < 44; + }</pre> + + +<p><li><h4>IDENT Authentication failed for user "sql-ledger"</h4> +Edit pg_hba.conf and change authentication to + +<pre> + local all all trust</pre> + +The file is in the 'data' directory of your postgresql installation. +This is different with every distribution so look for it. +<pre> + # find / -name 'pg_hba.conf'</pre> + +<p>Some people can't read and seem to think 'localhost' is just some +fancy word for a local machine. +'localhost' is a host like any other host on a network. +A 'local' entry in pg_hba.conf will allow socket connections ONLY and +not allow a host connection. If you then try to connect to 'localhost' +postgres will come back with an authentication error. + +<p>So, forget you ever heard there is such a thing as 'localhost' and leave +the Host portion blank. + +<p><b>WARNING!</b> DO NOT just put a 'host all all trust' in pg_hba.conf +unless you know what you are doing. + + +<p><li><h4>DBD-Pg for Mandrake 9.0</h4> +Mandrake did not package a compiled DBD-Pg package again, so install DBD-Pg +from the source package. +Install perl-DBD-Pg-1.01-4mdk.i586.rpm from the 'contrib' area. +(Mandrake / 9.0 / contrib / RPMS) + + +<p><li><h4>LaTeX error</h4> +If for some reason LaTeX produces an error message check for strange +characters in your account description and parts description +and use \usepackage[latin1]{inputenc} in the preamble. + + +<p><li><h4>LaTeX templates</h4> +If you don't want to edit tex code by hand, +you could use Lyx, Abiword, or any WYSIWYG editor capable of exporting +latex code. +To do that you must change the tokens for the variables <% and %> to something +like << and >>. % is the comment character in tex. There is also a +pagebreak block which must be commented out. +When you are done with the changes +replace << and >> with <% and %> and uncomment the pagebreak block. + +<p>LaTeX is difficult but it also offers a much superior environment +to produce professionally looking forms in postscript and PDF format. +Unfortunately with all that power there is also a steep learning curve. + + +<p><li><h4>W3M</h4> +pass terminal=mozilla when you start w3m +<pre> + $ w3m -F http://localhost/sql-ledger/login.pl?terminal=mozilla</pre> + +To use without frames +<pre> + $ w3m http://localhost/sql-ledger/login.pl?terminal=lynx</pre> + +<p><li><h4>PDF option disappeared</h4> +Edit ledger-smb.conf and set $latex = 1; +<br>ledger-smb.conf is perl code, check if it compiles, if it does not, +the internal defaults are used which turn off $latex, hence no PDF option. + +<p><li><h4>Installation on Windows (WIN32)</h4> +<ul> +<li>install Apache, perl, +<a href=http://techdocs.postgresql.org/guides/InstallingOnWindows>Postgres</a> +or Oracle, DBI and the appropriate DBD +module +<br>if you can't compile DBD-Pg here is a precompiled +<a href=http://www.edmund-mergl.de/export/>DBD-Pg module</a> +<li>download the latest version of <a href=/cgi-bin/nav.pl?page=source/index.html&title=Download>SQL-Ledger</a> +<li>extract the files to c:\apache\sql-ledger +<li>run 'perl shebang' to change the first line of the scripts. If perl +is not in c:\perl\bin' change '#!c:\\perl\\bin\\perl' to the location where +your perl binary is. +<li>edit c:\apache\conf\httpd.conf and add +<pre> +Alias /sql-ledger "c:/apache/sql-ledger/" +<Directory "c:/apache/sql-ledger"> + AllowOverride All + AddHandler cgi-script .pl + AddDefaultCharset On + Options +ExecCGI + Order Allow,Deny + Allow from All +</Directory> + +<Directory "c:/apache/sql-ledger/users"> + Order Deny,Allow + Deny from All +</Directory> +</pre> + +<li>start Apache +<li>start Postgres|Oracle|DB2 +<li>connect to http://localhost/sql-ledger/admin.pl and set up users +and datasets +<li>connect to http://localhost/sql-ledger/login.pl and login + +</ul> + +<p><li><h4>Installation on Windows /w cygwin</h4> +<ul> +<li>install <a href=http://sources.redhat.com/cygwin/>cygwin</a> +Apache, perl, postgres, gcc and lynx +<li>install <a href=http://search.cpan.org/search?module=DBI>DBI</a> +<li>tar zxvf DBI-1.30.tar.gz +<li>cd DBI-1.30 +<li>perl Makefile.PL +<li>make install +<li>install <a href=http://search.cpan.org/search?dist=DBD-Pg>DBD-Pg</a> +<li>tar -zxvf DBD-Pg-1.13.tar.gz +<li>export POSTGRES_INCLUDE=/usr/include/postgresql +<li>export POSTGRES_LIB=/usr/lib/postgresql +<li>cd DBD-Pg-1.13 +<li>perl Makefile.PL +<li>make install +<li>edit /etc/apache/httpd.conf and add +<pre> +AddHandler cgi-script .pl +AddDefaultCharset On +Alias /sql-ledger /var/www/sql-ledger/ +<Directory /var/www/sql-ledger> + Options +ExecCGI +</Directory> + +<Directory /var/www/sql-ledger/users> + Order Deny,Allow + Deny from All +</Directory> +</pre> +<li>install SQL-Ledger +<li>cd /var/www +<li>mkdir sql-ledger +<li>download <a href=/cgi-bin/download.pl?setup.pl>setup.pl</a> and save the file +in /var/www/sql-ledger +<li>cd /var/www/sql-ledger +<li>perl setup.pl +</ul> + +<p><li><h4>What do I enter for the language</h4> +If you use English, nothing, if you want to use a foreign language for +the login screen and admin stuff enter the language code, this is the +directory in the locale directory. + + +<p><li><h4>printing to a printer</h4> +Printers are defined in ledger-smb.conf + +<pre> +%printer = ( 'Default' => 'lpr', 'Color' => 'lpr -PEpson' );</pre> + +Check in your /etc/printcap file for the names of available printers. + +<p>If you have LaTeX installed set +<pre> + $latex = 1</pre> in ledger-smb.conf + +<p>To send the document to the printer check the "Postscript" or "PDF" format, +enter the number of copies and click on the "Print" button. + +<p>The printer you enter in your preferences is the default printer. +You can choose any other available printer. This makes it possible +to print from anywhere on the network to any printer. + +<p>Note: html format is for screen preview. Use the "Print" option from your +browser to print to a printer. + + +<p><li><h4>Using samba to send printjobs to a printer attached to a Windows XP workstation</h4> +The next part applies to roll your own print filters only. If you use CUPS or +LPRng your milage may vary but you can still use this as a guide how it works. +I use the printer 'Epson' as an example which is +attached to a XP workstation called Raven. + +<pre> +/etc/printcap entry on the server which runs lpd + +epson:Epson\ + :sh:\ + :lp=/dev/null:\ + :sd=/var/spool/output/epson:\ + :if=/usr/libexec/lpr/epson/prnfilter:\ + +# end of entry in /etc/printcap + + +# prnfilter shell script +#!/bin/sh +# Filter for Epson Stylus + +PATH="$PATH:/usr/local/bin" + +#read first_line +read tmp +first_line=`echo $tmp | cut -b1-2 | sed -n '1p'` + +first_chr=`expr "$first_line" : '\(.\)'` +first_two=`expr "$first_line" : '\(..\)'` +rewindstdin + +if [ "$first_two" = "%!" ]; then # Postscript file + gs @st640p.upp -dSAFER -dNOPAUSE -q -sOutputFile=/tmp/$$ - +else + # text file + cat > /tmp/$$ + echo -n "^L" >> /tmp/$$ + smbclient '\\Raven\Epson' "" -c 'printmode text' +fi + +smbclient '\\Raven\Epson' "" -P -c "print /tmp/$$" +rm /tmp/$$ + +# EOF + + +rewindstdin is a small program to rewind the filehandle for STDIN +save the next part up to EOF to a file rewindstdin.c and compile + +#include <sys/types.h> +#include <unistd.h> +extern int errno; +main() +{ + if( lseek(0,0,0) == 0 ){ + errno = 0; + } + return( errno ); +} + +# EOF + +compile to an executable + +gcc -o /usr/local/bin/rewindstdin rewindstdin.c +</pre> + + +<p><li><h4>beginning balances</h4> +Add a GL Journal entry and enter the beginning balance for your accounts. +Beginning balances are the balances from your last balance sheet. If you also +add open invoices to account for COGS for inventory, add the invoices +and make the appropriate adjustments. + + +<p><li><h4>establish a beginning inventory</h4> +add the parts with a vendor invoice. Use the <b>real cost</b> for the items, +not zero. If you use zero cost then the cost of goods will be zero when you +sell the item. + + +<p><li><h4>Assemblies</h4> +Assemblies are manufactured goods assembled from parts, services and +assemblies. Because you do not buy assemblies you 'stock assemblies' by +adding assembled units to your inventory. The quantity for individual parts +is reduced and the quantity for the assembly increased. To disassemble an +assembly you simply return the parts to inventory by entering a negative +quantity for the number of assemblies to stock. + + +<p><li><h4>customizing SQL-Ledger</h4> +The <a href=/cgi-bin/nav.pl?page=feature/api.html&title=Application%20Interface>application interface</a> +consists of a global and private interface. + + +<p><li><h4>DBD-Pg not installed</h4> + +Most modern distributions now package DBD-Pg. If it is +not packaged follow this recipe to get it working. + +<ul> + <li>check if you have the header files for PostgreSQL + <br>$ find / -name 'libpq-fe.h' + <br>if nothing shows up install the development package for PostgreSQL + <li>download and untar DBD-Pg + <li>set the environment variables POSTGRES_LIB and POSTGRES_INCLUDE + <li>cd to DBD-Pg directory + <br>as ordinary user + <br>$ perl Makefile.PL + <br>$ make + <br>$ make test + <br>if all went well su to root + <br># make install + <li>remove DBD-Pg +</ul> + + +<p><li><h4>login.pl has compilation error</h4> + +This could be because of a missing configuration file in the users directory + +<p>check the permission for the users directory. The directory must be +set writeable for the webserver. If your webserver runs ias user/group +nobody.nogroup set the directory to +<pre> +drwx--x--x 2 nobody nogroup 1024 May 26 16:49 users + +or + +drwxrwx--x 2 johndoe nogroup 1024 May 26 16:49 users</pre> + + +<p><li><h4>script not executing, shows in browser instead</h4> + +Add +<pre> + AddHandler cgi-script .pl</pre> +in your httpd.conf file. + + +<p><li><h4>unknown terminal!</h4> +the frontend script couldn't figure out which browser you are using +<p>include the terminal variable on the URL +<pre> + http://localhost/sql-ledger/login.pl?terminal=lynx</pre> +Valid terminal variables are lynx, mozilla and js + + +<p><li><h4>permission denied</h4> + +Check if your web server has write permission to write to the following +files and directories: +<pre> + users/ + templates/ + users/members + + # chown nobody:nogroup users templates users/members +</pre> + + +<p><li><h4>permission denied to access tables</h4> +The user you entered in the "Database section" must be a valid +database user who has rights to access the tables. + +<p>If the tables are owned by 'joe' and you enter 'mary' as the dba +you might run into this problem if mary doesn't have the rights to +access tables owned by joe. + + +<p><li><h4>html and graphics files don't show up on screen</h4> + +Enable Includes and FollowSymlinks Options in your httpd.conf file +<pre> + <Directory /usr/local/sql-ledger> + Options ExecCGI Includes FollowSymlinks + </Directory> +</pre> + + +<p><li><h4>switch display to a foreign language</h4> + +Load your preferences and select the language. +<br>Language selection is in accordance to +<a href=http://www.unece.org/cefact/locode/service/main.htm> +ISO 3166-1</a> standards. + + +<p><li><h4>Text shows in English when I use a foreign language</h4> + +This is because the corresponding hash entry is missing. +Add the missing text in the locale/cc/all or locale/cc/missing +file and run 'perl locales.pl' from the command line to rebuild +the individual files. + +<br>cc refers to the country code. + + +<p><li><h4>switch to a foreign language for the login and admin screen</h4> + +Edit ledger-smb.conf and enter the code for the $language variable +<pre> + $language = "de";</pre> + +<p>This is a global change and applies to all logins, individual settings +may be changed by setting the language in your Preferences. + + +</ul> + +<p> +<hr> +<a name=security> +<h1>LedgerSMB security</h1> +</a> + +<ul> +<li>The security features built into LedgerSMB provide encrypted passwords +and access control which makes it fairly safe out of the box to run even in +front of a firewall. +Some precautions which are out of our control must be taken though. +It matters where you install SL and how you configure your web server and +SQL server. + +<pre> + Typical setups: + + /usr/local/vh/www <- DocumentRoot for virtual host + /usr/local/vh/sql-ledger <- Alias for sql-ledger + /usr/local/vh/users <- users directory out of reach + +<hr width=60% align=left> + /usr/local/vh/www <- DocumentRoot for virtual host + /usr/local/vh/www/sql-ledger <- Alias for sql-ledger + /usr/local/vh/www/sql-ledger/users <- users configuration files and tmp space + + <Directory /usr/local/vh/www/sql-ledger/users> <- disable webserver access + Order Deny,Allow for users directory + Deny from All + </Directory> + +</pre> + +The location for the users directory can be specified in ledger-smb.conf + +<p><li>Set permission for the users and templates directory to 711 + +<p><li>If you do not want anyone to change the templates with the built-in +editor set the files in templates/directory/ to read only or disable +the menu item to edit the templates. + +<p><li>You can set up a read-only environment if you disable the menu items +to add data. i.e 'Add Transaction' if unchecked you will not be able to add +a transaction or repost a transaction. You may look at it but nothing else. + +<p><li>There are various settings for audit control and you may disable +reposting entirely or up to a certain date. And with the audit trail enabled +you can keep tab of who is doing what. + +<p><li>For PostgreSQL you may also set who has access to the server in the file +pg_hba.conf +<br>Authentication crypt does not work because not all SQL servers +accept encrypted passwords. + +<p><li>in addition you can secure the tables from unauthorized access by +setting up a different database user and GRANT rights. For instance, +users without DELETE rights will still be able to use the program, change +customers and vendors, add transactions but will not be able to delete or +repost transactions. +<br>To lock all the tables to create a RO system GRANT SELECT rights only. + +<p><li>Other security options include a secure shell, your webserver's +authentication system, SSL, encrypted tunnels, ... + +</ul> + +</BODY> +</HTML> + |