You are here

README.txt in Authenticated User Page Caching (Authcache) 7.2

Authcache backend for drupal built-in cache system
==================================================

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

1. Enable authcache and authcache_bultin module.

2. Setup a Drupal cache handler module (optional, but strongly recommended for
   vastly improved performance)

   Download and enable a cache handler module, such as:

   - Memcache API: http://drupal.org/project/memcache
   - Filecache: http://drupal.org/project/filecache
   - Redis: http://drupal.org/project/redis
   - Mongodb: http://drupal.org/project/mongodb

3. Open your settings.php file and configure the cache backends.

   Here are some examples:

   BUILTIN DATABASE CACHE:

     $conf['cache_backends'][] = 'sites/all/modules/authcache/authcache.cache.inc';
     $conf['cache_backends'][] = 'sites/all/modules/authcache/modules/authcache_builtin/authcache_builtin.cache.inc';

     // Optional: Force database cache if you have other cache classes in
     // place for other cache bins:
     $conf['cache_class_cache_page'] = 'DrupalDatabaseCache';

   MEMCACHE MODULE:

     $conf['memcache_servers']  = array('localhost:11211' => 'default');

     $conf['cache_backends'][] = 'sites/all/modules/memcache/memcache.inc';
     $conf['cache_backends'][] = 'sites/all/modules/authcache/authcache.cache.inc';
     $conf['cache_backends'][] = 'sites/all/modules/authcache/modules/authcache_builtin/authcache_builtin.cache.inc';
     $conf['cache_class_cache_page'] = 'MemCacheDrupal';


   FILECACHE MODULE:

     $conf['cache_backends'][] = 'sites/all/modules/filecache/filecache.inc';
     $conf['cache_backends'][] = 'sites/all/modules/authcache/authcache.cache.inc';
     $conf['cache_backends'][] = 'sites/all/modules/authcache/modules/authcache_builtin/authcache_builtin.cache.inc';
     $conf['cache_class_cache_page'] = 'DrupalFileCache';

   If no cache handler is setup or defined, Authcache will fall back to Drupal
   core database cache tables and "Authcache Debug" will say "Cache Class:
   DrupalDatabaseCache".

   If you are experimenting with multiple caching systems (db, apc, memcache),
   make sure to clear the cache each time you switch to remove stale data.

4. (Optional) If a third-party cache-class is in place it is possible to avoid
   hitting the database completely. Add the following line to settings.php:

   $conf['authcache_builtin_cache_without_database'] = TRUE;

   When using the built-in DrupalDatabaseCache it is also possible to
   significantly speed up delivery of cached pages by simply bypassing the
   initialization of the variable subsystem:

   $conf['authcache_builtin_cache_without_variables'] = TRUE;

   In both cases it is necessary to hard-code all the settings affecting
   delivery of cached pages in settings.php. For example:

    // Deliver gzip compressed pages if possible
    $conf['page_compression'] = 1;

    // Allow browsers to store the page for up to 10 minutes
    $conf['page_cache_maximum_age'] = 600;

5. (Optional) Install and setup the Cache Expiration module allowing finer
   grained control over which pages are should be purged from cache whenever
   new content is submitted. In order to work properly, the Authcache Enum
   module also needs to be activated.
   Cache Expiration Module: https://drupal.org/project/expire

File

modules/authcache_builtin/README.txt
View source
  1. Authcache backend for drupal built-in cache system
  2. ==================================================
  3. Installation
  4. ------------
  5. 1. Enable authcache and authcache_bultin module.
  6. 2. Setup a Drupal cache handler module (optional, but strongly recommended for
  7. vastly improved performance)
  8. Download and enable a cache handler module, such as:
  9. - Memcache API: http://drupal.org/project/memcache
  10. - Filecache: http://drupal.org/project/filecache
  11. - Redis: http://drupal.org/project/redis
  12. - Mongodb: http://drupal.org/project/mongodb
  13. 3. Open your settings.php file and configure the cache backends.
  14. Here are some examples:
  15. BUILTIN DATABASE CACHE:
  16. $conf['cache_backends'][] = 'sites/all/modules/authcache/authcache.cache.inc';
  17. $conf['cache_backends'][] = 'sites/all/modules/authcache/modules/authcache_builtin/authcache_builtin.cache.inc';
  18. // Optional: Force database cache if you have other cache classes in
  19. // place for other cache bins:
  20. $conf['cache_class_cache_page'] = 'DrupalDatabaseCache';
  21. MEMCACHE MODULE:
  22. $conf['memcache_servers'] = array('localhost:11211' => 'default');
  23. $conf['cache_backends'][] = 'sites/all/modules/memcache/memcache.inc';
  24. $conf['cache_backends'][] = 'sites/all/modules/authcache/authcache.cache.inc';
  25. $conf['cache_backends'][] = 'sites/all/modules/authcache/modules/authcache_builtin/authcache_builtin.cache.inc';
  26. $conf['cache_class_cache_page'] = 'MemCacheDrupal';
  27. FILECACHE MODULE:
  28. $conf['cache_backends'][] = 'sites/all/modules/filecache/filecache.inc';
  29. $conf['cache_backends'][] = 'sites/all/modules/authcache/authcache.cache.inc';
  30. $conf['cache_backends'][] = 'sites/all/modules/authcache/modules/authcache_builtin/authcache_builtin.cache.inc';
  31. $conf['cache_class_cache_page'] = 'DrupalFileCache';
  32. If no cache handler is setup or defined, Authcache will fall back to Drupal
  33. core database cache tables and "Authcache Debug" will say "Cache Class:
  34. DrupalDatabaseCache".
  35. If you are experimenting with multiple caching systems (db, apc, memcache),
  36. make sure to clear the cache each time you switch to remove stale data.
  37. 4. (Optional) If a third-party cache-class is in place it is possible to avoid
  38. hitting the database completely. Add the following line to settings.php:
  39. $conf['authcache_builtin_cache_without_database'] = TRUE;
  40. When using the built-in DrupalDatabaseCache it is also possible to
  41. significantly speed up delivery of cached pages by simply bypassing the
  42. initialization of the variable subsystem:
  43. $conf['authcache_builtin_cache_without_variables'] = TRUE;
  44. In both cases it is necessary to hard-code all the settings affecting
  45. delivery of cached pages in settings.php. For example:
  46. // Deliver gzip compressed pages if possible
  47. $conf['page_compression'] = 1;
  48. // Allow browsers to store the page for up to 10 minutes
  49. $conf['page_cache_maximum_age'] = 600;
  50. 5. (Optional) Install and setup the Cache Expiration module allowing finer
  51. grained control over which pages are should be purged from cache whenever
  52. new content is submitted. In order to work properly, the Authcache Enum
  53. module also needs to be activated.
  54. Cache Expiration Module: https://drupal.org/project/expire