summaryrefslogtreecommitdiff
path: root/doc/README
blob: 619b725276f9372c5459b2bbe5018393a5cdf74b (plain)
  1.                 LedgerSMB Small Medium Business Accounting
  2. Version 1.2.0
  3. DESCRIPTION:
  4. ------------
  5. LedgerSMB is a double-entry accounting system written
  6. in perl. It has been tested with PostgreSQL, Apache,
  7. Netscape, Mozilla, Galeon, Explorer, Links, Lynx,
  8. Konqueror, Voyager, W3M and Opera clients on Linux,
  9. FreeBSD, Solaris, Windows, Mac computers and PDA's.
  10. Data is stored in a PostgreSQLSQL database server, either
  11. locally or remote, the display is through a text or GUI web
  12. browser. The system is linked by a chart of accounts. All
  13. transactions for AR, AP and GL are stored in a transaction
  14. table. Hyper-links from the chart of accounts let you view
  15. transactions posted through AR, AP and GL.
  16. Configuration files let you specify to which SQL database server
  17. to connect to, personal preferences such as company name,
  18. language, number and date format, etc.
  19. With the admin script you can create, edit or delete users,
  20. create and delete datasets and set up the Chart of Accounts
  21. and templates needed for the system.
  22. You can have a group of users using the same dataset and
  23. templates for generating Invoices, Income Statements and
  24. Balance Sheets or a different set altogether.
  25. Templates are supplied in html, text and tex format to
  26. generate most of the forms. Forms can be printed to screen,
  27. sent to a printer or e-mailed.
  28. COPYRIGHT:
  29. ----------
  30. Licensed under the terms of the GPL.
  31. LATEST VERSION:
  32. ---------------
  33. available from http://www.ledgersmb.org/
  34. PLATFORMS:
  35. ----------
  36. Non specific, see requirements.
  37. REQUIREMENTS:
  38. -------------
  39. 1 - Perl, 5.8+
  40. 2 - http server (Apache, NCSA, httpi, thttpd, ...)
  41. 3 - SQL Server (PostgreSQL 8.0+)
  42. 4 - DBD (DBD-Pg)
  43. 5 - DBI
  44. 6 - Locale::Maketext::Lexicon 0.56+
  45. 7 - LaTeX (optional)
  46. FOREIGN LANGUAGE SUPPORT:
  47. -------------------------
  48. 28 languages are supported. Language files are
  49. ordinary text files, no special software is
  50. needed to change or add new translations.
  51. Some of the translation files are not 100% complete.
  52. If strings are missing, English is used instead.
  53. INSTALLATION INSTRUCTIONS:
  54. --------------------------
  55. Please see the INSTALL file in the root installation directory of LedgerSMB.
  56. SET UP A USER:
  57. -------------
  58. Load your web browser and connect to
  59. http://localhost/ledger-smb/admin.pl
  60. Click on "Add User". In the Database
  61. section select the driver and enter
  62. the user you used to create the dataset.
  63. LOAD THE ACCOUNTING PROGRAM:
  64. ----------------------------
  65. Load your web browser and connect to
  66. http://localhost/ledger-smb/login.pl
  67. INSTALLATION CHECKLIST:
  68. -----------------------
  69. 1. untar LedgerSMB somewhere (i.e /usr/local, /opt)
  70. 2. change permission for the users, templates, css and spool directory
  71. 3. edit httpd.conf
  72. 4. edit ledger-smb.conf
  73. 5. add the database user ledger-smb
  74. 6. load admin.pl
  75. 7. create datasets for companies
  76. 8. add users
  77. In the Database section enter
  78. a) PostgreSQL
  79. Host: for local connections leave blank
  80. Dataset: the dataset created in step 7
  81. Port: for local connections leave blank
  82. User: ledger-smb
  83. Password: password for ledger-smb
  84. IF SOMETHING DOESN'T WORK:
  85. --------------------------
  86. There is a FAQ in the doc directory.
  87. There are also several mailing lists at
  88. http://www.ledgersmb.org/
  89. where you can seek free help.
  90. For commercial support see http://www.ledgersmb.org/
  91. =====================================================================
  92. September 24, 2006