CK - Common Knowledge - to be shared and developed by all - ERP

INSTALLATION MANUAL
(applicable to CK-ERP 0.30.1 - for earlier releases, please refer to the file, /ck-admin/doc/Installation Manual.html , embedded within CK-ERP's distribution tarball)

General Description :

CK-ERP is an open source accounting / educational / MRP / ERP / CRM system written in php and operates above multiple middlewares. It runs as a web application with Apache and supported middleware serving as middle layer. Internal data is managed by PostgresSQL/MySQL/SQLite. Database server can either be local or remote. Client access is via web browsers, Firefox, Konqueror, Opera and the like.

Functionally, it is divided into 32 modules:
Contact Management, Customer Relationship Management, Customer Self Service, Vendor Relationship Management, Material Requirement Planning, Warehouse, Inventory, Service, Accounting Ledger, Bank Reconciliation, Accounts Payable, Accounts Receivable, Purchase Order, Sales Order, Quotation, POS for Cashier, POS for Manager, Human Resources, Staff Self Service, Payroll, Administration, Internationalization, Access Control, Data Import, Teacher, Counsellor, Student, Applicant, Family, Registrar, Edu Administration, Volunteer Management.

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).

Supported MiddleWares:

Information Website:
http://ck-erp.org
http://ck-erp.net
http://ck-erp.info

Latest Version:
The latest version is available from,
http://sourceforge.net/projects/ck-erp

Platforms :
CK-ERP has been tested against the following configurations (LAMP + Supported MiddleWare),

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

Hardware Requirement :
If everything (Operating System, webserver, dbserver, middleware, client desktop, browser) runs on a single machine, the
system will probably need at least,
CPU - Intel Celeron 1.8G, RAM - 512M, H/D - 40M (excluding the space needed to house application 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 :

0. Target middleware (anyone of these) - PSCafePOS 2.0.5 / OpenBiblio 0.6.1 / IRM 1.6-b3 / LegalCase 0.7.3 / ClearHealth 2.3 / OpenEMR 3.2 / eGroupWare 1.6.003-2 / Zencart 1.3.9c / Joomla 1.5.17 / Drupal 6.17 / Moodle 1.9.8+ / vTiger 5.1.0 / phpBB 3.0.7 / TikiWiki 4.2 / WordPress 2.9.2 / Xaraya 2.0 / ATutor 1.6.4 / b2evolution 3.3.3 / e107 0.7.21 / Horde-GroupWare 1.2.6 / Mambo 4.6.5 / XOOPS 2.4.4 / osCommerce 2.2rc2a / OpenX 2.8.5 / LandShop 0.9.2 / MyHandyRestaurant 0.8.5 / phpMySport 1.4 / AssetMan 2.5b / CopperMine 1.5.4 / Gallery 2.3 / Fusion Ticket beta6 / WebAuction 0.3.5 / OpenJournal 2.3.1 / OpenConference 2.3.2 / FladsClassified 091201 / WebCalendar 1.2.1 / phpScheduleIT 1.2.12 / OpenCATS 0.9.1a / php-residence 1.3.0 / Open-Realty 2.5.8 / Care2X 2.5rc1
1. Setup a working Linux environment with Apache and PostgreSQL/MySQL/SQLite fully installed and started.
2. Download ck-erp-0.30.1.tar.gz from http://sourceforge.net/projects/ck-erp.
3. Untar the CK-ERP software tarball into pscafepos' (management) / openbiblio's (admin) / irm's base / legalcase's base / clearhealth's (modules) / openemr's (accounting) / egw's base / zencart's (admin) / joomla's (modules) / drupal's (modules) / moodle's (admin) / vtiger's (modules) / phpbb's base / tikiwiki's base / wordpress' (wp-admin) / xaraya's (html/modules) / atutor's (mods) / b2evoultion's (blogs) / e107's (e107_plugins) / horde-groupware's base / mambo's (modules) / xoops' (htdocs/modules) / oscommerce's (catalog/admin) / openx's (plugins) / landshop's (admin) / myhandyrestaurant's (manage) / phpmysport's base / assetman's base / coppermine's (plugins) / gallery's (modules) / fusionticket's (admin) / webauction's base / openjournal's (plugins) / openconference's (plugins) / fladsclassified's (system/plugins) / webcalendar's base / phpscheduleit's base / opencats' (modules) / phpresidence's base / openrealty's (addons) / care2x' (modules) directory (# tar -xzvf <full path name of ck-erp-0.30.1.tar.gz>) .
4. Setup/Install the target middleware.
5. Test to ensure you have a working target middleware environment.
6. Login the target middleware as admin level user. ***DO NOT LOGIN AS NON-ADMIN USER***.
6a. Add CK-ERP entry link onto middleware's screen display,

7. The CK-ERP modules will show up as icons with an [abacus] background.
8. You may have to click all 32 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 Initial System
13. Press [Start Action] button.
14. Choose the appropriate Chart of Accounts to install
15. Press [Start Action] button again.
16. Numerous descriptive messages will appear.
17. Press any one of the [Done] buttons.
18. Adjust the Primary and Secondary Tax of customer, ____Cash and ___Myself, via [ck-crm] -> Customer Info -> Start Search -> Edit.
19. Adjust the Primary and Secondary Tax of vendor, ___Myself, via [ck-vrm] -> Vendor Info -> Start Search -> Edit.

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. 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: 2010-06-30