mfriesen edited this page Sep 14, 2010 · 5 revisions
Clone this wiki locally

Kaching Installation


  • PHP 5.2 or greater
  • Download CakePHP 1.3 or greater from []
  • Download Swift Mailer version 4.06 from []
  • Download the latest version of Kaching.

Install CakePHP

  • Follow instructions on [] to get CakePHP up and running.
  • Configure your Database in CakePHP

Install Swift Mailer

  • Create directory app/vendors/swift
  • From the Swift Mailer download copy all the files inside the lib into the newly created swift directory
  • To verify there should be a file app/vendors/swift/swift_required.php

Install Kaching

  • Extract the kaching-X.X.tar.gz into app/plugins directory. There should now be a directory app/plugins/kaching.
  • Replace the data in app/config/routes.php to
    include (APP . ‘plugins’ . DS . ‘kaching’ . DS . ‘config’ . DS . ‘routes.php’);
    Router::connect(‘/’, array(‘plugin’=>’kaching’, ‘controller’ => ‘carts’, ‘action’ => ‘category’, ‘1’));
  • load Kaching schema to database: app/plugins/kaching/doc/0.51/schema.sql
  • optional: load sample store sql file: app/plugins/kaching/doc/0.51/sample-store.sql


Kaching has a few settings that need to be setup in CakePHP’s core.php file.

You need to configure Kaching to know where the thumbnail and full product images are located, both URL and on the file system.

Add the following lines to your app/config/core.php file. Update as needed for your needs.

/** Where to find product thumbnail images */
Configure::write(‘kaching.product-thumbnail.dir’, ‘/home/…/app/webroot/products/thumbnails’);
Configure::write(‘kaching.product-thumbnail.url’, ‘http://localhost/products/thumbnails’);

/** Where to find product images */
Configure::write(‘kaching.product-image.url’, ‘http://localhost/products/images’);
Configure::write(‘kaching.product-image.dir’, ‘/home/…/app/webroot/products/images’);

By default the checkout and admin pages use SSL. If you want to disable this, IE: for a development machine add the following to app/config/core.php
Configure::write(“kaching.admin.ssl”, “false”);

Configure Admin User

The last step is to create your admin user. Open URL http://localhost/kaching/users/install. This will create the user that controls administration of your store.

Paypal Website Payments Pro

If you are going to be using Paypal Website Payments Pro to handle payments. In addition to setting your store’s Payment Process field, you need to add the following to your app/config/database.php.
var $paypal = array(
‘datasource’ => ‘paypal’,
‘environment’ => ‘sandbox’, // ‘sandbox’ or ‘live’
‘username’ => ‘???’,
‘password’ => ‘???’,
‘signature’ => ‘???’