Varnish Configuration

The extension sends the following additional headers to configured Varnish servers.

Header:	Description:
X-Host	The domain name configured in the Varnish Controlled Domain record.
X-Url	The current url path

Default BAN Method for VCL

if(req.method == "BAN") {
    if(client.ip ~ allowban) {
        if (req.http.X-Host && req.http.X-Url) {
            ban("req.http.host == " + req.http.X-Host + " && req.url ~ " + req.http.X-Url);
            return (synth(200, "Banned on domain " + req.http.X-Host + " - URL: " + req.http.X-Url)) ;
        } else {
            return (synth(400, "BAD REQUEST"));
        }
    } else {
            return (synth(200, "NOT AUTHORIZED IP: " + req.http.X-Real-IP));
    }
}

Example Varnish VCL configuration template

It is highly recommended to read the Varnish documentation https://varnish-cache.org/docs/ in order to setup a configuration that suits your needs.

The extension ships with 2 example varnish configurations (vcl 3 and vcl 4) in the Resources/Private/Example folder.

Important

Both varnish configuration files are for demonstration purposes only. It is not recommended to use those configuration files as is in production.

Edge Side Includes

If the extension is configured properly and ESI support is enabled in your Varnish configuration, Varnish will output content elements makred as "Exclude from cache and use ESI-Tag" by fetching the content through a HTTP request.

Important

Note, that the usage of ESI includes may limit the performance gain Varnish delivers. It is therefore recommended to avoid uncached content as much as posible.