INSTALLATION MANUAL




General Description :

CK-ERP is an open source accounting / ERP / CRM system written in php and operates above phpgroupware. It runs as a web application with Apache and phpgroupware 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 19 modules:
Administration, Contact Management, Customer Relationship Management, Customer Self Service, Vendor Relationship Management, Ledger (G/L), 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.

Each of these modules can be made visible or hidden from users/groups utilizing phpgroupware'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 Festures List (Docs).


Demo Sites:

http://ck-erp.sourceforge.net
http://www.ck-erp.org



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 +Phpgw or LAPP+Phpgw),

O/S

Webserver

DB Engine

Phpgw

Fedora Core 3
Apache2.0.52
PostgreSQL 7.4.6 / MySQL 3.23.58
0.9.16.005

Fedora Core 2

Apache2.0.49

PostgreSQL 7.4.2 / MySQL 3.23.58

0.9.16.003

Thiz Server 7.0

Apache1.3.27

MySQL 4.3.3

0.9.16.003

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


Hardware Requirement :
If everything (O/S, webserver, dbserver, phpgroupware, 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 phpgroupware 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.11.1.tar.gz from http://sourceforge.net/projects/ck-erp.
3. Untar the CK-ERP software tarball into phpgw's target base directory (# tar -xzvf <full path name of ck-erp-0.11.1.tar.gz>) .
4. Setup phpgroupware 0.9.16.xxx. For detail instruction, please refer to www.phpgroupware.org .
5. During phpgroupware installation, at Setup III menu, Click the "Manage Applications" button to check that the modules, ck-api, ck-admin, ck-contact, ck-crm, ck-css, ck-vrm, ck-ledger, ck-bank, ck-inv, ck-service, ck-ap, ck-ar, ck-po, ck-so, ck-quote, ck-pos-c, ck-pos-m, ck-hr, ck-sss, ck-payroll, are fully installed.
6. Test to ensure you have a working phpgroupware setup.
7. Login phpgroupware as [Admins] group user.
8. Invoke (phpgroupware's) admin (the castle icon) module.
9. Pick the “User groups” choice.
10. Click “Edit” on the Default group line. [This is just an example. You could create your own group and work from there too]
11. Click to activate the modules, ck-admin, ck-contact, ck-crm, ck-css, ck-vrm, ck-ledger, ck-bank, ck-inv, ck-service, ck-ap, ck-ar, ck-po, ck-so, ck-quote, ck-pos-c, ck-pos-m, ck-hr, ck-sss, ck-payroll.
12. Press "Submit Changes" button.
13. Logout and re-login phpgroupware as [Admins] group user.
14. The CK-ERP modules will show up as icons with an “abacus” background.
15. You may have to click all 19 icons to find out which icon relates to which module.
16. Choose (CK-ERP's) Administration module (castle icon with “abacus” background).
      [The following error message (or something similar) will 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]

17. Read in detail the “Welcome to Administration” page.
18. Pick the [Admin/Setup] choice at the top header menu.
19. Choose action 1 - Install Test Environment
20. Press "Start Action" button.
21. Press "Start Action" button again.
22. Numerous descriptive messages will appear.
23. 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:

1. Some of the menu choices are still not implemented.
2. Since ck-api is a programming library module, it is not set up to be accessible by users.
3. There is an inventory module native to phpgroupware, therefore, CK-ERP's inventory module is named ck-inv.
4. 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.
5. 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.
6. 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
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.
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

While the upgrading process has not been tested, the most complete and detail upgrading process is as follows,

1.Perform a data backup
2.Delete all CK-ERP folder within the phpgw base directory.
3.Untar new CK-ERP tarball within the phpgw base directory.
4.Follow installation procedure step 18 – 23 to delete old database tables and build new ones.
5.Perform a data restore.
6.When the upgrade does not involve change in data structure, the previous two steps may not be needed.
7.Whether data structure has been changed will be specified in the software release notes.








Special Handling







Last Updated: 2005-1-17