modules/cacherouter/README.txt

===============================================================================
CacheRouter
$Id: README.txt,v 1.1 2008/03/31 08:40:50 slantview Exp $
===============================================================================

-------------------------------------------------------------------------------
- About -
-------------------------------------------------------------------------------

CacheRouter is a caching system for Drupal allowing you to assign individual
cache tables to specific cache technology.  CacheRouter also utilizes the
page_fast_cache part of Drupal in order to reduce the amount of resources
needed for serving pages to anonymous users.


-------------------------------------------------------------------------------
- Installation -
-------------------------------------------------------------------------------

1.  Enable the module in admin/build/modules.
2.  Setup your settings.php


-------------------------------------------------------------------------------
- Configuration -
-------------------------------------------------------------------------------

CacheRouter has some pretty sane defaults, and it usually won't hurt to leave
it in the default mode.  With that said there are a few tweaks that are 
critical especially if you are running multiple sites.

Add the following lines to your settings.php:

$conf['cache_inc'] = './sites/all/modules/cacherouter/cacherouter.inc';
$conf['cacherouter'] = array(
  'default' => array(
    'engine' => 'db',
    'server' => array(),
    'shared' => TRUE,
    'prefix' => '',
  ),
);

default is for the default caching engine.  All valid cache tables or "bins"
can be added in addition, but you must have a default if you skip any bins.

For engine, the current available options are: apc, db, file, memcache and xcache.

server is only used in memcache and should be an array of host:port combinations.
(e.g. 'server' => array('localhost:11211', 'localhost:11212'))

shared is only used on memcache as well.  This allows memcache to be used with
a single process and still handle flushing correctly.

prefix is for unique site names usually when running multiple sites.


-------------------------------------------------------------------------------
- TODO -
-------------------------------------------------------------------------------

A few things I would like to have done.  

1.  Allow cache "chaining", for example, it would be nice to have default and a
"backup" cache so for any critical cache (not that there should be critical
caches), you could have memcache backed by db or file backed by db or memcache
backed by apc backed by db.  Not sure how I would like to implement this yet.

2.  I would love to see this tested on large production sites and work out the
bugs and get it into core.  I don't see why this caching shouldn't be part of
Drupal core.

3.  Any ideas for additional caching types.  

4.  I would love to get a really nice, clean web stats thing going with pretty
pictures and everything.


-------------------------------------------------------------------------------
- Maintainer -
-------------------------------------------------------------------------------

CacheRouter is maintained by Steve Rude.

Drupal.org: http://drupal.org/user/73183
Blog: http://slantview.com/
Twitter: http://twitter.com/slantview
Email: steve [at] slantview.com


-------------------------------------------------------------------------------
- Thanks -
-------------------------------------------------------------------------------

Just wanted to say thanks to whoever wrote the CakePHP caching stuff.  I 
didn't actually use any code from that, but I was somewhat inspired from
it.  So, thank you.  Go OSS.

1	===============================================================================
2	CacheRouter
3	$Id: README.txt,v 1.1 2008/03/31 08:40:50 slantview Exp $
4	===============================================================================
5
6	-------------------------------------------------------------------------------
7	- About -
8	-------------------------------------------------------------------------------
9
10	CacheRouter is a caching system for Drupal allowing you to assign individual
11	cache tables to specific cache technology. CacheRouter also utilizes the
12	page_fast_cache part of Drupal in order to reduce the amount of resources
13	needed for serving pages to anonymous users.
14
15
16	-------------------------------------------------------------------------------
17	- Installation -
18	-------------------------------------------------------------------------------
19
20	1. Enable the module in admin/build/modules.
21	2. Setup your settings.php
22
23
24	-------------------------------------------------------------------------------
25	- Configuration -
26	-------------------------------------------------------------------------------
27
28	CacheRouter has some pretty sane defaults, and it usually won't hurt to leave
29	it in the default mode. With that said there are a few tweaks that are
30	critical especially if you are running multiple sites.
31
32	Add the following lines to your settings.php:
33
34	$conf['cache_inc'] = './sites/all/modules/cacherouter/cacherouter.inc';
35	$conf['cacherouter'] = array(
36	'default' => array(
37	'engine' => 'db',
38	'server' => array(),
39	'shared' => TRUE,
40	'prefix' => '',
41	),
42	);
43
44	default is for the default caching engine. All valid cache tables or "bins"
45	can be added in addition, but you must have a default if you skip any bins.
46
47	For engine, the current available options are: apc, db, file, memcache and xcache.
48
49	server is only used in memcache and should be an array of host:port combinations.
50	(e.g. 'server' => array('localhost:11211', 'localhost:11212'))
51
52	shared is only used on memcache as well. This allows memcache to be used with
53	a single process and still handle flushing correctly.
54
55	prefix is for unique site names usually when running multiple sites.
56
57
58	-------------------------------------------------------------------------------
59	- TODO -
60	-------------------------------------------------------------------------------
61
62	A few things I would like to have done.
63
64	1. Allow cache "chaining", for example, it would be nice to have default and a
65	"backup" cache so for any critical cache (not that there should be critical
66	caches), you could have memcache backed by db or file backed by db or memcache
67	backed by apc backed by db. Not sure how I would like to implement this yet.
68
69	2. I would love to see this tested on large production sites and work out the
70	bugs and get it into core. I don't see why this caching shouldn't be part of
71	Drupal core.
72
73	3. Any ideas for additional caching types.
74
75	4. I would love to get a really nice, clean web stats thing going with pretty
76	pictures and everything.
77
78
79	-------------------------------------------------------------------------------
80	- Maintainer -
81	-------------------------------------------------------------------------------
82
83	CacheRouter is maintained by Steve Rude.
84
85	Drupal.org: http://drupal.org/user/73183
86	Blog: http://slantview.com/
87	Twitter: http://twitter.com/slantview
88	Email: steve [at] slantview.com
89
90
91	-------------------------------------------------------------------------------
92	- Thanks -
93	-------------------------------------------------------------------------------
94
95	Just wanted to say thanks to whoever wrote the CakePHP caching stuff. I
96	didn't actually use any code from that, but I was somewhat inspired from
97	it. So, thank you. Go OSS.
98