You are here

Home » API reference » Varnish 8

README.txt in Varnish 8

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Maintainers

INTRODUCTION
------------

This module provides integration between your Drupal site and Varnish cache, an
advanced and very fast reverse-proxy system. Basically, Varnish handles serving
static files and anonymous page-views for your site much faster and at higher
volumes than Apache, in the neighborhood of 3000 requests per second.

This module provides admin-socket integration which allows Drupal to dynamically
 invalidate cache entries, and also lets you query the Varnish admin interface
 for status, etc.



REQUIREMENTS
------------

No special requirements.



RECOMMENDED MODULES
-------------------

* Purge(https://www.drupal.org/project/purge)
The purge module facilitates cleaning external caching systems, reverse proxies
and CDNs as content actually changes.



INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/node/1897420 for further information.




CONFIGURATION
-------------

* Go to Home >> Administration >> Configuration >> Development >> Varnish.

Here you can select your Varnish version and configure options for:

-Varnish Control Terminal: Set this to the server IP or hostname that varnish
runs on (e.g. 127.0.0.1:6082). This must be configured for Drupal to talk to
Varnish. Separate multiple servers with spaces.

-Varnish Control Key: if you have established a secret key for control terminal
access, please put it here.

-Varnish connection timeout: If Varnish is running on a different server, you
may need to increase this value.

-Varnish Cache Clearing: What kind of cache clearing Varnish should utilize.
The Drupal default will clear all page caches on node updates and cache flush
events. None will allow pages to persist for their full max-age; use this if you
 want to write your own cache-clearing logic.

-Varnish ban type: Select the type of varnish ban you wish to use. Ban lurker
support requires you to add beresp.http.x-url and beresp.http.x-host entries to
the response in vcl_fetch.


MAINTAINERS
-----------

* Colin Campbell (deadbeef) - (https://www.drupal.org/u/deadbeef)

* Mikke Schiren (MiSc) - (https://www.drupal.org/u/misc)

* JeremyFrench - (https://www.drupal.org/u/jeremyfrench)

* Josh Koenig (joshk) - (https://www.drupal.org/u/joshk)

* Fabian Sorqvist (fabsor) - (https://www.drupal.org/u/fabsor)

This project is supported by

* Wunder Group (http://drupal.org/wunder-group)

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9.  * Maintainers

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. This module provides integration between your Drupal site and Varnish cache, an

  15. advanced and very fast reverse-proxy system. Basically, Varnish handles serving

  16. static files and anonymous page-views for your site much faster and at higher

  17. volumes than Apache, in the neighborhood of 3000 requests per second.

  18. 

  19. This module provides admin-socket integration which allows Drupal to dynamically

  20.  invalidate cache entries, and also lets you query the Varnish admin interface

  21.  for status, etc.

  22. 

  23. 

  24. 

  25. REQUIREMENTS

  26. ------------

  27. 

  28. No special requirements.

  29. 

  30. 

  31. 

  32. RECOMMENDED MODULES

  33. -------------------

  34. 

  35. * Purge(https://www.drupal.org/project/purge)

  36. The purge module facilitates cleaning external caching systems, reverse proxies

  37. and CDNs as content actually changes.

  38. 

  39. 

  40. 

  41. INSTALLATION

  42. ------------

  43. 

  44.  * Install as you would normally install a contributed Drupal module. See:

  45.    https://www.drupal.org/node/1897420 for further information.

  46. 

  47. 

  48. 

  49. 

  50. CONFIGURATION

  51. -------------

  52. 

  53. * Go to Home >> Administration >> Configuration >> Development >> Varnish.

  54. 

  55. Here you can select your Varnish version and configure options for:

  56. 

  57. -Varnish Control Terminal: Set this to the server IP or hostname that varnish

  58. runs on (e.g. 127.0.0.1:6082). This must be configured for Drupal to talk to

  59. Varnish. Separate multiple servers with spaces.

  60. 

  61. -Varnish Control Key: if you have established a secret key for control terminal

  62. access, please put it here.

  63. 

  64. -Varnish connection timeout: If Varnish is running on a different server, you

  65. may need to increase this value.

  66. 

  67. -Varnish Cache Clearing: What kind of cache clearing Varnish should utilize.

  68. The Drupal default will clear all page caches on node updates and cache flush

  69. events. None will allow pages to persist for their full max-age; use this if you

  70.  want to write your own cache-clearing logic.

  71. 

  72. -Varnish ban type: Select the type of varnish ban you wish to use. Ban lurker

  73. support requires you to add beresp.http.x-url and beresp.http.x-host entries to

  74. the response in vcl_fetch.

  75. 

  76. 

  77. MAINTAINERS

  78. -----------

  79. 

  80. * Colin Campbell (deadbeef) - (https://www.drupal.org/u/deadbeef)

  81. 

  82. * Mikke Schiren (MiSc) - (https://www.drupal.org/u/misc)

  83. 

  84. * JeremyFrench - (https://www.drupal.org/u/jeremyfrench)

  85. 

  86. * Josh Koenig (joshk) - (https://www.drupal.org/u/joshk)

  87. 

  88. * Fabian Sorqvist (fabsor) - (https://www.drupal.org/u/fabsor)

  89. 

  90. This project is supported by

  91. 

  92. * Wunder Group (http://drupal.org/wunder-group)