You are here

Home » API reference » Authenticated User Page Caching (Authcache) 7.2

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

Same filename in this branch
  1. 7.2 README.txt
  2. 7.2 modules/authcache_varnish/README.txt
  3. 7.2 modules/authcache_form/README.txt
  4. 7.2 modules/authcache_forum/README.txt
  5. 7.2 modules/authcache_builtin/README.txt
  6. 7.2 modules/authcache_p13n/README.txt
  7. 7.2 modules/authcache_votingapi/README.txt
Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
===========================================
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.

Please note that authcache requires at least Drupal 7.58.

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

1. Enable the authcache module along with one of the modules providing a cache
   backend. Currently those include:
   - authcache_builtin: Cache backend for the drupal core cache system. Also
     choose that one when using a third party cache like memcache.
   - authcache_varnish: Use varnish as the cache backend.

   All of those cache backends need to be configured properly. Please read and
   follow the instructions given in the respective README.txt files.

2. Enable all authcache submodules providing support for enabled core and
   contrib modules like "Authcache Poll" if you are using the "Poll" module or
   "Authcache Forum" if the "Forum" module is active. Note: Some functionality
   is only enabled when the Personalization API is enabled.

3. Goto Configuration > Development > Performance and disable page caching for
   anonymous users.

4. Goto Configuration > System > Authcache and specify the cacheable user roles.

5. Modify your theme by tweaking user-customized elements (the final HTML
   must be the same for each user role). Use hook_preprocess to replace user
   specific content with <span>-tags which you can address using JavaScript.
   See the numerous examples in the modules and example directories.

=================
CACHE FLUSH NOTES
=================

Page cache is cleared when cron.php is executed. This is normal Drupal core
behavior. Using the Elysia Cron module it is possible to suppress overzealous
cache clearing by running system_cron on a slower pace than other cron jobs.

See:
  -- Elysia Cron @ http://drupal.org/project/elysia_cron

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

Please review the examples in the modules and example directories for a
demonstration on how to alter the behavior of other modules such that their
output becomes cacheable for logged in users.

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

Developed & maintained by Jonah Ellison.

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

Initial D7 port by Simon Gardner
Email: slgard@gmail.com
Drupal: http://drupal.org/user/620692

Version 7.x-2.x by Lorenz Schori
Drupal: http://drupal.org/user/63999

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

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

File

README.txt
View source 
  1. 

  2. ===========================================

  3. Authenticated User Page Caching (Authcache)

  4. ===========================================

  5. 

  6. The Authcache module offers page caching for both anonymous users and logged-in

  7. authenticated users. This allows Drupal/PHP to spend only 1-2 milliseconds

  8. serving pages and greatly reduces server resources.

  9. 

  10. Please visit:

  11. 

  12.   http://drupal.org/project/authcache

  13. 

  14. For information, updates, configuration help, and support.

  15. 

  16. Please note that authcache requires at least Drupal 7.58.

  17. 

  18. ============

  19. Installation

  20. ============

  21. 

  22. 1. Enable the authcache module along with one of the modules providing a cache

  23.    backend. Currently those include:

  24.    - authcache_builtin: Cache backend for the drupal core cache system. Also

  25.      choose that one when using a third party cache like memcache.

  26.    - authcache_varnish: Use varnish as the cache backend.

  27. 

  28.    All of those cache backends need to be configured properly. Please read and

  29.    follow the instructions given in the respective README.txt files.

  30. 

  31. 2. Enable all authcache submodules providing support for enabled core and

  32.    contrib modules like "Authcache Poll" if you are using the "Poll" module or

  33.    "Authcache Forum" if the "Forum" module is active. Note: Some functionality

  34.    is only enabled when the Personalization API is enabled.

  35. 

  36. 3. Goto Configuration > Development > Performance and disable page caching for

  37.    anonymous users.

  38. 

  39. 4. Goto Configuration > System > Authcache and specify the cacheable user roles.

  40. 

  41. 5. Modify your theme by tweaking user-customized elements (the final HTML

  42.    must be the same for each user role). Use hook_preprocess to replace user

  43.    specific content with -tags which you can address using JavaScript.

  44.    See the numerous examples in the modules and example directories.

  45. 

  46. =================

  47. CACHE FLUSH NOTES

  48. =================

  49. 

  50. Page cache is cleared when cron.php is executed. This is normal Drupal core

  51. behavior. Using the Elysia Cron module it is possible to suppress overzealous

  52. cache clearing by running system_cron on a slower pace than other cron jobs.

  53. 

  54. See:

  55.   -- Elysia Cron @ http://drupal.org/project/elysia_cron

  56. 

  57. ========================

  58. Authcache Example Module

  59. ========================

  60. 

  61. Please review the examples in the modules and example directories for a

  62. demonstration on how to alter the behavior of other modules such that their

  63. output becomes cacheable for logged in users.

  64. 

  65. ======

  66. Author

  67. ======

  68. 

  69. Developed & maintained by Jonah Ellison.

  70. 

  71. Email: jonah [at] httpremix.com

  72. Drupal: http://drupal.org/user/217669

  73. 

  74. Initial D7 port by Simon Gardner

  75. Email: slgard@gmail.com

  76. Drupal: http://drupal.org/user/620692

  77. 

  78. Version 7.x-2.x by Lorenz Schori

  79. Drupal: http://drupal.org/user/63999

  80. 

  81. ================

  82. Credits / Thanks

  83. ================

  84. 

  85. - "Cache Router" module (Steve Rude) for the caching system/API

  86. - "Boost" module (Arto Bendiken) for some minor code & techniques