// $Id$

===========================================
Authenticated User Page Caching (Authcache)
===========================================

The Authcache module offers page caching for both anonymous users and logged-in
authenticated users. This allows Drupal/PHP to spend only 1-2 milliseconds
serving pages and greatly reduces server resources.

Please visit:

  http://drupal.org/project/authcache

For information, updates, configuration help, and support.

============
Installation
============

1. Copy ajax_authcache.php to your Drupal root directory (the same directory as index.php).

2. Open your settings.php file and add:

$conf['cache_inc'] = './sites/all/modules/authcache/api/authcache.inc';
$conf['authcache'] = array(
  'default' => array(
    'engine' => 'db',                // apc, memcache, db, file, eacc or xcache
    'server' => array(),             // memcached (host:port, e..g, 'localhost:11211')
    'shared' => TRUE,                // memcached shared single process
    'prefix' => '',                  // cache key prefix (for multiple sites)
    'path' => 'files/filecache',     // file engine cache location
    'static' => FALSE,               // static array cache (advanced)
  ),
);

Modify accordingly as necessary by your caching process/engine.

3. Enabled the module and configure the Authcache settings
(Site Configuration -> Performance -> Authcache).

4. Modify your theme by tweaking user-customized elements (the final HTML
must be the same for each user role). Template files (e.g., page.tpl.php)
will have several new variables:
  $user_name to display the logged-in user name
  $user_link to display the name linked to their profile (both work for
    cached and non-cached pages).
  $is_page_authcache is set to TRUE in all template hooks if the page
    is to be cached.

========================
Authcache Example Module
========================

Please see ./modules/authcache_example for a demonstration on how to cache
blocks of user-customized content.

======
Author
======

Developed & maintained by Jonah Ellison.

Demo: http://authcache.httpremix.com

Email: jonah [at] httpremix.com
Drupal: http://drupal.org/user/217669 

================
Credits / Thanks
================

- "CacheRouter" module (Steve Rude) for the caching system/API
- "Boost" module (Arto Bendiken) for some minor code & techniques