INSTALLATION MANUAL

General Description :

CK-ERP is an open source accounting / ERP / CRM system written in php and operates above eGroupWare / Xaraya / Horde / TikiWiki / phpBB. It runs as a web application with Apache and eGroupWare / Xaraya / Horde / TikiWiki / phpBB serving as middle layer. Internal data is managed by PostgresSQL/MySQL. SQL server can either be local or remote. Client access is via web browsers, Konqueror, Mozilla, Netscape, Opera and the like.

Functionally, it is divided into 20 modules:
Contact Management, Customer Relationship Management, Customer Self Service, Vendor Relationship Management, General Ledger, Bank Reconciliation, Inventory, Service, Accounts Payable, Accounts Receivable, Purchase Order, Sales Order, Quotation, POS for Cashier, POS for Manager, Human Resources, Staff Self Service, Payroll, Administration, Internationalization.

Each of these modules can be made visible or hidden from users/groups utilizing eGroupWare's native account management function.

Most transactions are provided with standard search, add, view, copy, edit, delete and view log facilities. Journal reversing feature is included. Two separate streams are provided to handle invoices, POs, SOs, Quotations and Cash Sale that do and do not carry transactional tax (sales tax or VAT). For detail features, please refer to the Features List (Docs).

Demo Sites:

http://ck-erp.sourceforge.net (hosted within egroupware)
http://ck-erp.org (hosted within egroupware)
http://ck-erp.org/xaraya/html/index.php (hosted within Xaraya)
http://ck-erp.org/horde/login.php (hosted within Horde)
http://ck-erp.org/tikiwiki/tiki-index.php (hosted within TikiWiki)
http://ck-erp.org/phpbb/login.php (hosted with phpBB)
http://ck-erp.byethost33.com (fast server located in Columbus, US)

Latest Version :

The latest version is available from,
http://sourceforge.net/projects/ck-erp
http://gro.clinux.org/projects/ck-ledger
http://cosoft.org.cn/projects/ck-ledger
http://sf.linuxforum.net/projects/ck-ledger

Platforms :
CK-ERP has been tested against the following configurations (LAMP + eGW / Xaraya / Horde / TikiWiki / phpBB),

Php.ini Setting:
register_globals may be set to [on] or [off] (with [off] being recommended)

Hardware Requirement :
If everything (O/S, webserver, dbserver, egroupware/phpbb, client GUI, browser) runs on a single machine, the system will probably need at least,
CPU – Intel Pentium III 600mhz, RAM – 256M, H/D – 40M (excluding the space needed to house the accounting data, which varies depending on transaction volume). [However, if other middleware modules are utilizing the same machine, the configuration above is most likely to be inadequate]

Installation Procedure :

1. Setup a working Linux environment with Apache and PostgreSQL/MySQL fully installed and started.
2. Download ck-erp-0.16.1.tar.gz from http://sourceforge.net/projects/ck-erp.
3. Untar the CK-ERP software tarball into egw's / xaraya’s (html/modules) / horde’s / tikiwiki’s / phpbb's target base directory (# tar -xzvf <full path name of ck-erp-0.16.1.tar.gz>) .
4. Setup egroupware 1.2RC4 / xaraya 1.0.1 / horde 3.0.7 / tikiwiki 1.9.2 / phpbb 2.0.18. For detail instruction, please refer to egroupware.org / xaraya.org / horde.org / tikiwiki.org / phpbb.com .
5. Test to ensure you have a working egroupware, xaraya, horde, tikiwiki or phpbb setup.
6. Login egroupware, xaraya, horde, tikiwiki or phpbb as admin level user. ***DO NOT LOGIN AS NON-ADMIN USER***. (For xaraya users, please refer to step 6A. For Horde users, please refer to step 6B below. For TikiWiki users, please refers to step 6C below. For phpBB users, please refer to step 6D below)
7. The CK-ERP modules will show up as icons with an “abacus” background.
8. You may have to click all 20 icons to find out which icon relates to which module.
9. Choose (CK-ERP's) Administration module (castle icon with “abacus” background).
      [The following error message (or something similar) may show up,
                Database error: Invalid SQL: SELECT checksum FROM ck_md5 WHERE script='/ck-admin/index.php'
                MySQL Error: 1146 (Table 'ckerp.ck_md5' doesn't exist)
               Session halted.
     But don't worry, this is due to the absence of the checksum table which will be created in a later step]
10. Read in detail the “Welcome to Administration” page.
11. Pick the [Admin/Setup] choice at the top header menu.
12. Choose action 1 - Install Test Environment
13. Press "Start Action" button.
14. Press "Start Action" button again.
15. Numerous descriptive messages will appear.
16. Press any one of the “Done” buttons.

At this point, CK-ERP is fully functional and all features are available for your testing.

A few points to note:

Step 6A (for Xaraya users only)
- Access Admin -> Themes -> Modify Config -> set Site Slogan to <a href="modules/ck-ledger/index.php"><font size=+2>Click here to access CK-ERP</font></a>
- Access Admin -> Base -> Modify Config -> Languages and Locales -> Activate [Per Page Mode (BOXED)] and Language/Locale combos that you wish to make available -> Update
- Access Admin -> Blocks -> Add Instance -> Set Module/Type to roles/languages, Name to (anything), Title to GUI Language, Block Group to left -> Create Instance

Step 6B (for Horde users only)
- Append the content of <horde base directory>/ck-api/horde/registry.php.ck-erp to the end of <horde base directory>/config/registry.php
- Access Administration -> Setup -> General -> Set [If you want to use a temporary directory ... enter it here] to the desired location (ps – the directory must be writable by the web process)

Step 6C (for TikiWiki users only)
- Access Admin -> Features -> Activate [Site Logo and Identity] and [User Files]
- Access Admin -> Site Identification -> Activate [custom code] and [publish]; Set (custom code) Content to [<a href=”ck-admin/index.php”>Click here to access CK-ERP</a>]
- Access Admin -> User files -> Activate [Use a directory to store userfiles] and set path to the desired location (ps – the directory must be writable by the web process).

Step 6D (for phpBB users only)
– Access (administration panel -> configuration function) via [Go to Administration Panel] link at the bottom of the page. Set [Site name] to [CK-ERP] and [Site description] to [<a href=”ck-admin/index.php”>Click here to access CK-ERP</a>]

1. Some of the menu choices are still not implemented.
2. The cheque printing facility assumes a normal stub-based manual handwritten cheque format (not the computer stationery type). The layout would have to be tuned for different bank's cheque format. The included facility is just for sample only.
3. Since the current version is a beta release, so DO NOT, DON'T, DO NOT AGAIN use this version against any production data or environment.
4. Some browsers may show distorted display. You may need to try different browsers and font (size) to get the best fit.

Please report any error to CK-ERP-en@googlegroups.com.

Data Backup
1.Click (CK-ERP's) Administration Module icon.
2.Choose Data Backup
3.A backup (flat) file, with its name appearing on screen, will be created.

Data Restore
1.Click (CK-ERP's) Administration Module icon.
2.Choose Data Restore.
3.A list of backup files kept at your user home directory will be displayed.
4.Choose the appropriate file.
5.Press “Start Database Restoration” button.

Upgrading
Automatic upgrading from previous versions is currently not supported.

Special Handling

Last Updated: 2005-12-14